gomolgelf

README

gomol-gelf

gomol-gelf is a logger for gomol to support logging to GELF endpoints.

Installation

The recommended way to install is via http://gopkg.in

go get gopkg.in/aphistic/gomol-gelf.v0
...
import "gopkg.in/aphistic/gomol-gelf.v0"

gomol-gelf can also be installed the standard way as well

go get github.com/aphistic/gomol-gelf
...
import "github.com/aphistic/gomol-gelf"

Examples

For brevity a lot of error checking has been omitted, be sure you do your checks!

This is a super basic example of adding a GELF logger to gomol and then logging a few messages:

package main

import (
	"github.com/aphistic/gomol"
	gg "github.com/aphistic/gomol-gelf"
)

func main() {
	// Add an io.Writer logger
	gelfCfg := gg.NewGelfLoggerConfig()
	gelfLogger, _ := gg.NewGelfLogger(gelfCfg)
	gomol.AddLogger(gelfLogger)

	// Set some global attrs that will be added to all
	// messages automatically
	gomol.SetAttr("facility", "gomol.example")
	gomol.SetAttr("another_attr", 1234)

	// Initialize the loggers
	gomol.InitLoggers()
	defer gomol.ShutdownLoggers()

	// Log some debug messages with message-level attrs
	// that will be sent only with that message
	for idx := 1; idx <= 10; idx++ {
		gomol.Dbgm(
			gomol.NewAttrs().
				SetAttr("msg_attr1", 4321),
			"Test message %v", idx)
	}
}

Documentation

Overview

Example

Code for the README example to make sure it still builds!

// Add an io.Writer logger
gelfCfg := NewGelfLoggerConfig()
gelfLogger, _ := NewGelfLogger(gelfCfg)
gomol.AddLogger(gelfLogger)

// Set some global attrs that will be added to all
// messages automatically
gomol.SetAttr("facility", "gomol.example")
gomol.SetAttr("another_attr", 1234)

// Initialize the loggers
gomol.InitLoggers()
defer gomol.ShutdownLoggers()

// Log some debug messages with message-level attrs
// that will be sent only with that message
for idx := 1; idx <= 10; idx++ {
	gomol.Dbgm(
		gomol.NewAttrs().
			SetAttr("msg_attr1", 4321),
		"Test message %v", idx)
}

Index

• type GelfLogger
  • func NewGelfLogger(config *GelfLoggerConfig) (*GelfLogger, error)
  • func (l *GelfLogger) InitLogger() error
  • func (l *GelfLogger) IsInitialized() bool
  • func (l *GelfLogger) Logm(timestamp time.Time, level gomol.LogLevel, m map[string]interface{}, ...) error
  • func (l *GelfLogger) SetBase(base *gomol.Base)
  • func (l *GelfLogger) ShutdownLogger() error
• type GelfLoggerConfig
  • func NewGelfLoggerConfig() *GelfLoggerConfig

Examples

• Package

Types

type GelfLogger

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

func NewGelfLogger

func NewGelfLogger(config *GelfLoggerConfig) (*GelfLogger, error)

func (*GelfLogger) InitLogger

func (l *GelfLogger) InitLogger() error

func (*GelfLogger) IsInitialized

func (l *GelfLogger) IsInitialized() bool

func (*GelfLogger) Logm

func (l *GelfLogger) Logm(timestamp time.Time, level gomol.LogLevel, m map[string]interface{}, msg string) error

func (*GelfLogger) SetBase

func (l *GelfLogger) SetBase(base *gomol.Base)

func (*GelfLogger) ShutdownLogger

func (l *GelfLogger) ShutdownLogger() error

type GelfLoggerConfig

type GelfLoggerConfig struct {
	Hostname string
	Port     int
}

func NewGelfLoggerConfig

func NewGelfLoggerConfig() *GelfLoggerConfig