Skip to content

Commit

Permalink
Add tab for NTP containerized config (DataDog#19072)
Browse files Browse the repository at this point in the history
  • Loading branch information
janine-c authored Nov 18, 2024
1 parent 6daceec commit 48e66a3
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions ntp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,37 @@ The NTP check is included in the [Datadog Agent][1] package, so you don't need t

### Configuration

<!-- xxx tabs xxx -->
<!-- xxx tab "Host" xxx -->

#### Host

The Agent enables the NTP check by default. To configure the check yourself, edit the file `ntp.d/conf.yaml` in the `conf.d/` folder at the root of your [Agent's configuration directory][2]. See the [sample ntp.d/conf.yaml][3] for all available configuration options.

Outgoing UDP traffic over the port `123` should be allowed so the Agent can confirm that the local server time is reasonably accurate according to the Datadog NTP servers.

**Note**: If you edit the Datadog-NTP check configuration file, [restart the Agent][4] to effect any configuration changes.

<!-- xxz tab xxx -->

<!-- xxx tab "Containerized" xxx -->

#### Containerized

For containerized environments, see the documentation concerning [Autodiscovery configurations][9] for guidance on applying the parameters below. See the sample [ntp.d/conf.yaml][10] for all available configuration options.

##### Metric collection

| Parameter | Value |
|----------------------|------------------------------|
| `<INTEGRATION_NAME>` | `["ntp"]` |
| `<INIT_CONFIG>` | `[{}]` |
| `<INSTANCE_CONFIG>` | `[{"host": "<NTP_SERVER>"}]` |

<!-- xxz tab xxx -->

<!-- xxz tabs xxx -->

### Validation

[Run the Agent's `status` subcommand][5] and look for `ntp` under the Checks section.
Expand Down Expand Up @@ -62,3 +87,5 @@ Need help? Contact [Datadog support][8].
[6]: https://github.com/DataDog/integrations-core/blob/master/ntp/metadata.csv
[7]: https://github.com/DataDog/integrations-core/blob/master/ntp/assets/service_checks.json
[8]: https://docs.datadoghq.com/help/
[9]: https://docs.datadoghq.com/containers/kubernetes/integrations/?tab=annotations#configuration
[10]: https://github.com/DataDog/datadog-agent/blob/main/cmd/agent/dist/conf.d/ntp.d/conf.yaml.default

0 comments on commit 48e66a3

Please sign in to comment.