logmanager

README

Log Manager

Log manager plugin allows to view and modify log levels of loggers using REST API.

API

• List all registered loggers:

  curl -X GET http://<host>:<port>/log/list

• Set log level for a registered logger: curl -X PUT http://<host>:<port>/log/<logger-name>/<log-level>

  <log-level> is one of debug,info,warning,error,fatal,panic

<host> and <port> are determined by configuration of rest.Plugin.

Config file

• Logger config file is composed of two parts: the default level applied for all plugins, and a map where every logger can have its own log level defined. See config file example to learn how to define it.

  Note: initial log level can be set using environmental variable INITIAL_LOGLVL. The variable replaces default-level from configuration file. However, loggers (partial definition) replace default value set by environmental variable for specific loggers defined.

Documentation

Overview

Package logmanager implements the log manager that allows users to set log levels at run-time via a REST API.

Index

• type Conf
  • func NewConf() *Conf
• type ConfLogger
• type Deps
• type LoggerData
• type Plugin
  • func (lm *Plugin) AfterInit() error
  • func (lm *Plugin) Close() error
  • func (lm *Plugin) Init() error

Types

type Conf

type Conf struct {
	DefaultLevel string       `json:"default-level"`
	Loggers      []ConfLogger `json:"loggers"`
}

Conf is a binding that supports to define default log levels for multiple loggers

func NewConf

func NewConf() *Conf

NewConf creates default configuration with InfoLevel & empty loggers. Suitable also for usage in flavor to programmatically specify default behavior.

type ConfLogger

type ConfLogger struct {
	Name  string
	Level string //debug, info, warning, error, fatal, panic
}

ConfLogger is configuration of a particular logger. Currently we support only logger level.

type Deps

type Deps struct {
	Log                 logging.PluginLogger //inject
	PluginName          core.PluginName      //inject
	config.PluginConfig                      //inject

	LogRegistry logging.Registry  // inject
	HTTP        rest.HTTPHandlers // inject
}

Deps groups dependencies injected into the plugin so that they are logically separated from other plugin fields.

type LoggerData

type LoggerData struct {
	Logger string `json:"logger"`
	Level  string `json:"level"`
}

LoggerData encapsulates parameters of a logger represented as strings.

type Plugin

type Plugin struct {
	Deps
	*Conf
}

Plugin allows to manage log levels of the loggers using HTTP.

func (*Plugin) AfterInit

func (lm *Plugin) AfterInit() error

AfterInit is called at plugin initialization. It register the following handlers:

• List all registered loggers: > curl -X GET http://localhost:<port>/log/list
• Set log level for a registered logger: > curl -X PUT http://localhost:<port>/log/<logger-name>/<log-level>

func (*Plugin) Close

func (lm *Plugin) Close() error

Close is called at plugin cleanup phase.

func (*Plugin) Init

func (lm *Plugin) Init() error

Init does nothing