loggingexporter

README

Logging Exporter

Exports traces and/or metrics to the console via zap.Logger. This includes generic information about the package (with info loglevel) or details of the trace (when debug is set)

The following settings can be configured:

• loglevel: the log level of the logging export (debug|info|warn|error). Default is info. When it is set to debug, the trace related data (e.g. node, attributes, spans, metadata) are verbosely logged.
• sampling_initial: number of messages initially logged each second. Default is 2.
• sampling_thereafter: sampling rate after the initial messages are logged (every Mth message is logged). Default is 500. Refer to Zap docs for more details on how sampling parameters impact number of messages.

Example:

exporters:
  logging:
    loglevel: info
    sampling_initial: 5
    sampling_thereafter: 200

The full list of settings exposed for this exporter are documented here with detailed sample configurations here.

Documentation

Index

• func NewMetricsExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.MetricsExporter, error)
• func NewTraceExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.TraceExporter, error)
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() configmodels.Exporter
  • func (f *Factory) CreateMetricsExporter(_ context.Context, _ component.ExporterCreateParams, ...) (component.MetricsExporter, error)
  • func (f *Factory) CreateTraceExporter(_ context.Context, _ component.ExporterCreateParams, ...) (component.TraceExporter, error)
  • func (f *Factory) Type() configmodels.Type

Functions

func NewMetricsExporter

func NewMetricsExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.MetricsExporter, error)

NewMetricsExporter creates an exporter.MetricsExporter that just drops the received data and logs debugging messages.

func NewTraceExporter

func NewTraceExporter(config configmodels.Exporter, level string, logger *zap.Logger) (component.TraceExporter, error)

NewTraceExporter creates an exporter.TraceExporter that just drops the received data and logs debugging messages.

Types

type Config

type Config struct {
	configmodels.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.

	// LogLevel defines log level of the logging exporter; options are debug, info, warn, error.
	LogLevel string `mapstructure:"loglevel"`

	// SamplingInitial defines how many samples are initially logged during each second.
	SamplingInitial int `mapstructure:"sampling_initial"`

	// SamplingThereafter defines the sampling rate after the initial samples are logged.
	SamplingThereafter int `mapstructure:"sampling_thereafter"`
}

Config defines configuration for logging exporter.

type Factory

type Factory struct {
}

Factory is the factory for logging exporter.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() configmodels.Exporter

CreateDefaultConfig creates the default configuration for exporter.

func (*Factory) CreateMetricsExporter

func (f *Factory) CreateMetricsExporter(_ context.Context, _ component.ExporterCreateParams, config configmodels.Exporter) (component.MetricsExporter, error)

CreateMetricsExporter creates a metrics exporter based on this config.

func (*Factory) CreateTraceExporter

func (f *Factory) CreateTraceExporter(_ context.Context, _ component.ExporterCreateParams, config configmodels.Exporter) (component.TraceExporter, error)

CreateTraceExporter creates a trace exporter based on this config.

func (*Factory) Type

func (f *Factory) Type() configmodels.Type

Type gets the type of the Exporter config created by this factory.