eventlog

Documentation

Overview

Package eventlog implements access to Windows event log.

Index

• Constants
• func Install(provider, src, msgFile string, useExpandKey bool, eventsSupported uint32) (bool, error)
• func InstallAsEventCreate(provider, src string, eventsSupported uint32) (bool, error)
• func RemoveProvider(provider string) error
• func RemoveSource(provider, src string) error
• type Log
  • func Open(source string) (*Log, error)
  • func OpenRemote(host, source string) (*Log, error)
  • func (l *Log) AuditFailure(eid uint32, msg string) error
  • func (l *Log) AuditSuccess(eid uint32, msg string) error
  • func (l *Log) Close() error
  • func (l *Log) Error(eid uint32, msg string) error
  • func (l *Log) Info(eid uint32, msg string) error
  • func (l *Log) Report(etype uint16, eid uint32, msgs []string) error
  • func (l *Log) Success(eid uint32, msg string) error
  • func (l *Log) Warning(eid uint32, msg string) error

Constants

const (
	// Log levels.
	Success      = windows.EVENTLOG_SUCCESS
	Info         = windows.EVENTLOG_INFORMATION_TYPE
	Warning      = windows.EVENTLOG_WARNING_TYPE
	Error        = windows.EVENTLOG_ERROR_TYPE
	AuditSuccess = windows.EVENTLOG_AUDIT_SUCCESS
	AuditFailure = windows.EVENTLOG_AUDIT_FAILURE
)

const Application = "Application"

Application event log provider.

Functions

func Install

func Install(provider, src, msgFile string, useExpandKey bool, eventsSupported uint32) (bool, error)

Install modifies PC registry to allow logging with an event source src. It adds all required keys and values to the event log registry key. Install uses msgFile as the event message file. If useExpandKey is true, the event message file is installed as REG_EXPAND_SZ value, otherwise as REG_SZ. Use bitwise of log.Error, log.Warning and log.Info to specify events supported by the new event source.

func InstallAsEventCreate

func InstallAsEventCreate(provider, src string, eventsSupported uint32) (bool, error)

InstallAsEventCreate is the same as Install, but uses %SystemRoot%\System32\EventCreate.exe as the event message file.

func RemoveProvider

func RemoveProvider(provider string) error

Remove deletes all registry elements installed for an event logging provider. Only use this method if you have installed a custom provider.

func RemoveSource

func RemoveSource(provider, src string) error

Remove deletes all registry elements installed for an event logging source.

Types

type Log

type Log struct {
	Handle windows.Handle
}

Log provides access to the system log.

func Open

func Open(source string) (*Log, error)

Open retrieves a handle to the specified event log.

func OpenRemote

func OpenRemote(host, source string) (*Log, error)

OpenRemote does the same as Open, but on different computer host.

func (*Log) AuditFailure

func (l *Log) AuditFailure(eid uint32, msg string) error

AuditFailure writes an audit event msg with event id eid to the end of event log l. When EventCreate.exe is used, eid must be between 1 and 1000.

func (*Log) AuditSuccess

func (l *Log) AuditSuccess(eid uint32, msg string) error

AuditSuccess writes an audit event msg with event id eid to the end of event log l. When EventCreate.exe is used, eid must be between 1 and 1000.

func (*Log) Close

func (l *Log) Close() error

Close closes event log l.

func (*Log) Error

func (l *Log) Error(eid uint32, msg string) error

Error writes an error event msg with event id eid to the end of event log l. When EventCreate.exe is used, eid must be between 1 and 1000.

func (*Log) Info

func (l *Log) Info(eid uint32, msg string) error

Info writes an information event msg with event id eid to the end of event log l. When EventCreate.exe is used, eid must be between 1 and 1000.

func (*Log) Report

func (l *Log) Report(etype uint16, eid uint32, msgs []string) error

Report write an event message with event type etype and event ID eid to the end of event log l. etype should be one of Info, Success, Warning, Error, AuditSuccess, or AuditFailure. When EventCreate.exe is used, eid must be between 1 and 1000.

func (*Log) Success

func (l *Log) Success(eid uint32, msg string) error

Success writes a success event msg with event id eid to the end of event log l. When EventCreate.exe is used, eid must be between 1 and 1000.

func (*Log) Warning

func (l *Log) Warning(eid uint32, msg string) error

Warning writes an warning event msg with event id eid to the end of event log l. When EventCreate.exe is used, eid must be between 1 and 1000.