Remove global logging functions in libbeat

[urso]

In order to better support structured logging, we want to get rid of the global logger functions. The API of the global logger functions is not in line with the methods defined by (*logp).Logger.

For now we will focus on libbeat first.

Refactoring Notes/Tips:

• replace logp.Debug/Info/Warn/... with f variants like (*Logger).Debugf/Infof/Warnf/... if a format string has been used. Otherwise stick with (*Logger).Debug/Info/...
• Use %+v when logging an error using a format string. Some logger libraries implement fmt.Formatter and will print the wrapped error only if + is given.
• logp.Debug accepts as first argument the selector name. *logp.Logger instances have a name and the selector name must be removed when switching to (*Logger).Debugf
• use (*Logger).Named (prefer (*Logger).Named) to create a logger instance in order to replace logp.MakeDebug. For now in unit tests you can use logp.L() if you need to pass a logger you don't care about
• use logp.NewLogger to reduce the amount of transitive changes. NewLogger will be removed in the future as well, but for now it can help to reduce PR sizes.
• store/pass logger instances locally. Do not store logger instances in private package global variables.
• Use the compiler:
  • use tags=nologpglobal to compile/test a package without logp global logging functions being available
  • Do dependend packages still build?
• Consider error values.
  • If we log a message without context and return an error value to be logged with a similar message, consider to just return the error value
  • If we log a message, but return the original error consider to remove the log message and wrap the error using an appropriate error message.

Tasks

• Add nologpglobal build tag to logp Split global and normal logger tests #15700
• libbeat cleanups:
  • libbeat/autodiscover
    • appenders/config
    • builder
    • providers
      • docker Reduce global logging in some docker/k8s + AD related packages #16003
      • kubernetes Reduce global logging in some docker/k8s + AD related packages #16003
      • jolokia Reduce global logging in some docker/k8s + AD related packages #16003
    • template
  • libbeat/cfgfile
  • libbeat/cloudid Libbeat: Remove global loggers from libbeat/metric and libbeat/cloudid #18500
  • libbeat/cmd/instance
  • libbeat/common/bus Reduce global logging in some docker/k8s + AD related packages #16003
  • libbeat/common/config.go
  • libbeat/common/docker Reduce global logging in some docker/k8s + AD related packages #16003
  • libbeat/common/event.go Reduce use of global loggers in libbeat/common #16149
  • libbeat/common/fmtstr Remove logp.Warn from fmtstr #15943
  • libbeat/common/kubernetes Reduce global logging in some docker/k8s + AD related packages #16003
  • libbeat/common/jsontransform [libbeat] Remove global loggers from jsontransform #18550
  • libbeat/common/safemapstr
  • libbeat/common/schema
  • libbeat/common/schema/mapstriface
  • libbeat/common/streambuf remove debug logging from streambuf #15945
  • libbeat/common/transport/tlscommon (Remove global logger from outputs and monitoring #16761)
  • libbeat/dashboards
  • libbeat/keystore Remove debug logging from keystore #15946
  • libbeat/kibana Remove global logp calls from libbeat/kibana and libbeat/template #18258
  • libbeat/metric/system
    • memory Libbeat: Remove global loggers from libbeat/metric and libbeat/cloudid #18500
    • process Libbeat: Remove global loggers from libbeat/metric and libbeat/cloudid #18500
  • libbeat/mock [libbeat] Remove global loggers from plugin and mock #18552
  • libbeat/monitoring/ (Remove global logger from outputs and monitoring #16761)
    • adapter
    • report/elasticsearch
  • libbeat/outputs (Remove global logger from outputs and monitoring #16761)
    • libbeat/outputs/console
    • libbeat/outputs/elasticsearch
    • libbeat/outputs/fileout
    • libbeat/outputs/kafka
    • libbeat/outputs/logstash
    • libbeat/outputs/outil
    • libbeat/outputs/redis
    • libbeat/outputs/transport
  • libbeat/plugin [libbeat] Remove global loggers from plugin and mock #18552
  • libbeat/processors/
    • actions [Libbeat] Use *logp.Logger in libbeat processors #16654
    • add_cloud_metadata [Libbeat] Use *logp.Logger in libbeat processors #16654
    • add_host_metadata [Libbeat] Use *logp.Logger in libbeat processors #16654
    • add_docker_metadata Reduce global logging in some docker/k8s + AD related packages #16003
    • add_kubernetes_metadata Reduce global logging in some docker/k8s + AD related packages #16003
    • add_locale#16654
    • add_observer_metadata [Libbeat] Use *logp.Logger in libbeat processors #16654
    • script/javascript/module/console
  • libbeat/publisher/ [Libbeat] Remove global logger from libbeat publisher and reader #16886
    • pipeline
    • pipeline/stress
    • processing
    • queue/queuetest
  • libbeat/reader [Libbeat] Remove global logger from libbeat publisher and reader #16886
    • multiline
    • readfile
    • readjson
  • libbeat/service Ensure pprof endpoint is listening on startup #17028
  • libbeat/template Remove global logp calls from libbeat/kibana and libbeat/template #18258
  • libbeat/tests/compose

[botelastic]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[jlind23]

Closing for now as all tasks listed were achieved.