Skip to content

Commit

Permalink
docs(troubleshooting): put newer versions first (#5987)
Browse files Browse the repository at this point in the history
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.

Co-authored-by: Juraci Paixão Kröhling <[email protected]>
  • Loading branch information
andrzej-stencel and jpkrohling authored Aug 29, 2022
1 parent a3c63bb commit 3085e10
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <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
Expand All @@ -53,6 +47,14 @@ service:
address: ":8888"
```

#### Version 0.42.0 and below:

Pass `--metrics-addr <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).
Expand Down

0 comments on commit 3085e10

Please sign in to comment.