eventloghook

README

Windows EventLog hooks for Logrus

Usage

import (
  "log/syslog"
  "github.com/sirupsen/logrus"
  "github.com/freman/eventloghook"
  "golang.org/x/sys/windows/svc/eventlog"
)

func main() {
  log       := logrus.New()
  elog, err = eventlog.Open("Service Name")
  if err != nil {
    panic(err)
  }
  defer elog.Close()
  log.Hooks.Add(eventloghook.NewHook(elog))
}

If you want to output to the windows console/terminal - tho why you'd want to do that vs use logrus built in method I have no idea :D

import (
  "log/syslog"
  "github.com/sirupsen/logrus"
  "github.com/freman/eventloghook"
  "golang.org/x/sys/windows/svc/debug"
)

func main() {
  log       := logrus.New()
  elog = debug.New("Service Name")
  defer elog.Close()
  log.Hooks.Add(eventloghook.NewHook(elog))
}

Breaking Changes

• 2025-06-04 - Added support for Trace log level, better late than never. Only a concern if you're relying on the event ID for filtering or reporting. Changes:
  • logrus.InfoLevel used to be EID 2 is now EID 3
  • logrus.DebugLevel used to be EID 1 is now EID 2
  • logrus.TraceLevel never existed but is now EID 1

Documentation

Index

• type EventLogHook
  • func NewHook(Logger Logger) *EventLogHook
  • func (hook *EventLogHook) Fire(entry *logrus.Entry) error
  • func (hook *EventLogHook) Levels() []logrus.Level
• type Logger

Types

type EventLogHook

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

EventLogHook to send logs via windows log.

func NewHook

func NewHook(Logger Logger) *EventLogHook

NewHook creates and returns a new EventLogHook wrapped around anything that implements the Logger interface for example: * golang.org/x/sys/windows/svc/eventlog.Log * golang.org/x/sys/windows/svc/debug.Log

func (*EventLogHook) Fire

func (hook *EventLogHook) Fire(entry *logrus.Entry) error

func (*EventLogHook) Levels

func (hook *EventLogHook) Levels() []logrus.Level

type Logger

type Logger interface {
	Error(eid uint32, msg string) error
	Info(eid uint32, msg string) error
	Warning(eid uint32, msg string) error
}

Logger interface to cover the two common windows loggers IE: * golang.org/x/sys/windows/svc/eventlog.Log * golang.org/x/sys/windows/svc/debug.Log