k3s/vendor/k8s.io/component-base/logs/registry.go

/*
Copyright 2020 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package logs

import (
	"fmt"

	"github.com/go-logr/logr"
	json "k8s.io/component-base/logs/json"
)

const (
	jsonLogFormat = "json"
)

var logRegistry = NewLogFormatRegistry()

// LogFormatRegistry store klog format registry
type LogFormatRegistry struct {
	registry map[string]logr.Logger
	frozen   bool
}

// NewLogFormatRegistry return new init LogFormatRegistry struct
func NewLogFormatRegistry() *LogFormatRegistry {
	return &LogFormatRegistry{
		registry: make(map[string]logr.Logger),
		frozen:   false,
	}
}

// Register new log format registry to global logRegistry
func (lfr *LogFormatRegistry) Register(name string, logger logr.Logger) error {
	if lfr.frozen {
		return fmt.Errorf("log format is frozen, unable to register log format")
	}
	if _, ok := lfr.registry[name]; ok {
		return fmt.Errorf("log format: %s already exists", name)
	}
	lfr.registry[name] = logger
	return nil
}

// Get specified log format logger
func (lfr *LogFormatRegistry) Get(name string) (logr.Logger, error) {
	re, ok := lfr.registry[name]
	if !ok {
		return nil, fmt.Errorf("log format: %s does not exists", name)
	}
	return re, nil
}

// Set specified log format logger
func (lfr *LogFormatRegistry) Set(name string, logger logr.Logger) error {
	if lfr.frozen {
		return fmt.Errorf("log format is frozen, unable to set log format")
	}

	lfr.registry[name] = logger
	return nil
}

// Delete specified log format logger
func (lfr *LogFormatRegistry) Delete(name string) error {
	if lfr.frozen {
		return fmt.Errorf("log format is frozen, unable to delete log format")
	}

	delete(lfr.registry, name)
	return nil
}

// List names of registered log formats
func (lfr *LogFormatRegistry) List() []string {
	formats := make([]string, 0, len(lfr.registry))
	for f := range lfr.registry {
		formats = append(formats, f)
	}
	return formats
}

// Freeze freezes the log format registry
func (lfr *LogFormatRegistry) Freeze() {
	lfr.frozen = true
}
func init() {
	// Text format is default klog format
	logRegistry.Register(defaultLogFormat, nil)
	logRegistry.Register(jsonLogFormat, json.JSONLogger)
}