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

docs(troubleshooting): put newer versions first #5987

Merged
merged 2 commits into from
Aug 29, 2022
Merged
Changes from all 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
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