From fb96034a6c31edfcb9dca8acb44b4942132c8361 Mon Sep 17 00:00:00 2001 From: Andrzej Stencel Date: Mon, 29 Aug 2022 09:36:05 +0200 Subject: [PATCH] docs(troubleshooting): put newer versions first Reordering config instructions so that newer versions are put first and older versions later. With time, the users will be less and less interested in configuration for older versions. --- docs/troubleshooting.md | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 1a63eec7ee5..bfeb7eec97f 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -11,14 +11,8 @@ Logs can be helpful in identifying issues. Always start by checking the log output and looking for potential issues. The verbosity level defaults to `INFO` and can be adjusted. -#### Version 0.35 and below: -Pass `--log-level` flag to the `otelcol` process. See `--help` for more details. - -```console -$ otelcol --log-level DEBUG -``` - #### Version 0.36 and above: + Set the log level in the config `service::telemetry::logs` ```yaml @@ -28,22 +22,22 @@ service: level: "debug" ``` +#### Version 0.35 and below: + +Pass `--log-level` flag to the `otelcol` process. See `--help` for more details. + +```console +$ otelcol --log-level DEBUG +``` + ### Metrics Prometheus metrics are exposed locally on port `8888` and path `/metrics`. For containerized environments it may be desirable to expose this port on a public interface instead of just locally. -#### Version 0.42.0 and below: - -Pass `--metrics-addr ` flag to the `otelcol` process. See `--help` for -more details. - -```console -$ otelcol --metrics-addr 0.0.0.0:8888 -``` - #### Version 0.43.0 and above: + Set the address in the config `service::telemetry::metrics` ```yaml @@ -53,6 +47,14 @@ service: address: ":8888" ``` +#### Version 0.42.0 and below: + +Pass `--metrics-addr ` flag to the `otelcol` process. See `--help` for +more details. + +```console +$ otelcol --metrics-addr 0.0.0.0:8888 +``` A grafana dashboard for these metrics can be found [here](https://grafana.com/grafana/dashboards/11575).