[chore] update examples to use debugexporter (open-telemetry#26715)

This updates the code examples to use the debug exporter instead of the logging exporter. This change will need to be merged after the v0.86.0 release. --------- Signed-off-by: Alex Boten <[email protected]>
djaglowski · Sep 26, 2023 · 4982f49 · 4982f49
1 parent 207b6c1
commit 4982f49
Show file tree

Hide file tree

Showing 36 changed files with 97 additions and 80 deletions.
diff --git a/cmd/configschema/go.mod b/cmd/configschema/go.mod
@@ -619,6 +619,7 @@ require (
  go.opentelemetry.io/collector/confmap v0.86.0 // indirect
  go.opentelemetry.io/collector/connector v0.86.0 // indirect
  go.opentelemetry.io/collector/consumer v0.86.0 // indirect
+ go.opentelemetry.io/collector/exporter/debugexporter v0.86.0 // indirect
  go.opentelemetry.io/collector/exporter/loggingexporter v0.86.0 // indirect
  go.opentelemetry.io/collector/exporter/otlpexporter v0.86.0 // indirect
  go.opentelemetry.io/collector/exporter/otlphttpexporter v0.86.0 // indirect

diff --git a/cmd/configschema/go.sum b/cmd/configschema/go.sum
diff --git a/cmd/otelcontribcol/builder-config.yaml b/cmd/otelcontribcol/builder-config.yaml
@@ -31,6 +31,7 @@ extensions:
  import: github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage/dbstorage
 
 exporters:
+ - gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.86.0
  - gomod: go.opentelemetry.io/collector/exporter/loggingexporter v0.86.0
  - gomod: go.opentelemetry.io/collector/exporter/otlpexporter v0.86.0
  - gomod: go.opentelemetry.io/collector/exporter/otlphttpexporter v0.86.0

diff --git a/cmd/otelcontribcol/components.go b/cmd/otelcontribcol/components.go
diff --git a/cmd/otelcontribcol/exporters_test.go b/cmd/otelcontribcol/exporters_test.go
@@ -11,7 +11,6 @@ import (
  "context"
  "errors"
  "path/filepath"
- "runtime"
  "testing"
 
  "github.com/stretchr/testify/assert"
@@ -105,8 +104,10 @@ func TestDefaultExporters(t *testing.T) {
  },
  },
  {
- exporter: "logging",
- skipLifecycle: runtime.GOOS == "darwin", // TODO: investigate why this fails on darwin.
+ exporter: "debug",
+ },
+ {
+ exporter: "logging",
  },
  {
  exporter: "opencensus",

diff --git a/cmd/otelcontribcol/go.mod b/cmd/otelcontribcol/go.mod
@@ -191,6 +191,7 @@ require (
  go.opentelemetry.io/collector/connector/forwardconnector v0.86.0
  go.opentelemetry.io/collector/consumer v0.86.0
  go.opentelemetry.io/collector/exporter v0.86.0
+ go.opentelemetry.io/collector/exporter/debugexporter v0.86.0
  go.opentelemetry.io/collector/exporter/loggingexporter v0.86.0
  go.opentelemetry.io/collector/exporter/otlpexporter v0.86.0
  go.opentelemetry.io/collector/exporter/otlphttpexporter v0.86.0

diff --git a/cmd/otelcontribcol/go.sum b/cmd/otelcontribcol/go.sum
diff --git a/cmd/oteltestbedcol/builder-config.yaml b/cmd/oteltestbedcol/builder-config.yaml
@@ -13,6 +13,7 @@ extensions:
  import: github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage/filestorage
 
 exporters:
+ - gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.86.0
  - gomod: go.opentelemetry.io/collector/exporter/loggingexporter v0.86.0
  - gomod: go.opentelemetry.io/collector/exporter/otlpexporter v0.86.0
  - gomod: go.opentelemetry.io/collector/exporter/otlphttpexporter v0.86.0

diff --git a/cmd/oteltestbedcol/components.go b/cmd/oteltestbedcol/components.go
diff --git a/cmd/oteltestbedcol/go.mod b/cmd/oteltestbedcol/go.mod
@@ -34,6 +34,7 @@ require (
  go.opentelemetry.io/collector/component v0.86.0
  go.opentelemetry.io/collector/connector v0.86.0
  go.opentelemetry.io/collector/exporter v0.86.0
+ go.opentelemetry.io/collector/exporter/debugexporter v0.86.0
  go.opentelemetry.io/collector/exporter/loggingexporter v0.86.0
  go.opentelemetry.io/collector/exporter/otlpexporter v0.86.0
  go.opentelemetry.io/collector/exporter/otlphttpexporter v0.86.0

diff --git a/cmd/oteltestbedcol/go.sum b/cmd/oteltestbedcol/go.sum
diff --git a/cmd/telemetrygen/README.md b/cmd/telemetrygen/README.md
@@ -38,7 +38,7 @@ receivers:
 processors:
 
 exporters:
- logging:
+ debug:
 
 service:
  pipelines:
@@ -47,7 +47,7 @@ service:
  - otlp
  processors: []
  exporters:
- - logging
+ - debug
 ```
 
 Once the OpenTelemetry Collector instance is up and running, run `telemetrygen` for your desired telemetry:

diff --git a/confmap/provider/s3provider/testdata/otel-config.yaml b/confmap/provider/s3provider/testdata/otel-config.yaml
@@ -20,18 +20,18 @@ processors:
  check_interval: 5s
 
 exporters:
- logging:
- loglevel: debug
+ debug:
+ verbosity: detailed
 
 service:
  pipelines:
  traces:
  receivers: [otlp]
  processors: [memory_limiter, batch]
- exporters: [logging]
+ exporters: [debug]
  metrics:
  receivers: [otlp]
  processors: [memory_limiter, batch]
- exporters: [logging]
+ exporters: [debug]
 
  extensions: [memory_ballast, zpages]
diff --git a/examples/demo/otel-collector-config.yaml b/examples/demo/otel-collector-config.yaml
@@ -9,7 +9,7 @@ exporters:
  const_labels:
  label1: value1
 
- logging:
+ debug:
 
  zipkin:
  endpoint: "http:https://zipkin-all-in-one:9411/api/v2/spans"
@@ -36,8 +36,8 @@ service:
  traces:
  receivers: [otlp]
  processors: [batch]
- exporters: [logging, zipkin, otlp]
+ exporters: [debug, zipkin, otlp]
  metrics:
  receivers: [otlp]
  processors: [batch]
- exporters: [logging, prometheus]
+ exporters: [debug, prometheus]
diff --git a/examples/kubernetes/otel-collector-config.yml b/examples/kubernetes/otel-collector-config.yml
@@ -74,10 +74,10 @@ receivers:
  from: attributes.uid
  to: resource["k8s.pod.uid"]
 exporters:
- logging:
- loglevel: debug
+ debug:
+ verbosity: detailed
 service:
  pipelines:
  logs:
  receivers: [filelog]
- exporters: [logging]
+ exporters: [debug]
diff --git a/examples/kubernetes/otel-collector.yaml b/examples/kubernetes/otel-collector.yaml
@@ -113,14 +113,14 @@ data:
  - from: connection
 
  exporters:
- logging:
- loglevel: debug
+ debug:
+ verbosity: detailed
  service:
  pipelines:
  logs:
  receivers: [filelog]
  processors: [k8sattributes]
- exporters: [logging]
+ exporters: [debug]
 
 ---
 apiVersion: apps/v1

diff --git a/examples/nomad/otel-collector.nomad b/examples/nomad/otel-collector.nomad
@@ -96,14 +96,14 @@ processors:
  check_interval: 5s
 
 exporters:
- logging:
- logLevel: debug
+ debug:
+ verbosity: detailed
 
 service:
  pipelines:
  traces:
  receivers: [otlp]
- exporters: [logging]
+ exporters: [debug]
 
 EOH
 

diff --git a/exporter/fileexporter/README.md b/exporter/fileexporter/README.md
@@ -125,7 +125,7 @@ spec:
  processors:
 
  exporters:
- logging:
+ debug:
  file:
  path: /data/metrics.json
 
@@ -134,7 +134,7 @@ spec:
  metrics:
  receivers: [otlp]
  processors: []
- exporters: [logging,file]
+ exporters: [debug,file]
  volumes:
  - name: file
  emptyDir: {}

diff --git a/exporter/instanaexporter/README.md b/exporter/instanaexporter/README.md
@@ -62,8 +62,6 @@ receivers:
 processors:
  batch:
 exporters:
- logging:
- loglevel: debug
  instana:
  endpoint: ${env:INSTANA_ENDPOINT_URL}
  agent_key: ${env:INSTANA_AGENT_KEY}

diff --git a/exporter/loadbalancingexporter/README.md b/exporter/loadbalancingexporter/README.md
@@ -79,7 +79,6 @@ receivers:
 processors:
 
 exporters:
- logging:
  loadbalancing:
  routing_key: "service"
  protocol:
@@ -122,7 +121,6 @@ receivers:
 processors:
 
 exporters:
- logging:
  loadbalancing:
  routing_key: "service"
  protocol:
@@ -181,7 +179,7 @@ receivers:
 processors:
 
 exporters:
- logging:
+ debug:
  loadbalancing:
  protocol:
  otlp:
@@ -210,28 +208,28 @@ service:
  - otlp/backend-1
  processors: []
  exporters:
- - logging
+ - debug
 
  traces/backend-2:
  receivers:
  - otlp/backend-2
  processors: []
  exporters:
- - logging
+ - debug
 
  traces/backend-3:
  receivers:
  - otlp/backend-3
  processors: []
  exporters:
- - logging
+ - debug
 
  traces/backend-4:
  receivers:
  - otlp/backend-4
  processors: []
  exporters:
- - logging
+ - debug
 
  logs/loadbalancer:
  receivers:
@@ -244,25 +242,25 @@ service:
  - otlp/backend-1
  processors: []
  exporters:
- - logging
+ - debug
  logs/backend-2:
  receivers:
  - otlp/backend-2
  processors: []
  exporters:
- - logging
+ - debug
  logs/backend-3:
  receivers:
  - otlp/backend-3
  processors: []
  exporters:
- - logging
+ - debug
  logs/backend-4:
  receivers:
  - otlp/backend-4
  processors: []
  exporters:
- - logging
+ - debug
 ```
 
 ## Metrics

diff --git a/exporter/loadbalancingexporter/example/k8s-resolver/README.md b/exporter/loadbalancingexporter/example/k8s-resolver/README.md
@@ -101,7 +101,7 @@ spec:
  processors:
 
  exporters:
- logging:
+ debug:
 
  service:
  pipelines:
@@ -110,7 +110,7 @@ spec:
  - otlp
  processors: []
  exporters:
- - logging
+ - debug
 EOF
 ```
 

diff --git a/exporter/loadbalancingexporter/example/otel-agent-config.yaml b/exporter/loadbalancingexporter/example/otel-agent-config.yaml
@@ -6,8 +6,8 @@ processors:
  batch:
 
 exporters:
- logging:
- loglevel: debug
+ debug:
+ verbosity: detailed
  loadbalancing:
  protocol:
  otlp:
@@ -32,4 +32,4 @@ service:
  logs:
  receivers: [fluentforward]
  processors: [batch]
- exporters: [loadbalancing, logging]
+ exporters: [loadbalancing, debug]
diff --git a/exporter/loadbalancingexporter/example/otel-collector-config.yaml b/exporter/loadbalancingexporter/example/otel-collector-config.yaml
@@ -7,8 +7,8 @@ processors:
  batch:
 
 exporters:
- logging:
- loglevel: debug
+ debug:
+ verbosity: detailed
 
 extensions:
  health_check:
@@ -21,4 +21,4 @@ service:
  logs:
  receivers: [otlp]
  processors: [batch]
- exporters: [logging]
+ exporters: [debug]