update usage of logging exporter (#2130)

* update usage of logging exporter The logging exporter is being deprecated in favour of the debug exporter. This changes references to the logging exporter to use the new debug exporter instead. Note: this will remain in draft until v0.86.0 is released which will be the first release to include the debug exporter. Signed-off-by: Alex Boten <[email protected]> * add changelog Signed-off-by: Alex Boten <[email protected]> * update collector version Signed-off-by: Alex Boten <[email protected]> * update expected data Signed-off-by: Alex Boten <[email protected]> * fix test expectations Signed-off-by: Alex Boten <[email protected]> --------- Signed-off-by: Alex Boten <[email protected]>
open-telemetry · Oct 10, 2023 · 282c169 · 282c169
1 parent c4ba855
commit 282c169
Show file tree

Hide file tree

Showing 70 changed files with 183 additions and 167 deletions.
diff --git a/.chloggen/codeboten_logging-debug.yaml b/.chloggen/codeboten_logging-debug.yaml
@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. operator, target allocator, github action)
+component: operator
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: updating the operator to use the Collector's debug exporter in replacement of the deprecated logging exporter
+
+# One or more tracking issues related to the change
+issues: [2130]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
diff --git a/README.md b/README.md
@@ -48,21 +48,21 @@ spec:
         timeout: 10s
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         traces:
           receivers: [otlp]
           processors: []
-          exporters: [logging]
+          exporters: [debug]
 EOF
 ```
 
 **_WARNING:_** Until the OpenTelemetry Collector format is stable, changes may be required in the above example to remain
 compatible with the latest version of the OpenTelemetry Collector image being referenced.
 
-This will create an OpenTelemetry Collector instance named `simplest`, exposing a `jaeger-grpc` port to consume spans from your instrumented applications and exporting those spans via `logging`, which writes the spans to the console (`stdout`) of the OpenTelemetry Collector instance that receives the span.
+This will create an OpenTelemetry Collector instance named `simplest`, exposing a `jaeger-grpc` port to consume spans from your instrumented applications and exporting those spans via `debug`, which writes the spans to the console (`stdout`) of the OpenTelemetry Collector instance that receives the span.
 
 The `config` node holds the `YAML` that should be passed down as-is to the underlying OpenTelemetry Collector instances. Refer to the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) documentation for a reference of the possible entries.
 
@@ -111,14 +111,14 @@ spec:
     processors:
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         traces:
           receivers: [jaeger]
           processors: []
-          exporters: [logging]
+          exporters: [debug]
 EOF
 
 kubectl apply -f - <<EOF
@@ -565,14 +565,14 @@ spec:
               replacement: $$1
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         metrics:
           receivers: [prometheus]
           processors: []
-          exporters: [logging]
+          exporters: [debug]
 ```
 The usage of `$$` in the replacement keys in the example above is based on the information provided in the Prometheus receiver [README](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/prometheusreceiver/README.md) documentation, which states:
 `Note: Since the collector configuration supports env variable substitution $ characters in your prometheus configuration are interpreted as environment variables. If you want to use $ characters in your prometheus configuration, you must escape them using $$.`
@@ -597,14 +597,14 @@ Behind the scenes, the OpenTelemetry Operator will convert the Collector’s con
               replacement: $$1
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         metrics:
           receivers: [prometheus]
           processors: []
-          exporters: [logging]
+          exporters: [debug]
 ```
 
 Note how the Operator removes any existing service discovery configurations (e.g., `static_configs`, `file_sd_configs`, etc.) from the `scrape_configs` section and adds an `http_sd_configs` configuration pointing to a Target Allocator instance it provisioned.
@@ -649,14 +649,14 @@ Operator add the necessary target allocator configuration automatically. This fe
           collector_id: $POD_NAME
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         metrics:
           receivers: [prometheus]
           processors: []
-          exporters: [logging]
+          exporters: [debug]
 ```
 
 This also allows for a more straightforward collector configuration for target discovery using prometheus-operator CRDs. See below for a minimal example:
@@ -679,14 +679,14 @@ spec:
         config:
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         metrics:
           receivers: [prometheus]
           processors: []
-          exporters: [logging]
+          exporters: [debug]
 ```
 
 ## Compatibility matrix

diff --git a/bundle/manifests/opentelemetry-operator.clusterserviceversion.yaml b/bundle/manifests/opentelemetry-operator.clusterserviceversion.yaml
@@ -23,7 +23,7 @@ metadata:
             "name": "otel"
           },
           "spec": {
-            "config": "receivers:\n  otlp:\n    protocols: \n      grpc:\n      http:\n\nexporters:\n  logging:\n\nservice:\n  pipelines:\n    traces:\n      receivers: [otlp]\n      exporters: [logging]\n"
+            "config": "receivers:\n  otlp:\n    protocols: \n      grpc:\n      http:\n\nexporters:\n  debug:\n\nservice:\n  pipelines:\n    traces:\n      receivers: [otlp]\n      exporters: [debug]\n"
           }
         }
       ]

diff --git a/cmd/operator-opamp-bridge/agent/agent_test.go b/cmd/operator-opamp-bridge/agent/agent_test.go
@@ -168,7 +168,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 			},
@@ -187,7 +187,7 @@ func TestAgent_onMessage(t *testing.T) {
 			want: want{
 				contents: nil,
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("bad/testnamespace408"),
+					LastRemoteConfigHash: []byte("bad/testnamespace404"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_FAILED,
 					ErrorMessage:         "yaml: line 16: could not find expected ':'",
 				},
@@ -216,7 +216,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 			},
@@ -235,7 +235,7 @@ func TestAgent_onMessage(t *testing.T) {
 			want: want{
 				contents: nil,
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_FAILED,
 					ErrorMessage:         "Items in config are not allowed: [processors.batch]",
 				},
@@ -255,7 +255,7 @@ func TestAgent_onMessage(t *testing.T) {
 			want: want{
 				contents: nil,
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_FAILED,
 					ErrorMessage:         "Items in config are not allowed: [processors]",
 				},
@@ -288,7 +288,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 				nextContents: map[string][]string{
@@ -303,7 +303,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				nextStatus: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace439"),
+					LastRemoteConfigHash: []byte("good/testnamespace435"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 			},
@@ -335,7 +335,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 				nextContents: map[string][]string{
@@ -350,7 +350,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				nextStatus: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace408"), // The new hash should be of the bad config
+					LastRemoteConfigHash: []byte("good/testnamespace404"), // The new hash should be of the bad config
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_FAILED,
 					ErrorMessage:         "yaml: line 16: could not find expected ':'",
 				},
@@ -383,7 +383,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 				nextContents: map[string][]string{
@@ -405,7 +405,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				nextStatus: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405other/testnamespace439"),
+					LastRemoteConfigHash: []byte("good/testnamespace401other/testnamespace435"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 			},
@@ -434,7 +434,7 @@ func TestAgent_onMessage(t *testing.T) {
 					},
 				},
 				status: &protobufs.RemoteConfigStatus{
-					LastRemoteConfigHash: []byte("good/testnamespace405"),
+					LastRemoteConfigHash: []byte("good/testnamespace401"),
 					Status:               protobufs.RemoteConfigStatuses_RemoteConfigStatuses_APPLIED,
 				},
 				nextContents: map[string][]string{},

diff --git a/cmd/operator-opamp-bridge/agent/testdata/agentbasiccomponentsallowed.yaml b/cmd/operator-opamp-bridge/agent/testdata/agentbasiccomponentsallowed.yaml
@@ -20,4 +20,4 @@ components_allowed:
     - memory_limiter
     - batch
   exporters:
-    - logging
+    - debug
diff --git a/cmd/operator-opamp-bridge/agent/testdata/agentbatchnotallowed.yaml b/cmd/operator-opamp-bridge/agent/testdata/agentbatchnotallowed.yaml
@@ -19,4 +19,4 @@ components_allowed:
   processors:
     - memory_limiter
   exporters:
-    - logging
+    - debug
diff --git a/cmd/operator-opamp-bridge/agent/testdata/agentnoprocessorsallowed.yaml b/cmd/operator-opamp-bridge/agent/testdata/agentnoprocessorsallowed.yaml
@@ -17,4 +17,4 @@ components_allowed:
   receivers:
     - otlp
   exporters:
-    - logging
+    - debug
diff --git a/cmd/operator-opamp-bridge/agent/testdata/basic.yaml b/cmd/operator-opamp-bridge/agent/testdata/basic.yaml
@@ -14,11 +14,11 @@ config: |
       timeout: 10s
   
   exporters:
-    logging:
+    debug:
   
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: []
-        exporters: [logging]
+        exporters: [debug]
diff --git a/cmd/operator-opamp-bridge/agent/testdata/invalid.yaml b/cmd/operator-opamp-bridge/agent/testdata/invalid.yaml
@@ -15,10 +15,10 @@ config: |
 
 GARBAGE
   exporters:
-    logging:
+    debug:
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: []
-        exporters: [logging]
+        exporters: [debug]
diff --git a/cmd/operator-opamp-bridge/agent/testdata/updated.yaml b/cmd/operator-opamp-bridge/agent/testdata/updated.yaml
@@ -14,12 +14,12 @@ config: |
       timeout: 10s
   
   exporters:
-    logging:
+    debug:
   
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: [memory_limiter, batch]
-        exporters: [logging]
+        exporters: [debug]
 replicas: 3
diff --git a/cmd/operator-opamp-bridge/operator/testdata/collector.yaml b/cmd/operator-opamp-bridge/operator/testdata/collector.yaml
@@ -14,11 +14,11 @@ config: |
       timeout: 10s
   
   exporters:
-    logging:
+    debug:
   
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: []
-        exporters: [logging]
+        exporters: [debug]
diff --git a/cmd/operator-opamp-bridge/operator/testdata/invalid-collector.yaml b/cmd/operator-opamp-bridge/operator/testdata/invalid-collector.yaml
@@ -14,11 +14,11 @@ config: |
       timeout: 10s
 GARBAGE
   exporters:
-    logging:
+    debug:
 
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: []
-        exporters: [logging]
+        exporters: [debug]
diff --git a/cmd/operator-opamp-bridge/operator/testdata/updated-collector.yaml b/cmd/operator-opamp-bridge/operator/testdata/updated-collector.yaml
@@ -14,11 +14,11 @@ config: |
       timeout: 10s
   
   exporters:
-    logging:
+    debug:
   
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: [memory_limiter, batch]
-        exporters: [logging]
+        exporters: [debug]
diff --git a/cmd/otel-allocator/README.md b/cmd/otel-allocator/README.md
@@ -45,14 +45,14 @@ spec:
             - targets: [ '0.0.0.0:8888' ]
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         metrics:
           receivers: [prometheus]
           processors: []
-          exporters: [logging]
+          exporters: [debug]
 ```
 
 In essence, Prometheus Receiver configs are overridden with a `http_sd_config` directive that points to the

diff --git a/config/samples/core_v1alpha1_opentelemetrycollector.yaml b/config/samples/core_v1alpha1_opentelemetrycollector.yaml
@@ -11,10 +11,10 @@ spec:
           http:
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         traces:
           receivers: [otlp]
-          exporters: [logging]
+          exporters: [debug]
diff --git a/config/samples/sidecar.yaml b/config/samples/sidecar.yaml
@@ -12,10 +12,10 @@ spec:
           http:
 
     exporters:
-      logging:
+      debug:
 
     service:
       pipelines:
         traces:
           receivers: [otlp]
-          exporters: [logging]
+          exporters: [debug]
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,4 +20,4 @@ components_allowed: @@
         - memory_limiter
         - batch
       exporters:
-        - logging
+        - debug