feat: cns logger v2 [1/2] #3437
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "time" | ||
|
|
||
| loggerv1 "github.com/Azure/azure-container-networking/cns/logger" | ||
| cores "github.com/Azure/azure-container-networking/cns/logger/v2/cores" | ||
| "github.com/pkg/errors" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| //nolint:unused // will be used | ||
| const ( | ||
| defaultMaxBackups = 10 | ||
| defaultMaxSize = 10 // MB | ||
| defaultMaxBatchInterval = 30 * time.Second | ||
| defaultMaxBatchSize = 32000 | ||
| defaultGracePeriod = 30 * time.Second | ||
| ) | ||
|
|
||
| //nolint:unused // will be used | ||
| var defaultIKey = loggerv1.AppInsightsIKey | ||
|
|
||
| type Config struct { | ||
| // Level is the general logging Level. If cores have more specific config it will override this. | ||
| Level string `json:"level"` | ||
| level zapcore.Level `json:"-"` | ||
| AppInsights cores.AppInsightsConfig `json:"appInsights"` | ||
| File cores.FileConfig `json:"file"` | ||
| } | ||
|
|
||
| // 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 (c *Config) UnmarshalJSON(data []byte) error { | ||
| type Alias Config | ||
| aux := &struct { | ||
| *Alias | ||
| }{ | ||
| Alias: (*Alias)(c), | ||
| } | ||
| if err := json.Unmarshal(data, &aux); err != nil { | ||
| return errors.Wrap(err, "failed to unmarshal Config") | ||
| } | ||
| if l, err := zapcore.ParseLevel(c.Level); err == nil { | ||
| c.level = l | ||
| } | ||
| return nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "time" | ||
|
|
||
| "github.com/Azure/azure-container-networking/zapai" | ||
| "github.com/microsoft/ApplicationInsights-Go/appinsights" | ||
| "github.com/pkg/errors" | ||
| "go.uber.org/zap" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| type AppInsightsConfig struct { | ||
| GracePeriod time.Duration `json:"grace_period"` | ||
| IKey string `json:"ikey"` | ||
| Level string `json:"level"` | ||
| level zapcore.Level `json:"-"` // Zero value is default Info level. | ||
| MaxBatchInterval time.Duration `json:"max_batch_interval"` | ||
| MaxBatchSize int `json:"max_batch_size"` | ||
| 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 (c *AppInsightsConfig) UnmarshalJSON(data []byte) error { | ||
| type Alias AppInsightsConfig | ||
| aux := &struct { | ||
| *Alias | ||
| }{ | ||
| Alias: (*Alias)(c), | ||
| } | ||
| if err := json.Unmarshal(data, &aux); err != nil { | ||
| return errors.Wrap(err, "failed to unmarshal AppInsightsConfig") | ||
| } | ||
| lvl, err := zapcore.ParseLevel(c.Level) | ||
| if err != nil { | ||
| return errors.Wrap(err, "failed to parse AppInsightsConfig Level") | ||
| } | ||
| c.level = lvl | ||
| return nil | ||
| } | ||
|
|
||
| // ApplicationInsightsCore builds a zapcore.Core that sends logs to Application Insights. | ||
| // The first return is the core, the second is a function to close the sink. | ||
| func ApplicationInsightsCore(cfg *AppInsightsConfig) (zapcore.Core, func(), error) { | ||
| // build the AI config | ||
| aicfg := *appinsights.NewTelemetryConfiguration(cfg.IKey) | ||
| aicfg.MaxBatchSize = cfg.MaxBatchSize | ||
| aicfg.MaxBatchInterval = cfg.MaxBatchInterval | ||
| sinkcfg := zapai.SinkConfig{ | ||
| GracePeriod: cfg.GracePeriod, | ||
| TelemetryConfiguration: aicfg, | ||
| } | ||
| // open the AI zap sink | ||
| sink, aiclose, err := zap.Open(sinkcfg.URI()) | ||
| if err != nil { | ||
| return nil, aiclose, errors.Wrap(err, "failed to open AI sink") | ||
rbtr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| // build the AI core | ||
| 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 | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "github.com/Azure/azure-container-networking/zapetw" | ||
| "go.uber.org/zap" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| type ETWConfig struct { | ||
| EventName string | ||
| Level zapcore.Level | ||
| ProviderName string | ||
| } | ||
|
|
||
| // ETWCore builds a zapcore.Core that sends logs to ETW. | ||
| // The first return is the core, the second is a function to close the sink. | ||
| 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 | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
|
|
||
| "github.com/pkg/errors" | ||
| "go.uber.org/zap" | ||
| "go.uber.org/zap/zapcore" | ||
| "gopkg.in/natefinch/lumberjack.v2" | ||
| ) | ||
|
|
||
| type FileConfig struct { | ||
| Filepath string `json:"filepath"` | ||
| Level string `json:"level"` | ||
| level zapcore.Level `json:"-"` | ||
rbtr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| MaxBackups int `json:"maxBackups"` | ||
| MaxSize int `json:"maxSize"` | ||
| } | ||
|
|
||
| // 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 *FileConfig) UnmarshalJSON(data []byte) error { | ||
| type Alias FileConfig | ||
| aux := &struct { | ||
| *Alias | ||
| }{ | ||
| Alias: (*Alias)(cfg), | ||
| } | ||
| if err := json.Unmarshal(data, &aux); err != nil { | ||
| return errors.Wrap(err, "failed to unmarshal FileConfig") | ||
| } | ||
| lvl, err := zapcore.ParseLevel(cfg.Level) | ||
| if err != nil { | ||
| return errors.Wrap(err, "failed to parse FileConfig Level") | ||
| } | ||
| cfg.level = lvl | ||
| return nil | ||
| } | ||
|
|
||
| // FileCore builds a zapcore.Core that writes to a file. | ||
| // The first return is the core, the second is a function to close the file. | ||
| func FileCore(cfg *FileConfig) (zapcore.Core, func(), error) { | ||
| filesink := &lumberjack.Logger{ | ||
| Filename: cfg.Filepath, | ||
| MaxSize: cfg.MaxSize, // MB | ||
| MaxBackups: cfg.MaxBackups, | ||
| } | ||
| encoderConfig := zap.NewProductionEncoderConfig() | ||
| encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder | ||
| jsonEncoder := zapcore.NewJSONEncoder(encoderConfig) | ||
| return zapcore.NewCore(jsonEncoder, zapcore.AddSync(filesink), cfg.level), func() { _ = filesink.Close() }, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| logfmt "github.com/jsternberg/zap-logfmt" | ||
| "go.uber.org/zap" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| // StdoutCore builds a zapcore.Core that writes to stdout. | ||
| func StdoutCore(l zapcore.Level) zapcore.Core { | ||
| encoderConfig := zap.NewProductionEncoderConfig() | ||
| encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder | ||
| return zapcore.NewCore(logfmt.NewEncoder(encoderConfig), os.Stdout, l) | ||
jackieluc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| cores "github.com/Azure/azure-container-networking/cns/logger/v2/cores" | ||
| "go.uber.org/zap" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| type compoundCloser []func() | ||
|
|
||
| func (c compoundCloser) Close() { | ||
| for _, closer := range c { | ||
| closer() | ||
| } | ||
| } | ||
|
|
||
| func New(cfg *Config) (*zap.Logger, func(), error) { | ||
| stdoutCore := cores.StdoutCore(cfg.level) | ||
| closer := compoundCloser{} | ||
| fileCore, fileCloser, err := cores.FileCore(&cfg.File) | ||
| closer = append(closer, fileCloser) | ||
rbtr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if err != nil { | ||
| return nil, closer.Close, err //nolint:wrapcheck // it's an internal pkg | ||
| } | ||
| aiCore, aiCloser, err := cores.ApplicationInsightsCore(&cfg.AppInsights) | ||
| closer = append(closer, aiCloser) | ||
rbtr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if err != nil { | ||
| return nil, closer.Close, err //nolint:wrapcheck // it's an internal pkg | ||
| } | ||
| platformCore, platformCloser, err := platformCore(cfg) | ||
| closer = append(closer, platformCloser) | ||
rbtr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if err != nil { | ||
| return nil, closer.Close, err | ||
| } | ||
| core := zapcore.NewTee(stdoutCore, fileCore, aiCore, platformCore) | ||
rbtr marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return zap.New(core), closer.Close, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| const defaultFilePath = "/var/log/azure-cns.log" | ||
|
Check failure on line 7 in cns/logger/v2/logger_linux.go
|
||
|
|
||
| // platformCore returns a no-op core for Linux. | ||
| func platformCore(*Config) (zapcore.Core, func(), error) { | ||
| return zapcore.NewNopCore(), func() {}, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| cores "github.com/Azure/azure-container-networking/cns/logger/v2/cores" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| const defaultFilePath = "/k/azurecns/azure-cns.log" | ||
|
Check failure on line 8 in cns/logger/v2/logger_windows.go
|
||
|
|
||
| // platformCore returns a zapcore.Core that sends logs to ETW. | ||
| func platformCore(cfg *Config) (zapcore.Core, func(), error) { | ||
| return cores.ETWCore(&cores.ETWConfig{ //nolint:wrapcheck // ignore | ||
| EventName: "AzureCNS", | ||
| Level: cfg.level, | ||
| ProviderName: "ACN-Monitoring", | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.