| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-chrony |
| 5 | module_name: chrony |
| 6 | plugin_name: go.d.plugin |
| 7 | monitored_instance: |
| 8 | categories: |
| 9 | - data-collection.networking |
| 10 | icon_filename: chrony.jpg |
| 11 | name: Chrony |
| 12 | link: https://chrony.tuxfamily.org/ |
| 13 | alternative_monitored_instances: [] |
| 14 | keywords: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: [] |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This collector monitors the system's clock performance and peers activity status |
| 24 | method_description: | |
| 25 | It collects metrics by sending UDP packets to chronyd using the Chrony communication protocol v6. |
| 26 | Additionally, for data collection jobs that connect to localhost Chrony instances, it collects serverstats metrics (NTP packets, command packets received/dropped) by executing the 'chronyc serverstats' command. |
| 27 | supported_platforms: |
| 28 | include: [] |
| 29 | exclude: [] |
| 30 | multi_instance: true |
| 31 | additional_permissions: |
| 32 | description: "" |
| 33 | default_behavior: |
| 34 | auto_detection: |
| 35 | description: | |
| 36 | This collector discovers Chrony instance running on the local host and listening on port 323. |
| 37 | On startup, it tries to collect metrics from: |
| 38 | |
| 39 | - 127.0.0.1:323 |
| 40 | limits: |
| 41 | description: "" |
| 42 | performance_impact: |
| 43 | description: "" |
| 44 | setup: |
| 45 | prerequisites: |
| 46 | list: [] |
| 47 | configuration: |
| 48 | file: |
| 49 | name: go.d/chrony.conf |
| 50 | options: |
| 51 | description: | |
| 52 | The following options can be defined globally: update_every, autodetection_retry. |
| 53 | folding: |
| 54 | title: Config options |
| 55 | enabled: true |
| 56 | list: |
| 57 | - name: update_every |
| 58 | description: Data collection interval (seconds). |
| 59 | default_value: 5 |
| 60 | required: false |
| 61 | group: Collection |
| 62 | - name: autodetection_retry |
| 63 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 64 | default_value: 0 |
| 65 | required: false |
| 66 | group: Collection |
| 67 | |
| 68 | - name: address |
| 69 | description: Chrony server address (`IP:PORT`). |
| 70 | default_value: 127.0.0.1:323 |
| 71 | required: true |
| 72 | group: Target |
| 73 | - name: timeout |
| 74 | description: Connection timeout (seconds). Set 0 to disable. |
| 75 | default_value: 1 |
| 76 | required: false |
| 77 | group: Target |
| 78 | |
| 79 | - name: vnode |
| 80 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 81 | default_value: "" |
| 82 | required: false |
| 83 | group: Virtual Node |
| 84 | examples: |
| 85 | folding: |
| 86 | title: Config |
| 87 | enabled: true |
| 88 | list: |
| 89 | - name: Basic |
| 90 | folding: |
| 91 | enabled: false |
| 92 | description: A basic example configuration. |
| 93 | config: | |
| 94 | jobs: |
| 95 | - name: local |
| 96 | address: 127.0.0.1:323 |
| 97 | - name: Multi-instance |
| 98 | description: | |
| 99 | > **Note**: When you define multiple jobs, their names must be unique. |
| 100 | |
| 101 | Collecting metrics from local and remote instances. |
| 102 | config: | |
| 103 | jobs: |
| 104 | - name: local |
| 105 | address: 127.0.0.1:323 |
| 106 | |
| 107 | - name: remote |
| 108 | address: 192.0.2.1:323 |
| 109 | troubleshooting: |
| 110 | problems: |
| 111 | list: [] |
| 112 | alerts: [] |
| 113 | metrics: |
| 114 | folding: |
| 115 | title: Metrics |
| 116 | enabled: false |
| 117 | description: "" |
| 118 | availability: [] |
| 119 | scopes: |
| 120 | - name: global |
| 121 | description: These metrics refer to the entire monitored application. |
| 122 | labels: [] |
| 123 | metrics: |
| 124 | - name: chrony.stratum |
| 125 | availability: [] |
| 126 | description: Distance to the reference clock |
| 127 | unit: level |
| 128 | chart_type: line |
| 129 | dimensions: |
| 130 | - name: stratum |
| 131 | - name: chrony.current_correction |
| 132 | availability: [] |
| 133 | description: Current correction |
| 134 | unit: seconds |
| 135 | chart_type: line |
| 136 | dimensions: |
| 137 | - name: current_correction |
| 138 | - name: chrony.root_delay |
| 139 | availability: [] |
| 140 | description: Network path delay to stratum-1 |
| 141 | unit: seconds |
| 142 | chart_type: line |
| 143 | dimensions: |
| 144 | - name: root_delay |
| 145 | - name: chrony.root_dispersion |
| 146 | availability: [] |
| 147 | description: Dispersion accumulated back to stratum-1 |
| 148 | unit: seconds |
| 149 | chart_type: line |
| 150 | dimensions: |
| 151 | - name: root_delay |
| 152 | - name: chrony.last_offset |
| 153 | availability: [] |
| 154 | description: Offset on the last clock update |
| 155 | unit: seconds |
| 156 | chart_type: line |
| 157 | dimensions: |
| 158 | - name: offset |
| 159 | - name: chrony.rms_offset |
| 160 | availability: [] |
| 161 | description: Long-term average of the offset value |
| 162 | unit: seconds |
| 163 | chart_type: line |
| 164 | dimensions: |
| 165 | - name: offset |
| 166 | - name: chrony.frequency |
| 167 | availability: [] |
| 168 | description: Frequency |
| 169 | unit: ppm |
| 170 | chart_type: line |
| 171 | dimensions: |
| 172 | - name: frequency |
| 173 | - name: chrony.residual_frequency |
| 174 | availability: [] |
| 175 | description: Residual frequency |
| 176 | unit: ppm |
| 177 | chart_type: line |
| 178 | dimensions: |
| 179 | - name: residual_frequency |
| 180 | - name: chrony.skew |
| 181 | availability: [] |
| 182 | description: Skew |
| 183 | unit: ppm |
| 184 | chart_type: line |
| 185 | dimensions: |
| 186 | - name: skew |
| 187 | - name: chrony.update_interval |
| 188 | availability: [] |
| 189 | description: Interval between the last two clock updates |
| 190 | unit: seconds |
| 191 | chart_type: line |
| 192 | dimensions: |
| 193 | - name: update_interval |
| 194 | - name: chrony.ref_measurement_time |
| 195 | availability: [] |
| 196 | description: Time since the last measurement |
| 197 | unit: seconds |
| 198 | chart_type: line |
| 199 | dimensions: |
| 200 | - name: ref_measurement_time |
| 201 | - name: chrony.leap_status |
| 202 | availability: [] |
| 203 | description: Leap status |
| 204 | unit: status |
| 205 | chart_type: line |
| 206 | dimensions: |
| 207 | - name: normal |
| 208 | - name: insert_second |
| 209 | - name: delete_second |
| 210 | - name: unsynchronised |
| 211 | - name: chrony.activity |
| 212 | availability: [] |
| 213 | description: Peers activity |
| 214 | unit: sources |
| 215 | chart_type: stacked |
| 216 | dimensions: |
| 217 | - name: online |
| 218 | - name: offline |
| 219 | - name: burst_online |
| 220 | - name: burst_offline |
| 221 | - name: unresolved |
| 222 | - name: chrony.ntp_packets |
| 223 | availability: [] |
| 224 | description: NTP packets |
| 225 | unit: packets/s |
| 226 | chart_type: line |
| 227 | dimensions: |
| 228 | - name: received |
| 229 | - name: dropped |
| 230 | - name: chrony.command_packets |
| 231 | availability: [] |
| 232 | description: Command packets |
| 233 | unit: packets/s |
| 234 | chart_type: line |
| 235 | dimensions: |
| 236 | - name: received |
| 237 | - name: dropped |