Skip to content

Commit

Permalink
update factory name
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Boten <aboten@lightstep.com>
  • Loading branch information
Alex Boten committed Jun 22, 2023
1 parent c402519 commit acf68d9
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 19 deletions.
11 changes: 2 additions & 9 deletions exporter/debugexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Logging Exporter
# Debug Exporter

| Status | |
| ------------------------ |-----------------------|
Expand All @@ -14,10 +14,6 @@ Supported pipeline types: traces, metrics, logs

The following settings are optional:

- `loglevel` (default = `info`): the log level of the logging export
(debug|info|warn|error). When set to `debug`, pipeline data is verbosely
- **Note**: This option has been deprecated in favor of `verbosity`
logged.
- `verbosity` (default = `normal`): the verbosity of the logging export
(detailed|normal|basic). When set to `detailed`, pipeline data is verbosely
logged.
Expand All @@ -28,14 +24,11 @@ The following settings are optional:
docs](https://godoc.org/go.uber.org/zap/zapcore#NewSampler) for more details.
on how sampling parameters impact number of messages.

### Note
`loglevel` is deprecated, use `verbosity` instead.

Example:

```yaml
exporters:
logging:
debug:
verbosity: detailed
sampling_initial: 5
sampling_thereafter: 200
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func (s *debugexporter) pushLogs(_ context.Context, ld plog.Logs) error {
return nil
}

func newdebugexporter(logger *zap.Logger, verbosity configtelemetry.Level) *debugexporter {
func newDebugExporter(logger *zap.Logger, verbosity configtelemetry.Level) *debugexporter {
return &debugexporter{
verbosity: verbosity,
logger: logger,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ func TestLoggingLogsExporterNoErrors(t *testing.T) {
assert.NoError(t, lle.Shutdown(context.Background()))
}

func TestdebugexporterErrors(t *testing.T) {
le := newdebugexporter(zaptest.NewLogger(t), configtelemetry.LevelDetailed)
func TestDebugExporterErrors(t *testing.T) {
le := newDebugExporter(zaptest.NewLogger(t), configtelemetry.LevelDetailed)
require.NotNil(t, le)

errWant := errors.New("my error")
Expand Down
8 changes: 4 additions & 4 deletions exporter/debugexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (

const (
// The value of "type" key in configuration.
typeStr = "logging"
typeStr = "debug"
defaultSamplingInitial = 2
defaultSamplingThereafter = 500
)
Expand Down Expand Up @@ -50,7 +50,7 @@ func createDefaultConfig() component.Config {
func createTracesExporter(ctx context.Context, set exporter.CreateSettings, config component.Config) (exporter.Traces, error) {
cfg := config.(*Config)
exporterLogger := createLogger(cfg, set.TelemetrySettings.Logger)
s := newdebugexporter(exporterLogger, cfg.Verbosity)
s := newDebugExporter(exporterLogger, cfg.Verbosity)
return exporterhelper.NewTracesExporter(ctx, set, cfg,
s.pushTraces,
exporterhelper.WithCapabilities(consumer.Capabilities{MutatesData: false}),
Expand All @@ -65,7 +65,7 @@ func createTracesExporter(ctx context.Context, set exporter.CreateSettings, conf
func createMetricsExporter(ctx context.Context, set exporter.CreateSettings, config component.Config) (exporter.Metrics, error) {
cfg := config.(*Config)
exporterLogger := createLogger(cfg, set.TelemetrySettings.Logger)
s := newdebugexporter(exporterLogger, cfg.Verbosity)
s := newDebugExporter(exporterLogger, cfg.Verbosity)
return exporterhelper.NewMetricsExporter(ctx, set, cfg,
s.pushMetrics,
exporterhelper.WithCapabilities(consumer.Capabilities{MutatesData: false}),
Expand All @@ -80,7 +80,7 @@ func createMetricsExporter(ctx context.Context, set exporter.CreateSettings, con
func createLogsExporter(ctx context.Context, set exporter.CreateSettings, config component.Config) (exporter.Logs, error) {
cfg := config.(*Config)
exporterLogger := createLogger(cfg, set.TelemetrySettings.Logger)
s := newdebugexporter(exporterLogger, cfg.Verbosity)
s := newDebugExporter(exporterLogger, cfg.Verbosity)
return exporterhelper.NewLogsExporter(ctx, set, cfg,
s.pushLogs,
exporterhelper.WithCapabilities(consumer.Capabilities{MutatesData: false}),
Expand Down
6 changes: 3 additions & 3 deletions exporter/loggingexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ func NewFactory() exporter.Factory {
return exporter.NewFactory(
typeStr,
createDefaultConfig,
exporter.WithTraces(createTracesExporter, component.StabilityLevelDevelopment),
exporter.WithMetrics(createMetricsExporter, component.StabilityLevelDevelopment),
exporter.WithLogs(createLogsExporter, component.StabilityLevelDevelopment),
exporter.WithTraces(createTracesExporter, component.StabilityLevelDeprecated),
exporter.WithMetrics(createMetricsExporter, component.StabilityLevelDeprecated),
exporter.WithLogs(createLogsExporter, component.StabilityLevelDeprecated),
)
}

Expand Down

0 comments on commit acf68d9

Please sign in to comment.