Skip to content

Commit

Permalink
[docs] Update troubleshooting arguments (#4926)
Browse files Browse the repository at this point in the history
* [docs] Update troubleshooting arguments

Update troubleshooting to use correct command line option to change metrics address

* update doc with before/after config
  • Loading branch information
Alex Boten authored Mar 16, 2022
1 parent b8d86ac commit e214f71
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,30 @@ service:
### Metrics
Prometheus metrics are exposed locally on port `8888` and path `/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.

For containerized environments it may be desirable to expose this port on a
public interface instead of just locally. The metrics address can be configured
by passing the `--metrics-addr` flag to the `otelcol` process. See `--help` for
#### Version 0.42.0 and below:

Pass `--metrics-addr <ADDR>` flag to the `otelcol` process. See `--help` for
more details.

```bash
$ otelcol --metrics-addr 0.0.0.0:8888
```

#### Version 0.43.0 and above:
Set the address in the config `service::telemetry::metrics`

```yaml
service:
telemetry:
metrics:
address: ":8888"
```


A grafana dashboard for these metrics can be found
[here](https://grafana.com/grafana/dashboards/11575).

Expand Down

0 comments on commit e214f71

Please sign in to comment.