@@ -23,27 +23,31 @@ CollectdClient = enabled
2323| Path / Section | Description |
2424| -----------------------------------------------------------------| ---------------------------|
2525| [ /settings/collectd/client] ( #collectd-client-section ) | COLLECTD CLIENT SECTION |
26+ | [ /settings/collectd/client/metrics] ( #metric-mappings ) | METRIC MAPPINGS |
2627| [ /settings/collectd/client/targets] ( #remote-target-definitions ) | REMOTE TARGET DEFINITIONS |
28+ | [ /settings/collectd/client/variables] ( #variable-definitions ) | VARIABLE DEFINITIONS |
2729
2830
2931
3032### COLLECTD CLIENT SECTION <a id =" /settings/collectd/client " ></a >
3133
32- Section for NSCA passive check module .
34+ Section for the collectd client; forwards NSClient++ metrics to a collectd server .
3335
3436
3537
3638
37- | Key | Default Value | Description |
38- | -----------------------| ---------------| -------------|
39- | [ hostname] ( #hostname ) | auto | HOSTNAME |
39+ | Key | Default Value | Description |
40+ | -------------------------------| ---------------| ------------------|
41+ | [ hostname] ( #hostname ) | auto | HOSTNAME |
42+ | [ interval] ( #metrics-interval ) | 10 | METRICS INTERVAL |
4043
4144
4245
4346``` ini
44- # Section for NSCA passive check module .
47+ # Section for the collectd client; forwards NSClient++ metrics to a collectd server .
4548[/settings/collectd/client]
4649hostname =auto
50+ interval =10
4751
4852```
4953
@@ -53,13 +57,12 @@ hostname=auto
5357
5458#### HOSTNAME <a id =" /settings/collectd/client/hostname " ></a >
5559
56- The host name of the monitored computer .
57- Set this to auto (default) to use the windows name of the computer.
60+ The host name reported to collectd .
61+ Set this to auto (default) to use the name of this computer.
5862
5963auto Hostname
6064${host} Hostname
61- ${host_lc}
62- Hostname in lowercase
65+ ${host_lc} Hostname in lowercase
6366${host_uc} Hostname in uppercase
6467${domain} Domainname
6568${domain_lc} Domainname in lowercase
@@ -86,6 +89,50 @@ hostname=auto
8689```
8790
8891
92+
93+ #### METRICS INTERVAL <a id =" /settings/collectd/client/interval " ></a >
94+
95+ The interval (in seconds) reported to collectd. Should match the core 'metrics interval' so collectd computes rates correctly.
96+
97+
98+
99+
100+
101+ | Key | Description |
102+ | ----------------| ---------------------------------------------------------|
103+ | Path: | [ /settings/collectd/client] ( #/settings/collectd/client ) |
104+ | Key: | interval |
105+ | Default value: | ` 10 ` |
106+
107+
108+ ** Sample:**
109+
110+ ```
111+ [/settings/collectd/client]
112+ # METRICS INTERVAL
113+ interval=10
114+ ```
115+
116+
117+ ### METRIC MAPPINGS <a id =" /settings/collectd/client/metrics " ></a >
118+
119+ Mapping of collectd keys (e.g. cpu-total/cpu-user) to value expressions (e.g. derive: system .cpu.total.user). When empty a built-in default set is used.
120+
121+
122+
123+
124+
125+
126+
127+ ``` ini
128+ # Mapping of collectd keys (e.g. cpu-total/cpu-user) to value expressions (e.g. derive:system.cpu.total.user). When empty a built-in default set is used.
129+ [/settings/collectd/client/metrics]
130+
131+ ```
132+
133+
134+
135+
89136### REMOTE TARGET DEFINITIONS <a id =" /settings/collectd/client/targets " ></a >
90137
91138
@@ -97,13 +144,14 @@ This is a section of objects. This means that you will create objects below this
97144** Keys:**
98145
99146
100- | Key | Default Value | Description |
101- | ---------| ---------------| ----------------|
102- | address | | TARGET ADDRESS |
103- | host | | TARGET HOST |
104- | port | | TARGET PORT |
105- | retries | 3 | RETRIES |
106- | timeout | 30 | TIMEOUT |
147+ | Key | Default Value | Description |
148+ | ----------| ---------------| ------------------|
149+ | address | | TARGET ADDRESS |
150+ | host | | TARGET HOST |
151+ | interval | | METRICS INTERVAL |
152+ | port | | TARGET PORT |
153+ | retries | 3 | RETRIES |
154+ | timeout | 30 | TIMEOUT |
107155
108156
109157** Sample:**
@@ -113,6 +161,7 @@ This is a section of objects. This means that you will create objects below this
113161[/settings/collectd/client/targets/sample]
114162# address=...
115163# host=...
164+ # interval=...
116165# port=...
117166retries =3
118167timeout =30
@@ -124,3 +173,22 @@ timeout=30
124173
125174
126175
176+ ### VARIABLE DEFINITIONS <a id =" /settings/collectd/client/variables " ></a >
177+
178+ Variables used to expand ${...} placeholders in metric keys. Each value is a regular expression matched against metric names; the captured groups become the variable's values. When empty a built-in default set is used.
179+
180+
181+
182+
183+
184+
185+
186+ ``` ini
187+ # Variables used to expand ${...} placeholders in metric keys. Each value is a regular expression matched against metric names; the captured groups become the variable's values. When empty a built-in default set is used.
188+ [/settings/collectd/client/variables]
189+
190+ ```
191+
192+
193+
194+
0 commit comments