map telemetry metadata fields and compose logger

Signed-off-by: Evan Baker <[email protected]>

Author: rbtr

aitelemetry/telemetrywrapper.go

@@ -3,6 +3,7 @@ package aitelemetry
 import (
 	"fmt"
 	"os"
+	"path/filepath"
 	"runtime"
 	"time"
 
@@ -36,6 +37,8 @@ const (
 	defaultRefreshTimeoutInSecs      = 10
 )
 
+var MetadataFile = filepath.Join(os.TempDir(), "azuremetadata.json")
+
 type Level = contracts.SeverityLevel
 
 const (
@@ -98,7 +101,7 @@ func getMetadata(th *telemetryHandle) {
 
 	// check if metadata in memory otherwise initiate wireserver request
 	for {
-		metadata, err = common.GetHostMetadata(metadataFile)
+		metadata, err = common.GetHostMetadata(MetadataFile)
 		if err == nil || th.disableMetadataRefreshThread {
 			break
 		}
@@ -117,14 +120,14 @@ func getMetadata(th *telemetryHandle) {
 	th.metadata = metadata
 	th.rwmutex.Unlock()
 
-	lockclient, err := processlock.NewFileLock(metadataFile + store.LockExtension)
+	lockclient, err := processlock.NewFileLock(MetadataFile + store.LockExtension)
 	if err != nil {
 		log.Printf("Error initializing file lock:%v", err)
 		return
 	}
 
 	// Save metadata retrieved from wireserver to a file
-	kvs, err := store.NewJsonFileStore(metadataFile, lockclient, nil)
+	kvs, err := store.NewJsonFileStore(MetadataFile, lockclient, nil)
 	if err != nil {
 		debugLog("[AppInsights] Error initializing kvs store: %v", err)
 		return
@@ -134,7 +137,7 @@ func getMetadata(th *telemetryHandle) {
 		log.Errorf("getMetadata: Not able to acquire lock:%v", err)
 		return
 	}
-	metadataErr := common.SaveHostMetadata(th.metadata, metadataFile)
+	metadataErr := common.SaveHostMetadata(th.metadata, MetadataFile)
 	err = kvs.Unlock()
 	if err != nil {
 		log.Errorf("getMetadata: Not able to release lock:%v", err)

aitelemetry/telemetrywrapper_linux.go

@@ -42,8 +42,8 @@ func (c *Config) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
-// Normalize checks the Config for missing or illegal values and sets them
-// to defaults if appropriate.
+// Normalize checks the Config for missing/default values and sets them
+// if appropriate.
 func (c *Config) Normalize() {
 	if c.File != nil {
 		if c.File.Filepath == "" {

aitelemetry/telemetrywrapper_windows.go

@@ -62,6 +62,6 @@ func ApplicationInsightsCore(cfg *AppInsightsConfig) (zapcore.Core, func(), erro
 	core := zapai.NewCore(cfg.level, sink)
 	core = core.WithFieldMappers(zapai.DefaultMappers)
 	// add normalized fields for the built-in AI Tags
-	// TODO(rbtr): move to the caller
+
 	return core.With(cfg.Fields), aiclose, nil
 }

cns/logger/v2/config.go

@@ -1,15 +1,41 @@
 package logger
 
 import (
+	"encoding/json"
+
 	"github.com/Azure/azure-container-networking/zapetw"
+	"github.com/pkg/errors"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 )
 
 type ETWConfig struct {
-	EventName    string
-	Level        zapcore.Level
-	ProviderName string
+	EventName    string          `json:"eventname"`
+	Level        string          `json:"level"`
+	level        zapcore.Level   `json:"-"`
+	ProviderName string          `json:"providername"`
+	Fields       []zapcore.Field `json:"fields"`
+}
+
+// UnmarshalJSON implements json.Unmarshaler for the Config.
+// It only differs from the default by parsing the
+// Level string into a zapcore.Level and setting the level field.
+func (cfg *ETWConfig) UnmarshalJSON(data []byte) error {
+	type Alias ETWConfig
+	aux := &struct {
+		*Alias
+	}{
+		Alias: (*Alias)(cfg),
+	}
+	if err := json.Unmarshal(data, &aux); err != nil {
+		return errors.Wrap(err, "failed to unmarshal ETWConfig")
+	}
+	lvl, err := zapcore.ParseLevel(cfg.Level)
+	if err != nil {
+		return errors.Wrap(err, "failed to parse ETWConfig Level")
+	}
+	cfg.level = lvl
+	return nil
 }
 
 // ETWCore builds a zapcore.Core that sends logs to ETW.
@@ -18,5 +44,5 @@ func ETWCore(cfg *ETWConfig) (zapcore.Core, func(), error) {
 	encoderConfig := zap.NewProductionEncoderConfig()
 	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
 	jsonEncoder := zapcore.NewJSONEncoder(encoderConfig)
-	return zapetw.New(cfg.ProviderName, cfg.EventName, jsonEncoder, cfg.Level) //nolint:wrapcheck // ignore
+	return zapetw.New(cfg.ProviderName, cfg.EventName, jsonEncoder, cfg.level) //nolint:wrapcheck // ignore
 }

cns/logger/v2/cores/ai.go

@@ -10,11 +10,12 @@ import (
 )
 
 type FileConfig struct {
-	Filepath   string        `json:"filepath"`
-	Level      string        `json:"level"`
-	level      zapcore.Level `json:"-"`
-	MaxBackups int           `json:"maxBackups"`
-	MaxSize    int           `json:"maxSize"`
+	Filepath   string          `json:"filepath"`
+	Level      string          `json:"level"`
+	level      zapcore.Level   `json:"-"`
+	MaxBackups int             `json:"maxBackups"`
+	MaxSize    int             `json:"maxSize"`
+	Fields     []zapcore.Field `json:"fields"`
 }
 
 // UnmarshalJSON implements json.Unmarshaler for the Config.

cns/logger/v2/cores/etw_windows.go

@@ -1,13 +1,42 @@
 package logger
 
 import (
+	"encoding/json"
 	"os"
 
 	logfmt "github.com/jsternberg/zap-logfmt"
+	"github.com/pkg/errors"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 )
 
+type StdoutConfig struct {
+	Level  string          `json:"level"`
+	level  zapcore.Level   `json:"-"`
+	Fields []zapcore.Field `json:"fields"`
+}
+
+// UnmarshalJSON implements json.Unmarshaler for the Config.
+// It only differs from the default by parsing the
+// Level string into a zapcore.Level and setting the level field.
+func (cfg *StdoutConfig) UnmarshalJSON(data []byte) error {
+	type Alias StdoutConfig
+	aux := &struct {
+		*Alias
+	}{
+		Alias: (*Alias)(cfg),
+	}
+	if err := json.Unmarshal(data, &aux); err != nil {
+		return errors.Wrap(err, "failed to unmarshal StdoutConfig")
+	}
+	lvl, err := zapcore.ParseLevel(cfg.Level)
+	if err != nil {
+		return errors.Wrap(err, "failed to parse StdoutConfig Level")
+	}
+	cfg.level = lvl
+	return nil
+}
+
 // StdoutCore builds a zapcore.Core that writes to stdout.
 func StdoutCore(l zapcore.Level) zapcore.Core {
 	encoderConfig := zap.NewProductionEncoderConfig()

cns/logger/v2/cores/file.go

@@ -0,0 +1,23 @@
+package logger
+
+import (
+	"github.com/Azure/azure-container-networking/common"
+	"go.uber.org/zap"
+)
+
+// MetadataToFields transforms Az IMDS Metadata in to zap.Field for
+// attaching to a root zap core or logger instance.
+// This uses the nice-names from the zapai.DefaultMappers instead of
+// raw AppInsights key names.
+func MetadataToFields(meta common.Metadata) []zap.Field {
+	return []zap.Field{
+		zap.String("account", meta.SubscriptionID),
+		zap.String("anonymous_user_id", meta.VMName),
+		zap.String("location", meta.Location),
+		zap.String("resource_group", meta.ResourceGroupName),
+		zap.String("vm_size", meta.VMSize),
+		zap.String("os_version", meta.OSVersion),
+		zap.String("vm_id", meta.VMID),
+		zap.String("session_id", meta.VMID),
+	}
+}

cns/logger/v2/cores/stdout.go

@@ -16,6 +16,7 @@ func (c compoundCloser) Close() {
 	}
 }
 
+// New creates a v2 CNS logger built with Zap.
 func New(cfg *Config) (*zap.Logger, func(), error) {
 	cfg.Normalize()
 	core := cores.StdoutCore(cfg.level)