github.com/netdata/go.d.plugin@v0.58.1/modules/chrony/integrations/chrony.md (about)

     1  <!--startmeta
     2  custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/chrony/README.md"
     3  meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/chrony/metadata.yaml"
     4  sidebar_label: "Chrony"
     5  learn_status: "Published"
     6  learn_rel_path: "Data Collection/System Clock and NTP"
     7  most_popular: False
     8  message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
     9  endmeta-->
    10  
    11  # Chrony
    12  
    13  
    14  <img src="https://netdata.cloud/img/chrony.jpg" width="150"/>
    15  
    16  
    17  Plugin: go.d.plugin
    18  Module: chrony
    19  
    20  <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
    21  
    22  ## Overview
    23  
    24  This collector monitors the system's clock performance and peers activity status
    25  
    26  It collects metrics by sending UDP packets to chronyd using the Chrony communication protocol v6.
    27  
    28  This collector is supported on all platforms.
    29  
    30  This collector supports collecting metrics from multiple instances of this integration, including remote instances.
    31  
    32  
    33  ### Default Behavior
    34  
    35  #### Auto-Detection
    36  
    37  This collector discovers Chrony instance running on the local host and listening on port 323.
    38  On startup, it tries to collect metrics from:
    39  
    40  - 127.0.0.1:323
    41  
    42  
    43  #### Limits
    44  
    45  The default configuration for this integration does not impose any limits on data collection.
    46  
    47  #### Performance Impact
    48  
    49  The default configuration for this integration is not expected to impose a significant performance impact on the system.
    50  
    51  
    52  ## Metrics
    53  
    54  Metrics grouped by *scope*.
    55  
    56  The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
    57  
    58  
    59  
    60  ### Per Chrony instance
    61  
    62  These metrics refer to the entire monitored application.
    63  
    64  This scope has no labels.
    65  
    66  Metrics:
    67  
    68  | Metric | Dimensions | Unit |
    69  |:------|:----------|:----|
    70  | chrony.stratum | stratum | level |
    71  | chrony.current_correction | current_correction | seconds |
    72  | chrony.root_delay | root_delay | seconds |
    73  | chrony.root_dispersion | root_delay | seconds |
    74  | chrony.last_offset | offset | seconds |
    75  | chrony.rms_offset | offset | seconds |
    76  | chrony.frequency | frequency | ppm |
    77  | chrony.residual_frequency | residual_frequency | ppm |
    78  | chrony.skew | skew | ppm |
    79  | chrony.update_interval | update_interval | seconds |
    80  | chrony.ref_measurement_time | ref_measurement_time | seconds |
    81  | chrony.leap_status | normal, insert_second, delete_second, unsynchronised | status |
    82  | chrony.activity | online, offline, burst_online, burst_offline, unresolved | sources |
    83  
    84  
    85  
    86  ## Alerts
    87  
    88  There are no alerts configured by default for this integration.
    89  
    90  
    91  ## Setup
    92  
    93  ### Prerequisites
    94  
    95  No action required.
    96  
    97  ### Configuration
    98  
    99  #### File
   100  
   101  The configuration file name for this integration is `go.d/chrony.conf`.
   102  
   103  
   104  You can edit the configuration file using the `edit-config` script from the
   105  Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
   106  
   107  ```bash
   108  cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
   109  sudo ./edit-config go.d/chrony.conf
   110  ```
   111  #### Options
   112  
   113  The following options can be defined globally: update_every, autodetection_retry.
   114  
   115  
   116  <details><summary>Config options</summary>
   117  
   118  | Name | Description | Default | Required |
   119  |:----|:-----------|:-------|:--------:|
   120  | update_every | Data collection frequency. | 5 | no |
   121  | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
   122  | address | Server address. The format is IP:PORT. | 127.0.0.1:323 | yes |
   123  | timeout | Connection timeout. Zero means no timeout. | 1 | no |
   124  
   125  </details>
   126  
   127  #### Examples
   128  
   129  ##### Basic
   130  
   131  A basic example configuration.
   132  
   133  ```yaml
   134  jobs:
   135    - name: local
   136      address: 127.0.0.1:323
   137  
   138  ```
   139  ##### Multi-instance
   140  
   141  > **Note**: When you define multiple jobs, their names must be unique.
   142  
   143  Collecting metrics from local and remote instances.
   144  
   145  
   146  <details><summary>Config</summary>
   147  
   148  ```yaml
   149  jobs:
   150    - name: local
   151      address: 127.0.0.1:323
   152  
   153    - name: remote
   154      address: 192.0.2.1:323
   155  
   156  ```
   157  </details>
   158  
   159  
   160  
   161  ## Troubleshooting
   162  
   163  ### Debug Mode
   164  
   165  To troubleshoot issues with the `chrony` collector, run the `go.d.plugin` with the debug option enabled. The output
   166  should give you clues as to why the collector isn't working.
   167  
   168  - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
   169    your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
   170  
   171    ```bash
   172    cd /usr/libexec/netdata/plugins.d/
   173    ```
   174  
   175  - Switch to the `netdata` user.
   176  
   177    ```bash
   178    sudo -u netdata -s
   179    ```
   180  
   181  - Run the `go.d.plugin` to debug the collector:
   182  
   183    ```bash
   184    ./go.d.plugin -d -m chrony
   185    ```
   186  
   187