Skip to content

Commit

Permalink
Tune logs (zap) fields for each component, remove duplicate type alre…
Browse files Browse the repository at this point in the history
…ady in name (#2864)

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
bogdandrutu authored Mar 31, 2021
1 parent 196df24 commit 231815c
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 14 deletions.
13 changes: 6 additions & 7 deletions service/internal/builder/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,12 @@ const (
configCfg = "config"
memBallastFlag = "mem-ballast-size-mib"

kindLogKey = "component_kind"
kindLogsReceiver = "receiver"
kindLogsProcessor = "processor"
kindLogsExporter = "exporter"
kindLogExtension = "extension"
typeLogKey = "component_type"
nameLogKey = "component_name"
zapKindKey = "kind"
zapKindReceiver = "receiver"
zapKindProcessor = "processor"
zapKindLogExporter = "exporter"
zapKindExtension = "extension"
zapNameKey = "name"
)

var (
Expand Down
4 changes: 2 additions & 2 deletions service/internal/builder/exporters_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ func BuildExporters(
config *config.Config,
factories map[config.Type]component.ExporterFactory,
) (Exporters, error) {
eb := &exportersBuilder{logger.With(zap.String(kindLogKey, kindLogsExporter)), appInfo, config, factories}
eb := &exportersBuilder{logger.With(zap.String(zapKindKey, zapKindLogExporter)), appInfo, config, factories}

// We need to calculate required input data types for each exporter so that we know
// which data type must be started for each exporter.
Expand All @@ -164,7 +164,7 @@ func BuildExporters(
exporters := make(Exporters)
// BuildExporters exporters based on configuration and required input data types.
for _, cfg := range eb.config.Exporters {
componentLogger := eb.logger.With(zap.String(typeLogKey, string(cfg.Type())), zap.String(nameLogKey, cfg.Name()))
componentLogger := eb.logger.With(zap.String(zapNameKey, cfg.Name()))
exp, err := eb.buildExporter(context.Background(), componentLogger, eb.appInfo, cfg, exporterInputDataTypes)
if err != nil {
return nil, err
Expand Down
4 changes: 2 additions & 2 deletions service/internal/builder/extensions_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ func BuildExtensions(
config *config.Config,
factories map[config.Type]component.ExtensionFactory,
) (Extensions, error) {
eb := &extensionsBuilder{logger.With(zap.String(kindLogKey, kindLogExtension)), appInfo, config, factories}
eb := &extensionsBuilder{logger.With(zap.String(zapKindKey, zapKindExtension)), appInfo, config, factories}

extensions := make(Extensions)
for _, extName := range eb.config.Service.Extensions {
Expand All @@ -134,7 +134,7 @@ func BuildExtensions(
return nil, fmt.Errorf("extension %q is not configured", extName)
}

componentLogger := eb.logger.With(zap.String(typeLogKey, string(extCfg.Type())), zap.String(nameLogKey, extCfg.Name()))
componentLogger := eb.logger.With(zap.String(zapNameKey, extCfg.Name()))
ext, err := eb.buildExtension(componentLogger, eb.appInfo, extCfg)
if err != nil {
return nil, err
Expand Down
2 changes: 1 addition & 1 deletion service/internal/builder/pipelines_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ func (pb *pipelinesBuilder) buildPipeline(ctx context.Context, pipelineCfg *conf
// it becomes the next for the previous one (previous in the pipeline,
// which we will build in the next loop iteration).
var err error
componentLogger := pb.logger.With(zap.String(kindLogKey, kindLogsProcessor), zap.String(typeLogKey, string(procCfg.Type())), zap.String(nameLogKey, procCfg.Name()))
componentLogger := pb.logger.With(zap.String(zapKindKey, zapKindProcessor), zap.String(zapNameKey, procCfg.Name()))
creationParams := component.ProcessorCreateParams{
Logger: componentLogger,
ApplicationStartInfo: pb.appInfo,
Expand Down
4 changes: 2 additions & 2 deletions service/internal/builder/receivers_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,11 @@ func BuildReceivers(
builtPipelines BuiltPipelines,
factories map[config.Type]component.ReceiverFactory,
) (Receivers, error) {
rb := &receiversBuilder{logger.With(zap.String(kindLogKey, kindLogsReceiver)), appInfo, config, builtPipelines, factories}
rb := &receiversBuilder{logger.With(zap.String(zapKindKey, zapKindReceiver)), appInfo, config, builtPipelines, factories}

receivers := make(Receivers)
for _, cfg := range rb.config.Receivers {
logger := rb.logger.With(zap.String(typeLogKey, string(cfg.Type())), zap.String(nameLogKey, cfg.Name()))
logger := rb.logger.With(zap.String(zapNameKey, cfg.Name()))
rcv, err := rb.buildReceiver(context.Background(), logger, rb.appInfo, cfg)
if err != nil {
if err == errUnusedReceiver {
Expand Down

0 comments on commit 231815c

Please sign in to comment.