Skip to content

Commit

Permalink
[chore][receiver/chrony] Fix readme config references (open-telemetry…
Browse files Browse the repository at this point in the history
…#34846)

The README is referencing a config option as `address`, but it's
actually `endpoint`. This incorrect reference was introduced in the
[original PR introducing this
component](open-telemetry#12101).

Fixes open-telemetry#34839
  • Loading branch information
crobert-1 authored Aug 28, 2024
1 parent 1875c58 commit 8bb1fe4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions receiver/chronyreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ By default, the `chrony` receiver will default to the following configuration:

```yaml
chrony/defaults:
address: unix:///var/run/chrony/chronyd.sock # The default port by chronyd to allow cmd access
endpoint: unix:///var/run/chrony/chronyd.sock # The default port by chronyd to allow cmd access
timeout: 10s # Allowing at least 10s for chronyd to respond before giving up

chrony:
Expand All @@ -36,7 +36,7 @@ chrony:

The following options can be customised:

- address (required) - the address on where to communicate to `chronyd`
- endpoint (required) - the address on where to communicate to `chronyd`
- The allowed formats are the following
- udp://hostname:port
- unix:///path/to/chrony.sock (Please note the triple slash)
Expand All @@ -55,7 +55,7 @@ An example of the configuration is:
```yaml
receivers:
chrony:
address: unix:///var/run/chrony/chronyd.sock
endpoint: unix:///var/run/chrony/chronyd.sock
timeout: 10s
collection_interval: 30s
metrics:
Expand Down

0 comments on commit 8bb1fe4

Please sign in to comment.