| 1 | plugin_name: timex.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: timex.plugin |
| 5 | module_name: timex.plugin |
| 6 | monitored_instance: |
| 7 | name: Timex |
| 8 | link: "" |
| 9 | categories: |
| 10 | - data-collection.networking |
| 11 | icon_filename: "syslog.png" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: [] |
| 18 | overview: |
| 19 | data_collection: |
| 20 | metrics_description: "Examine Timex metrics to gain insights into system clock operations. Study time sync status, clock drift, and adjustments to ensure accurate system timekeeping." |
| 21 | method_description: "It uses system call adjtimex on Linux and ntp_adjtime on FreeBSD or Mac to monitor the system kernel clock synchronization state." |
| 22 | supported_platforms: |
| 23 | include: [] |
| 24 | exclude: [] |
| 25 | multi_instance: true |
| 26 | additional_permissions: |
| 27 | description: "" |
| 28 | default_behavior: |
| 29 | auto_detection: |
| 30 | description: "" |
| 31 | limits: |
| 32 | description: "" |
| 33 | performance_impact: |
| 34 | description: "" |
| 35 | setup: |
| 36 | prerequisites: |
| 37 | list: [] |
| 38 | configuration: |
| 39 | file: |
| 40 | name: "netdata.conf" |
| 41 | section_name: "[plugin:timex]" |
| 42 | description: "The netdata main configuration file." |
| 43 | options: |
| 44 | description: "At least one option ('clock synchronization state', 'time offset') needs to be enabled for this collector to run." |
| 45 | folding: |
| 46 | title: "Config options" |
| 47 | enabled: true |
| 48 | list: |
| 49 | - name: update every |
| 50 | description: Data collection frequency. |
| 51 | default_value: 1 |
| 52 | required: false |
| 53 | - name: clock synchronization state |
| 54 | description: Make chart showing system clock synchronization state. |
| 55 | default_value: yes |
| 56 | required: true |
| 57 | - name: time offset |
| 58 | description: Make chart showing computed time offset between local system and reference clock |
| 59 | default_value: yes |
| 60 | required: true |
| 61 | examples: |
| 62 | folding: |
| 63 | enabled: true |
| 64 | title: "Config" |
| 65 | list: |
| 66 | - name: Basic |
| 67 | description: A basic configuration example. |
| 68 | config: | |
| 69 | [plugin:timex] |
| 70 | update every = 1 |
| 71 | clock synchronization state = yes |
| 72 | time offset = yes |
| 73 | troubleshooting: |
| 74 | problems: |
| 75 | list: [] |
| 76 | alerts: |
| 77 | - name: system_clock_sync_state |
| 78 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/timex.conf |
| 79 | metric: system.clock_sync_state |
| 80 | info: when set to 0, the system kernel believes the system clock is not properly synchronized to a reliable server |
| 81 | os: "linux" |
| 82 | metrics: |
| 83 | folding: |
| 84 | title: Metrics |
| 85 | enabled: false |
| 86 | description: "" |
| 87 | availability: [] |
| 88 | scopes: |
| 89 | - name: global |
| 90 | description: "These metrics refer to the entire monitored application." |
| 91 | labels: [] |
| 92 | metrics: |
| 93 | - name: system.clock_sync_state |
| 94 | description: System Clock Synchronization State |
| 95 | unit: "state" |
| 96 | chart_type: line |
| 97 | dimensions: |
| 98 | - name: state |
| 99 | - name: system.clock_status |
| 100 | description: System Clock Status |
| 101 | unit: "status" |
| 102 | chart_type: line |
| 103 | dimensions: |
| 104 | - name: unsync |
| 105 | - name: clockerr |
| 106 | - name: system.clock_sync_offset |
| 107 | description: Computed Time Offset Between Local System and Reference Clock |
| 108 | unit: "milliseconds" |
| 109 | chart_type: line |
| 110 | dimensions: |
| 111 | - name: offset |