mirror of
https://github.com/prometheus-community/windows_exporter.git
synced 2026-02-23 21:26:36 +00:00
committed by
Calle Pettersson
parent
517cd3b04b
commit
8841091f9c
192
vendor/github.com/Microsoft/go-winio/pkg/etwlogrus/hook.go
generated
vendored
Normal file
192
vendor/github.com/Microsoft/go-winio/pkg/etwlogrus/hook.go
generated
vendored
Normal file
@@ -0,0 +1,192 @@
|
||||
package etwlogrus
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"reflect"
|
||||
|
||||
"github.com/Microsoft/go-winio/internal/etw"
|
||||
"github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
// Hook is a Logrus hook which logs received events to ETW.
|
||||
type Hook struct {
|
||||
provider *etw.Provider
|
||||
}
|
||||
|
||||
// NewHook registers a new ETW provider and returns a hook to log from it.
|
||||
func NewHook(providerName string) (*Hook, error) {
|
||||
hook := Hook{}
|
||||
|
||||
provider, err := etw.NewProvider(providerName, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
hook.provider = provider
|
||||
|
||||
return &hook, nil
|
||||
}
|
||||
|
||||
// Levels returns the set of levels that this hook wants to receive log entries
|
||||
// for.
|
||||
func (h *Hook) Levels() []logrus.Level {
|
||||
return []logrus.Level{
|
||||
logrus.TraceLevel,
|
||||
logrus.DebugLevel,
|
||||
logrus.InfoLevel,
|
||||
logrus.WarnLevel,
|
||||
logrus.ErrorLevel,
|
||||
logrus.FatalLevel,
|
||||
logrus.PanicLevel,
|
||||
}
|
||||
}
|
||||
|
||||
// Fire receives each Logrus entry as it is logged, and logs it to ETW.
|
||||
func (h *Hook) Fire(e *logrus.Entry) error {
|
||||
level := etw.Level(e.Level)
|
||||
if !h.provider.IsEnabledForLevel(level) {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Reserve extra space for the message field.
|
||||
fields := make([]etw.FieldOpt, 0, len(e.Data)+1)
|
||||
|
||||
fields = append(fields, etw.StringField("Message", e.Message))
|
||||
|
||||
for k, v := range e.Data {
|
||||
fields = append(fields, getFieldOpt(k, v))
|
||||
}
|
||||
|
||||
// We could try to map Logrus levels to ETW levels, but we would lose some
|
||||
// fidelity as there are fewer ETW levels. So instead we use the level
|
||||
// directly.
|
||||
return h.provider.WriteEvent(
|
||||
"LogrusEntry",
|
||||
etw.WithEventOpts(etw.WithLevel(level)),
|
||||
fields)
|
||||
}
|
||||
|
||||
// Currently, we support logging basic builtin types (int, string, etc), slices
|
||||
// of basic builtin types, error, types derived from the basic types (e.g. "type
|
||||
// foo int"), and structs (recursively logging their fields). We do not support
|
||||
// slices of derived types (e.g. "[]foo").
|
||||
//
|
||||
// For types that we don't support, the value is formatted via fmt.Sprint, and
|
||||
// we also log a message that the type is unsupported along with the formatted
|
||||
// type. The intent of this is to make it easier to see which types are not
|
||||
// supported in traces, so we can evaluate adding support for more types in the
|
||||
// future.
|
||||
func getFieldOpt(k string, v interface{}) etw.FieldOpt {
|
||||
switch v := v.(type) {
|
||||
case bool:
|
||||
return etw.BoolField(k, v)
|
||||
case []bool:
|
||||
return etw.BoolArray(k, v)
|
||||
case string:
|
||||
return etw.StringField(k, v)
|
||||
case []string:
|
||||
return etw.StringArray(k, v)
|
||||
case int:
|
||||
return etw.IntField(k, v)
|
||||
case []int:
|
||||
return etw.IntArray(k, v)
|
||||
case int8:
|
||||
return etw.Int8Field(k, v)
|
||||
case []int8:
|
||||
return etw.Int8Array(k, v)
|
||||
case int16:
|
||||
return etw.Int16Field(k, v)
|
||||
case []int16:
|
||||
return etw.Int16Array(k, v)
|
||||
case int32:
|
||||
return etw.Int32Field(k, v)
|
||||
case []int32:
|
||||
return etw.Int32Array(k, v)
|
||||
case int64:
|
||||
return etw.Int64Field(k, v)
|
||||
case []int64:
|
||||
return etw.Int64Array(k, v)
|
||||
case uint:
|
||||
return etw.UintField(k, v)
|
||||
case []uint:
|
||||
return etw.UintArray(k, v)
|
||||
case uint8:
|
||||
return etw.Uint8Field(k, v)
|
||||
case []uint8:
|
||||
return etw.Uint8Array(k, v)
|
||||
case uint16:
|
||||
return etw.Uint16Field(k, v)
|
||||
case []uint16:
|
||||
return etw.Uint16Array(k, v)
|
||||
case uint32:
|
||||
return etw.Uint32Field(k, v)
|
||||
case []uint32:
|
||||
return etw.Uint32Array(k, v)
|
||||
case uint64:
|
||||
return etw.Uint64Field(k, v)
|
||||
case []uint64:
|
||||
return etw.Uint64Array(k, v)
|
||||
case uintptr:
|
||||
return etw.UintptrField(k, v)
|
||||
case []uintptr:
|
||||
return etw.UintptrArray(k, v)
|
||||
case float32:
|
||||
return etw.Float32Field(k, v)
|
||||
case []float32:
|
||||
return etw.Float32Array(k, v)
|
||||
case float64:
|
||||
return etw.Float64Field(k, v)
|
||||
case []float64:
|
||||
return etw.Float64Array(k, v)
|
||||
case error:
|
||||
return etw.StringField(k, v.Error())
|
||||
default:
|
||||
switch rv := reflect.ValueOf(v); rv.Kind() {
|
||||
case reflect.Bool:
|
||||
return getFieldOpt(k, rv.Bool())
|
||||
case reflect.Int:
|
||||
return getFieldOpt(k, int(rv.Int()))
|
||||
case reflect.Int8:
|
||||
return getFieldOpt(k, int8(rv.Int()))
|
||||
case reflect.Int16:
|
||||
return getFieldOpt(k, int16(rv.Int()))
|
||||
case reflect.Int32:
|
||||
return getFieldOpt(k, int32(rv.Int()))
|
||||
case reflect.Int64:
|
||||
return getFieldOpt(k, int64(rv.Int()))
|
||||
case reflect.Uint:
|
||||
return getFieldOpt(k, uint(rv.Uint()))
|
||||
case reflect.Uint8:
|
||||
return getFieldOpt(k, uint8(rv.Uint()))
|
||||
case reflect.Uint16:
|
||||
return getFieldOpt(k, uint16(rv.Uint()))
|
||||
case reflect.Uint32:
|
||||
return getFieldOpt(k, uint32(rv.Uint()))
|
||||
case reflect.Uint64:
|
||||
return getFieldOpt(k, uint64(rv.Uint()))
|
||||
case reflect.Uintptr:
|
||||
return getFieldOpt(k, uintptr(rv.Uint()))
|
||||
case reflect.Float32:
|
||||
return getFieldOpt(k, float32(rv.Float()))
|
||||
case reflect.Float64:
|
||||
return getFieldOpt(k, float64(rv.Float()))
|
||||
case reflect.String:
|
||||
return getFieldOpt(k, rv.String())
|
||||
case reflect.Struct:
|
||||
fields := make([]etw.FieldOpt, 0, rv.NumField())
|
||||
for i := 0; i < rv.NumField(); i++ {
|
||||
field := rv.Field(i)
|
||||
if field.CanInterface() {
|
||||
fields = append(fields, getFieldOpt(k, field.Interface()))
|
||||
}
|
||||
}
|
||||
return etw.Struct(k, fields...)
|
||||
}
|
||||
}
|
||||
|
||||
return etw.StringField(k, fmt.Sprintf("(Unsupported: %T) %v", v, v))
|
||||
}
|
||||
|
||||
// Close cleans up the hook and closes the ETW provider.
|
||||
func (h *Hook) Close() error {
|
||||
return h.provider.Close()
|
||||
}
|
||||
126
vendor/github.com/Microsoft/go-winio/pkg/etwlogrus/hook_test.go
generated
vendored
Normal file
126
vendor/github.com/Microsoft/go-winio/pkg/etwlogrus/hook_test.go
generated
vendored
Normal file
@@ -0,0 +1,126 @@
|
||||
package etwlogrus
|
||||
|
||||
import (
|
||||
"github.com/Microsoft/go-winio/internal/etw"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func fireEvent(t *testing.T, p *etw.Provider, name string, value interface{}) {
|
||||
if err := p.WriteEvent(
|
||||
name,
|
||||
nil,
|
||||
etw.WithFields(getFieldOpt("Field", value))); err != nil {
|
||||
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
// The purpose of this test is to log lots of different field types, to test the
|
||||
// logic that converts them to ETW. Because we don't have a way to
|
||||
// programatically validate the ETW events, this test has two main purposes: (1)
|
||||
// validate nothing causes a panic while logging (2) allow manual validation that
|
||||
// the data is logged correctly (through a tool like WPA).
|
||||
func TestFieldLogging(t *testing.T) {
|
||||
// Sample WPRP to collect this provider:
|
||||
//
|
||||
// <?xml version="1.0"?>
|
||||
// <WindowsPerformanceRecorder Version="1">
|
||||
// <Profiles>
|
||||
// <EventCollector Id="Collector" Name="MyCollector">
|
||||
// <BufferSize Value="256"/>
|
||||
// <Buffers Value="100"/>
|
||||
// </EventCollector>
|
||||
// <EventProvider Id="HookTest" Name="5e50de03-107c-5a83-74c6-998c4491e7e9"/>
|
||||
// <Profile Id="Test.Verbose.File" Name="Test" Description="Test" LoggingMode="File" DetailLevel="Verbose">
|
||||
// <Collectors>
|
||||
// <EventCollectorId Value="Collector">
|
||||
// <EventProviders>
|
||||
// <EventProviderId Value="HookTest"/>
|
||||
// </EventProviders>
|
||||
// </EventCollectorId>
|
||||
// </Collectors>
|
||||
// </Profile>
|
||||
// </Profiles>
|
||||
// </WindowsPerformanceRecorder>
|
||||
//
|
||||
// Start collection:
|
||||
// wpr -start HookTest.wprp -filemode
|
||||
//
|
||||
// Stop collection:
|
||||
// wpr -stop HookTest.etl
|
||||
p, err := etw.NewProvider("HookTest", nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() {
|
||||
if err := p.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}()
|
||||
|
||||
fireEvent(t, p, "Bool", true)
|
||||
fireEvent(t, p, "BoolSlice", []bool{true, false, true})
|
||||
fireEvent(t, p, "EmptyBoolSlice", []bool{})
|
||||
fireEvent(t, p, "String", "teststring")
|
||||
fireEvent(t, p, "StringSlice", []string{"sstr1", "sstr2", "sstr3"})
|
||||
fireEvent(t, p, "EmptyStringSlice", []string{})
|
||||
fireEvent(t, p, "Int", int(1))
|
||||
fireEvent(t, p, "IntSlice", []int{2, 3, 4})
|
||||
fireEvent(t, p, "EmptyIntSlice", []int{})
|
||||
fireEvent(t, p, "Int8", int8(5))
|
||||
fireEvent(t, p, "Int8Slice", []int8{6, 7, 8})
|
||||
fireEvent(t, p, "EmptyInt8Slice", []int8{})
|
||||
fireEvent(t, p, "Int16", int16(9))
|
||||
fireEvent(t, p, "Int16Slice", []int16{10, 11, 12})
|
||||
fireEvent(t, p, "EmptyInt16Slice", []int16{})
|
||||
fireEvent(t, p, "Int32", int32(13))
|
||||
fireEvent(t, p, "Int32Slice", []int32{14, 15, 16})
|
||||
fireEvent(t, p, "EmptyInt32Slice", []int32{})
|
||||
fireEvent(t, p, "Int64", int64(17))
|
||||
fireEvent(t, p, "Int64Slice", []int64{18, 19, 20})
|
||||
fireEvent(t, p, "EmptyInt64Slice", []int64{})
|
||||
fireEvent(t, p, "Uint", uint(21))
|
||||
fireEvent(t, p, "UintSlice", []uint{22, 23, 24})
|
||||
fireEvent(t, p, "EmptyUintSlice", []uint{})
|
||||
fireEvent(t, p, "Uint8", uint8(25))
|
||||
fireEvent(t, p, "Uint8Slice", []uint8{26, 27, 28})
|
||||
fireEvent(t, p, "EmptyUint8Slice", []uint8{})
|
||||
fireEvent(t, p, "Uint16", uint16(29))
|
||||
fireEvent(t, p, "Uint16Slice", []uint16{30, 31, 32})
|
||||
fireEvent(t, p, "EmptyUint16Slice", []uint16{})
|
||||
fireEvent(t, p, "Uint32", uint32(33))
|
||||
fireEvent(t, p, "Uint32Slice", []uint32{34, 35, 36})
|
||||
fireEvent(t, p, "EmptyUint32Slice", []uint32{})
|
||||
fireEvent(t, p, "Uint64", uint64(37))
|
||||
fireEvent(t, p, "Uint64Slice", []uint64{38, 39, 40})
|
||||
fireEvent(t, p, "EmptyUint64Slice", []uint64{})
|
||||
fireEvent(t, p, "Uintptr", uintptr(41))
|
||||
fireEvent(t, p, "UintptrSlice", []uintptr{42, 43, 44})
|
||||
fireEvent(t, p, "EmptyUintptrSlice", []uintptr{})
|
||||
fireEvent(t, p, "Float32", float32(45.46))
|
||||
fireEvent(t, p, "Float32Slice", []float32{47.48, 49.50, 51.52})
|
||||
fireEvent(t, p, "EmptyFloat32Slice", []float32{})
|
||||
fireEvent(t, p, "Float64", float64(53.54))
|
||||
fireEvent(t, p, "Float64Slice", []float64{55.56, 57.58, 59.60})
|
||||
fireEvent(t, p, "EmptyFloat64Slice", []float64{})
|
||||
|
||||
type struct1 struct {
|
||||
A float32
|
||||
priv int
|
||||
B []uint
|
||||
}
|
||||
type struct2 struct {
|
||||
A int
|
||||
B int
|
||||
}
|
||||
type struct3 struct {
|
||||
struct2
|
||||
A int
|
||||
B string
|
||||
priv string
|
||||
C struct1
|
||||
D uint16
|
||||
}
|
||||
// Unexported fields, and fields in embedded structs, should not log.
|
||||
fireEvent(t, p, "Struct", struct3{struct2{-1, -2}, 1, "2s", "-3s", struct1{3.4, -4, []uint{5, 6, 7}}, 8})
|
||||
}
|
||||
Reference in New Issue
Block a user