open-telemetry
/
opentelemetry-collector
mirror of https://github.com/open-telemetry/opentelemetry-collector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[docs] Update troubleshooting arguments (#4926) 

* [docs] Update troubleshooting arguments

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

* update doc with before/after config
This commit is contained in:
Alex Boten 2022-03-16 00:28:11 -07:00 committed by GitHub
parent b8d86acb4b
commit e214f7172b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/troubleshooting.md
View File

@ -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).