remotelog

Documentation

Overview

Package remotelog is a plugin that enables log messages being sent via UDP to a central ELK stack for debugging. It is disabled by default and when enabled, additionally, logger.disableEvents=false in config.json needs to be set. The destination can be set via logger.remotelog.serverAddress. All events according to logger.level in config.json are sent.

Index

• Constants
• Variables
• func Plugin() *node.Plugin
• func SendLogMsg(level logger.Level, name, msg string)
• type ParametersDefinition
• type RemoteLoggerConn
  • func RemoteLogger() *RemoteLoggerConn
  • func (r *RemoteLoggerConn) Send(msg interface{}) error

Constants

const (
	// PluginName is the name of the remote log plugin.
	PluginName = "RemoteLog"
)

Variables

var Parameters = &ParametersDefinition{}

Parameters contains the configuration used by the remotelog plugin.

Functions

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

func SendLogMsg

func SendLogMsg(level logger.Level, name, msg string)

SendLogMsg sends log message to the remote logger.

Types

type ParametersDefinition

type ParametersDefinition struct {
	// RemoteLog defines the parameters to reach the remote logging server.
	RemoteLog struct {
		// ServerAddress defines the server address that will receive the logs.
		ServerAddress string `default:"ressims.iota.cafe:5213" usage:"RemoteLog server address"`
	} `name:"remotelog"`
}

ParametersDefinition contains the definition of the parameters used by the remotelog plugin.

type RemoteLoggerConn

type RemoteLoggerConn struct {
	// contains filtered or unexported fields
}

RemoteLoggerConn is a wrapper for a connection to our RemoteLog server.

func RemoteLogger

func RemoteLogger() *RemoteLoggerConn

RemoteLogger represents a connection to our remote log server.

func (*RemoteLoggerConn) Send

func (r *RemoteLoggerConn) Send(msg interface{}) error

Send sends a message on the RemoteLoggers connection.