feat: windows_exporter uses own event log source to correctly format messages. (#1873)

Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>
Signed-off-by: Jan-Otto Kröpke <github@jkroepke.de>
This commit is contained in:
Jan-Otto Kröpke
2025-02-10 18:57:31 +01:00
committed by GitHub
parent f07aceb0dd
commit 285c4cc5ea
5 changed files with 40 additions and 40 deletions

View File

@@ -17,53 +17,41 @@
package eventlog
import (
"bytes"
"fmt"
"io"
"regexp"
"strings"
"golang.org/x/sys/windows"
)
const (
// NeLogOemCode is a generic error log entry for OEMs to use to
// elog errors from OEM value added services.
// See: https://github.com/microsoft/win32metadata/blob/2f3c5282ce1024a712aeccd90d3aa50bf7a49e27/generation/WinSDK/RecompiledIdlHeaders/um/LMErrlog.h#L824-L845
NeLogOemCode = uint32(3299)
"golang.org/x/sys/windows/svc/eventlog"
)
// Interface guard.
var _ io.Writer = (*Writer)(nil)
//nolint:gochecknoglobals
var EmptyStringUTF16 uint16
var reStripTimeAndLevel = regexp.MustCompile(`^time=\S+ level=\S+ `)
type Writer struct {
handle windows.Handle
handle *eventlog.Log
}
// NewEventLogWriter returns a new Writer which writes to Windows EventLog.
func NewEventLogWriter(handle windows.Handle) *Writer {
// NewEventLogWriter returns a new Writer, which writes to Windows EventLog.
func NewEventLogWriter(handle *eventlog.Log) *Writer {
return &Writer{handle: handle}
}
func (w *Writer) Write(p []byte) (int, error) {
var eType uint16
var err error
msg := strings.TrimSpace(string(p))
eventLogMsg := reStripTimeAndLevel.ReplaceAllString(msg, "")
switch {
case bytes.Contains(p, []byte(" level=error")) || bytes.Contains(p, []byte(`"level":"error"`)):
eType = windows.EVENTLOG_ERROR_TYPE
case bytes.Contains(p, []byte(" level=warn")) || bytes.Contains(p, []byte(`"level":"warn"`)):
eType = windows.EVENTLOG_WARNING_TYPE
case strings.Contains(msg, " level=ERROR") || strings.Contains(msg, `"level":"error"`):
err = w.handle.Error(102, eventLogMsg)
case strings.Contains(msg, " level=WARN") || strings.Contains(msg, `"level":"warn"`):
err = w.handle.Warning(101, eventLogMsg)
default:
eType = windows.EVENTLOG_INFORMATION_TYPE
err = w.handle.Info(100, eventLogMsg)
}
msg, err := windows.UTF16PtrFromString(string(p))
if err != nil {
return 0, fmt.Errorf("error convert string to UTF-16: %w", err)
}
ss := []*uint16{msg, &EmptyStringUTF16, &EmptyStringUTF16, &EmptyStringUTF16, &EmptyStringUTF16, &EmptyStringUTF16, &EmptyStringUTF16, &EmptyStringUTF16, &EmptyStringUTF16}
return len(p), windows.ReportEvent(w.handle, eType, 0, NeLogOemCode, 0, 9, 0, &ss[0], nil)
return len(p), err
}

View File

@@ -24,7 +24,7 @@ import (
"github.com/prometheus-community/windows_exporter/internal/log/eventlog"
"github.com/prometheus/common/promslog"
"golang.org/x/sys/windows"
wineventlog "golang.org/x/sys/windows/svc/eventlog"
)
// AllowedFile is a settable identifier for the output file that the logger can have.
@@ -51,12 +51,12 @@ func (f *AllowedFile) Set(s string) error {
case "stderr":
f.w = os.Stderr
case "eventlog":
handle, err := windows.RegisterEventSource(nil, windows.StringToUTF16Ptr("windows_exporter"))
eventLog, err := wineventlog.Open("windows_exporter")
if err != nil {
return fmt.Errorf("failed to open event log: %w", err)
}
f.w = eventlog.NewEventLogWriter(handle)
f.w = eventlog.NewEventLogWriter(eventLog)
default:
file, err := os.OpenFile(s, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0o200)
if err != nil {

View File

@@ -172,6 +172,12 @@ func NewCollectorWithReflection(resultType CounterType, object string, instances
continue
}
if bufLen == 0 {
errs = append(errs, errors.New("GetCounterInfo: buffer length is zero"))
continue
}
buf := make([]byte, bufLen)
if ret := GetCounterInfo(counterHandle, 0, &bufLen, &buf[0]); ret != ErrorSuccess {
errs = append(errs, fmt.Errorf("GetCounterInfo: %w", NewPdhError(ret)))