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