Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update charts to use debug exporter #892

Merged
merged 6 commits into from
Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions charts/opentelemetry-collector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Some care must be taken when using `hostNetwork: true`, as then OpenTelemetry Co
### Default configuration

By default this chart will deploy an OpenTelemetry Collector with three pipelines (logs, metrics and traces)
and logging exporter enabled by default. The collector can be installed either as daemonset (agent), deployment or stateful set.
and debug exporter enabled by default. The collector can be installed either as daemonset (agent), deployment or stateful set.

*Example*: Install collector as a deployment.

Expand Down Expand Up @@ -106,19 +106,19 @@ to read the files where Kubernetes container runtime writes all containers' cons

#### :warning: Warning: Risk of looping the exported logs back into the receiver, causing "log explosion"

The container logs pipeline uses the `logging` console exporter by default.
The container logs pipeline uses the `debug` exporter by default.
Paired with the default `filelog` receiver that receives all containers' console output,
it is easy to accidentally feed the exported logs back into the receiver.

Also note that using the `--log-level=debug` option for the `logging` exporter causes it to output
Also note that using the `--verbosity=detailed` option for the `debug` exporter causes it to output
multiple lines per single received log, which when looped, would amplify the logs exponentially.

To prevent the looping, the default configuration of the receiver excludes logs from the collector's containers.

If you want to include the collector's logs, make sure to replace the `logging` exporter
If you want to include the collector's logs, make sure to replace the `debug` exporter
with an exporter that does not send logs to collector's standard output.

Here's an example `values.yaml` file that replaces the default `logging` exporter on the `logs` pipeline
Here's an example `values.yaml` file that replaces the default `debug` exporter on the `logs` pipeline
with an `otlphttp` exporter that sends the container logs to `https://example.com:55681` endpoint.
It also clears the `filelog` receiver's `exclude` property, for collector logs to be included in the pipeline.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ config:
logs:
exporters:
- otlp
- logging
- debug
metrics:
exporters:
- otlp
- logging
- debug
traces:
exporters:
- otlp
- logging
- debug

resources:
limits:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
otlp:
endpoint: example-opentelemetry-collector:4317
tls:
Expand Down Expand Up @@ -62,7 +62,7 @@ data:
logs:
exporters:
- otlp
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -71,7 +71,7 @@ data:
metrics:
exporters:
- otlp
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -81,7 +81,7 @@ data:
traces:
exporters:
- otlp
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
extensions:
health_check: {}
memory_ballast:
Expand Down Expand Up @@ -57,15 +57,15 @@ data:
pipelines:
logs:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
receivers:
- otlp
metrics:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -74,7 +74,7 @@ data:
- prometheus
traces:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: f3c2b6098adf53d94516b61468663fa75cf32b764c6bfb0f92bdb1b6acfd246b
checksum/config: aab63aa5c9d1794b83d753abbfe2ce64c179956a32b3ef8c4a158d39303f44d8

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ spec:
template:
metadata:
annotations:
checksum/config: 641f210a491badf97b9a9fee08b8ae4e8f09363c42ab50230cb0083146ae047a
checksum/config: 655ab2734a98137bae15348977ed6d27fa415f75ff937459d560c42104260232

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
extensions:
health_check: {}
memory_ballast:
Expand Down Expand Up @@ -134,7 +134,7 @@ data:
pipelines:
logs:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -143,7 +143,7 @@ data:
- filelog
metrics:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -152,7 +152,7 @@ data:
- prometheus
traces:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: d20c2b586d8cdad2c624d5405a136593cf80b577435599d4f4f946168f266f8c
checksum/config: 2a2b0690f3bca40323fdc9f3aa72751984c6ae2e6c32cf553537c1ed6c93c5b0

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
extensions:
health_check: {}
memory_ballast:
Expand Down Expand Up @@ -103,15 +103,15 @@ data:
pipelines:
logs:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
receivers:
- otlp
metrics:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -121,7 +121,7 @@ data:
- hostmetrics
traces:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: cd16046cbf7e7c6455264c828bb2a1c214e0d7be6e7cde4849382b4ab6003453
checksum/config: 2f3c851c205d540d35a82e088e4f001adc7981465416da6e3af902c68f4b9b85

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
extensions:
health_check: {}
memory_ballast:
Expand Down Expand Up @@ -57,15 +57,15 @@ data:
pipelines:
logs:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
receivers:
- otlp
metrics:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -74,7 +74,7 @@ data:
- prometheus
traces:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: ebd1b337cf490fdac9de4e29f3a459d6bd7ce8c74b0d7fdb9aba9b8bff5737e3
checksum/config: 7f6aafef9c6543a07e51beadfc24556dad6608db892cd9dcf51964b279df1b86

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
extensions:
health_check: {}
memory_ballast:
Expand Down Expand Up @@ -57,15 +57,15 @@ data:
pipelines:
logs:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
receivers:
- otlp
metrics:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -74,7 +74,7 @@ data:
- prometheus
traces:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: ebd1b337cf490fdac9de4e29f3a459d6bd7ce8c74b0d7fdb9aba9b8bff5737e3
checksum/config: 7f6aafef9c6543a07e51beadfc24556dad6608db892cd9dcf51964b279df1b86

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
extensions:
health_check: {}
memory_ballast:
Expand Down Expand Up @@ -57,15 +57,15 @@ data:
pipelines:
logs:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
receivers:
- otlp
metrics:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand All @@ -74,7 +74,7 @@ data:
- prometheus
traces:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ spec:
template:
metadata:
annotations:
checksum/config: 641f210a491badf97b9a9fee08b8ae4e8f09363c42ab50230cb0083146ae047a
checksum/config: 655ab2734a98137bae15348977ed6d27fa415f75ff937459d560c42104260232

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ metadata:
data:
relay: |
exporters:
logging: {}
debug: {}
extensions:
health_check: {}
memory_ballast:
Expand All @@ -39,7 +39,7 @@ data:
pipelines:
traces:
exporters:
- logging
- debug
processors:
- memory_limiter
- batch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ spec:
template:
metadata:
annotations:
checksum/config: 4227386615dc838785474470155bbc2cd9ba29ff55fafb08eaaf79d08d1e2766
checksum/config: b35d16114a2a3c94b9d39c5ec8b06c4dbc84d21578c8f7b70ca39ef21c3fe8f0

labels:
app.kubernetes.io/name: opentelemetry-collector
Expand Down
Loading
Loading