@cryptotaxi247 / netdata-1 / commits / c7b57a562

docs: add grouped headers to config options (#20987)

Ilya Mashchenko committed Sep 18, 2025 at 20:09 UTC c7b57a562a87533e7cf06d2c4c79b0f42e680489
97 files changed +4475 -1878
src/collectors/proc.plugin/metadata.yaml
+1 -1
@@ -173,7 +173,7 @@ modules:
173 dimensions:
174 - name: a dimension per cpu core
175 - name: cpu core
176 - description: Collects per-core CPU metrics. Disabled by default, can be enabled in the [configuration options](#configuration).
176 + description: Per-core CPU metrics. Disabled by default, can be enabled in the [configuration options](#configuration).
177 labels:
178 - name: cpu
179 description: Identifier of the CPU core (e.g., core0, core1, core2).
src/go/plugin/go.d/collector/activemq/metadata.yaml
+84 -37
@@ -58,91 +58,138 @@ modules:
58 enabled: true
59 list:
60 - name: update_every
61 - description: Data collection frequency.
61 + description: Data collection interval (seconds).
62 default_value: 1
63 required: false
64 + group: Collection
65 - name: autodetection_retry
65 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
66 + description: Autodetection retry interval (seconds). Set 0 to disable.
67 default_value: 0
68 required: false
69 + group: Collection
70 +
71 - name: url
69 - description: Server URL.
70 - default_value: http://localhost:8161
72 + description: Target endpoint URL.
73 + default_value: http://127.0.0.1:8161
74 required: true
75 + group: Target
76 + - name: timeout
77 + description: HTTP request timeout (seconds).
78 + default_value: 1
79 + required: false
80 + group: Target
81 - name: webadmin
82 description: Webadmin root path.
83 default_value: admin
84 required: true
85 + group: Target
86 +
87 - name: max_queues
77 - description: Maximum number of concurrently collected queues.
88 + description: Maximum number of queues to collect concurrently.
89 default_value: 50
90 required: false
91 + group: Limits
92 - name: max_topics
81 - description: Maximum number of concurrently collected topics.
93 + description: Maximum number of topics to collect concurrently.
94 default_value: 50
95 required: false
96 + group: Limits
97 +
98 - name: queues_filter
85 - description: |
86 - Queues filter. Syntax is [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns).
99 + description: Queue selector. Uses [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns).
100 default_value: ""
101 required: false
102 + group: Filters
103 - name: topics_filter
90 - description: |
91 - Topics filter. Syntax is [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns).
104 + description: Topic selector. Uses [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns).
105 default_value: ""
106 required: false
107 + group: Filters
108 +
109 - name: username
95 - description: Username for basic HTTP authentication.
110 + description: Username for Basic HTTP authentication.
111 default_value: ""
112 required: false
113 + group: HTTP Auth
114 - name: password
99 - description: Password for basic HTTP authentication.
115 + description: Password for Basic HTTP authentication.
116 + default_value: ""
117 + required: false
118 + group: HTTP Auth
119 + - name: bearer_token_file
120 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
121 + default_value: ""
122 + required: false
123 + group: HTTP Auth
124 +
125 + - name: tls_skip_verify
126 + description: Skip TLS certificate and hostname verification (insecure).
127 + default_value: no
128 + required: false
129 + group: TLS
130 + - name: tls_ca
131 + description: Path to CA bundle used to validate the server certificate.
132 default_value: ""
133 required: false
134 + group: TLS
135 + - name: tls_cert
136 + description: Path to client TLS certificate (for mTLS).
137 + default_value: ""
138 + required: false
139 + group: TLS
140 + - name: tls_key
141 + description: Path to client TLS private key (for mTLS).
142 + default_value: ""
143 + required: false
144 + group: TLS
145 +
146 + - name: proxy_url
147 + description: HTTP proxy URL.
148 + default_value: ""
149 + required: false
150 + group: Proxy
151 - name: proxy_username
103 - description: Username for proxy basic HTTP authentication.
152 + description: Username for proxy Basic HTTP authentication.
153 default_value: ""
154 required: false
155 + group: Proxy
156 - name: proxy_password
107 - description: Password for proxy basic HTTP authentication.
157 + description: Password for proxy Basic HTTP authentication.
158 default_value: ""
159 required: false
160 + group: Proxy
161 +
162 - name: method
111 - description: HTTP request method.
112 - default_value: GET
113 - required: false
114 - - name: timeout
115 - description: HTTP request timeout.
116 - default_value: 1
163 + description: HTTP method to use.
164 + default_value: "GET"
165 required: false
166 + group: Request
167 - name: body
119 - description: HTTP request body.
168 + description: Request body (e.g., for POST/PUT).
169 default_value: ""
170 required: false
171 + group: Request
172 - name: headers
123 - description: HTTP request headers.
173 + description: "Additional HTTP headers (one per line as key: value)."
174 default_value: ""
175 required: false
176 + group: Request
177 - name: not_follow_redirects
127 - description: Redirect handling policy. Controls whether the client follows redirects.
128 - default_value: false
178 + description: Do not follow HTTP redirects.
179 + default_value: no
180 required: false
130 - - name: tls_skip_verify
131 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
132 - default_value: false
181 + group: Request
182 + - name: force_http2
183 + description: Force HTTP/2 (including h2c over TCP).
184 + default_value: no
185 required: false
134 - - name: tls_ca
135 - description: Certification authority that the client uses when verifying the server's certificates.
136 - default_value: ""
137 - required: false
138 - - name: tls_cert
139 - description: Client TLS certificate.
140 - default_value: ""
141 - required: false
142 - - name: tls_key
143 - description: Client TLS key.
186 + group: Request
187 +
188 + - name: vnode
189 + 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).
190 default_value: ""
191 required: false
192 + group: Virtual Node
193 examples:
194 folding:
195 title: Config
src/go/plugin/go.d/collector/apache/metadata.yaml
+62 -28
@@ -68,77 +68,111 @@ modules:
68 enabled: true
69 list:
70 - name: update_every
71 - description: Data collection frequency.
71 + description: Data collection interval (seconds).
72 default_value: 1
73 required: false
74 + group: Collection
75 - name: autodetection_retry
75 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
76 + description: Autodetection retry interval (seconds). Set 0 to disable.
77 default_value: 0
78 required: false
79 + group: Collection
80 +
81 - name: url
79 - description: Server URL.
82 + description: Target endpoint URL.
83 default_value: http://127.0.0.1/server-status?auto
84 required: true
85 + group: Target
86 - name: timeout
83 - description: HTTP request timeout.
87 + description: HTTP request timeout (seconds).
88 default_value: 1
89 required: false
90 + group: Target
91 +
92 - name: username
87 - description: Username for basic HTTP authentication.
93 + description: Username for Basic HTTP authentication.
94 default_value: ""
95 required: false
96 + group: HTTP Auth
97 - name: password
91 - description: Password for basic HTTP authentication.
98 + description: Password for Basic HTTP authentication.
99 default_value: ""
100 required: false
101 + group: HTTP Auth
102 + - name: bearer_token_file
103 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
104 + default_value: ""
105 + required: false
106 + group: HTTP Auth
107 +
108 + - name: tls_skip_verify
109 + description: Skip TLS certificate and hostname verification (insecure).
110 + default_value: no
111 + required: false
112 + group: TLS
113 + - name: tls_ca
114 + description: Path to CA bundle used to validate the server certificate.
115 + default_value: ""
116 + required: false
117 + group: TLS
118 + - name: tls_cert
119 + description: Path to client TLS certificate (for mTLS).
120 + default_value: ""
121 + required: false
122 + group: TLS
123 + - name: tls_key
124 + description: Path to client TLS private key (for mTLS).
125 + default_value: ""
126 + required: false
127 + group: TLS
128 +
129 - name: proxy_url
95 - description: Proxy URL.
130 + description: HTTP proxy URL.
131 default_value: ""
132 required: false
133 + group: Proxy
134 - name: proxy_username
99 - description: Username for proxy basic HTTP authentication.
135 + description: Username for proxy Basic HTTP authentication.
136 default_value: ""
137 required: false
138 + group: Proxy
139 - name: proxy_password
103 - description: Password for proxy basic HTTP authentication.
140 + description: Password for proxy Basic HTTP authentication.
141 default_value: ""
142 required: false
143 + group: Proxy
144 +
145 - name: method
107 - description: HTTP request method.
146 + description: HTTP method to use.
147 default_value: "GET"
148 required: false
149 + group: Request
150 - name: body
111 - description: HTTP request body.
151 + description: Request body (e.g., for POST/PUT).
152 default_value: ""
153 required: false
154 + group: Request
155 - name: headers
115 - description: HTTP request headers.
156 + description: "Additional HTTP headers (one per line as key: value)."
157 default_value: ""
158 required: false
159 + group: Request
160 - name: not_follow_redirects
119 - description: Redirect handling policy. Controls whether the client follows redirects.
161 + description: Do not follow HTTP redirects.
162 default_value: no
163 required: false
164 + group: Request
165 - name: force_http2
123 - description: Forces the use of HTTP/2 protocol for all requests, even over plain TCP (h2c).
124 - default_value: no
125 - required: false
126 - - name: tls_skip_verify
127 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
166 + description: Force HTTP/2 (including h2c over TCP).
167 default_value: no
168 required: false
130 - - name: tls_ca
131 - description: Certification authority that the client uses when verifying the server's certificates.
132 - default_value: ""
133 - required: false
134 - - name: tls_cert
135 - description: Client TLS certificate.
136 - default_value: ""
137 - required: false
138 - - name: tls_key
139 - description: Client TLS key.
169 + group: Request
170 +
171 + - name: vnode
172 + 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).
173 default_value: ""
174 required: false
175 + group: Virtual Node
176 examples:
177 folding:
178 title: Config
src/go/plugin/go.d/collector/apcupsd/metadata.yaml
+15 -4
@@ -56,21 +56,32 @@ modules:
56 enabled: true
57 list:
58 - name: update_every
59 - description: Data collection frequency.
59 + description: Data collection interval (seconds).
60 default_value: 1
61 required: false
62 + group: Collection
63 - name: autodetection_retry
63 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
64 + description: Autodetection retry interval (seconds). Set 0 to disable.
65 default_value: 0
66 required: false
67 + group: Collection
68 +
69 - name: address
67 - description: Apcupsd daemon address in IP:PORT format.
70 + description: apcupsd daemon address (`IP:PORT`).
71 default_value: 127.0.0.1:3551
72 required: true
73 + group: Target
74 - name: timeout
71 - description: Connection/read/write timeout in seconds. The timeout includes name resolution, if required.
75 + description: Connection, read, write, and name resolution timeout (seconds).
76 default_value: 2
77 required: false
78 + group: Target
79 +
80 + - name: vnode
81 + 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).
82 + default_value: ""
83 + required: false
84 + group: Virtual Node
85 examples:
86 folding:
87 title: Config
src/go/plugin/go.d/collector/beanstalk/metadata.yaml
+18 -5
@@ -59,25 +59,38 @@ modules:
59 enabled: true
60 list:
61 - name: update_every
62 - description: Data collection frequency.
62 + description: Data collection interval (seconds).
63 default_value: 1
64 required: false
65 + group: Collection
66 - name: autodetection_retry
66 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
67 + description: Autodetection retry interval (seconds). Set 0 to disable.
68 default_value: 0
69 required: false
70 + group: Collection
71 +
72 - name: address
70 - description: The IP address and port where the Beanstalk service listens for connections.
73 + description: Beanstalk service address (`IP:PORT`).
74 default_value: 127.0.0.1:11300
75 required: true
76 + group: Target
77 - name: timeout
74 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
78 + description: Connection, read, write, and name resolution timeout (seconds).
79 default_value: 1
80 required: false
81 + group: Target
82 +
83 - name: tube_selector
78 - description: "Specifies a [pattern](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#readme) for which Beanstalk tubes Netdata will collect statistics."
84 + description: "Tube selector. Defines which Beanstalk tubes to monitor. Uses [simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#readme)."
85 default_value: "*"
86 required: false
87 + group: Filters
88 +
89 + - name: vnode
90 + 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).
91 + default_value: ""
92 + required: false
93 + group: Virtual Node
94 examples:
95 folding:
96 enabled: true
src/go/plugin/go.d/collector/cassandra/metadata.yaml
+75 -25
@@ -76,61 +76,111 @@ modules:
76 enabled: true
77 list:
78 - name: update_every
79 - description: Data collection frequency.
79 + description: Data collection interval (seconds).
80 default_value: 5
81 required: false
82 + group: Collection
83 - name: autodetection_retry
83 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
84 + description: Autodetection retry interval (seconds). Set 0 to disable.
85 default_value: 0
86 required: false
87 + group: Collection
88 +
89 - name: url
87 - description: Server URL.
90 + description: Target endpoint URL.
91 default_value: http://127.0.0.1:7072/metrics
92 required: true
93 + group: Target
94 + - name: timeout
95 + description: HTTP request timeout (seconds).
96 + default_value: 2
97 + required: false
98 + group: Target
99 +
100 - name: username
91 - description: Username for basic HTTP authentication.
101 + description: Username for Basic HTTP authentication.
102 default_value: ""
103 required: false
104 + group: HTTP Auth
105 - name: password
95 - description: Password for basic HTTP authentication.
106 + description: Password for Basic HTTP authentication.
107 + default_value: ""
108 + required: false
109 + group: HTTP Auth
110 + - name: bearer_token_file
111 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
112 + default_value: ""
113 + required: false
114 + group: HTTP Auth
115 +
116 + - name: tls_skip_verify
117 + description: Skip TLS certificate and hostname verification (insecure).
118 + default_value: no
119 + required: false
120 + group: TLS
121 + - name: tls_ca
122 + description: Path to CA bundle used to validate the server certificate.
123 + default_value: ""
124 + required: false
125 + group: TLS
126 + - name: tls_cert
127 + description: Path to client TLS certificate (for mTLS).
128 + default_value: ""
129 + required: false
130 + group: TLS
131 + - name: tls_key
132 + description: Path to client TLS private key (for mTLS).
133 default_value: ""
134 required: false
135 + group: TLS
136 +
137 - name: proxy_url
99 - description: Proxy URL.
138 + description: HTTP proxy URL.
139 default_value: ""
140 required: false
141 + group: Proxy
142 - name: proxy_username
103 - description: Username for proxy basic HTTP authentication.
143 + description: Username for proxy Basic HTTP authentication.
144 default_value: ""
145 required: false
146 + group: Proxy
147 - name: proxy_password
107 - description: Password for proxy basic HTTP authentication.
148 + description: Password for proxy Basic HTTP authentication.
149 default_value: ""
150 required: false
110 - - name: timeout
111 - description: HTTP request timeout.
112 - default_value: 2
113 - required: false
114 - - name: not_follow_redirects
115 - description: Redirect handling policy. Controls whether the client follows redirects.
116 - default_value: false
117 - required: false
118 - - name: tls_skip_verify
119 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
120 - default_value: false
151 + group: Proxy
152 +
153 + - name: method
154 + description: HTTP method to use.
155 + default_value: GET
156 required: false
122 - - name: tls_ca
123 - description: Certification authority that the client uses when verifying the server's certificates.
157 + group: Request
158 + - name: body
159 + description: Request body (e.g., for POST/PUT).
160 default_value: ""
161 required: false
126 - - name: tls_cert
127 - description: Client TLS certificate.
162 + group: Request
163 + - name: headers
164 + description: "Additional HTTP headers (one per line as key: value)."
165 default_value: ""
166 required: false
130 - - name: tls_key
131 - description: Client TLS key.
167 + group: Request
168 + - name: not_follow_redirects
169 + description: Do not follow HTTP redirects.
170 + default_value: no
171 + required: false
172 + group: Request
173 + - name: force_http2
174 + description: Force HTTP/2 (including h2c over TCP).
175 + default_value: no
176 + required: false
177 + group: Request
178 +
179 + - name: vnode
180 + 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).
181 default_value: ""
182 required: false
183 + group: Virtual Node
184 examples:
185 folding:
186 title: Config
src/go/plugin/go.d/collector/ceph/metadata.yaml
+64 -26
@@ -64,73 +64,111 @@ modules:
64 enabled: true
65 list:
66 - name: update_every
67 - description: Data collection frequency.
67 + description: Data collection interval (seconds).
68 default_value: 1
69 required: false
70 + group: Collection
71 - name: autodetection_retry
71 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
72 + description: Autodetection retry interval (seconds). Set 0 to disable.
73 default_value: 0
74 required: false
75 + group: Collection
76 +
77 - name: url
78 description: The URL of the [Ceph Manager API](https://docs.ceph.com/en/reef/mgr/ceph_api/).
79 default_value: https://127.0.0.1:8443
80 required: true
81 + group: Target
82 - name: timeout
79 - description: HTTP request timeout.
83 + description: HTTP request timeout (seconds).
84 default_value: 2
85 required: false
86 + group: Target
87 +
88 - name: username
83 - description: Username for basic HTTP authentication.
89 + description: Username for Basic HTTP authentication.
90 default_value: ""
91 required: true
92 + group: HTTP Auth
93 - name: password
87 - description: Password for basic HTTP authentication.
94 + description: Password for Basic HTTP authentication.
95 default_value: ""
96 required: true
97 + group: HTTP Auth
98 + - name: bearer_token_file
99 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
100 + default_value: ""
101 + required: false
102 + group: HTTP Auth
103 +
104 + - name: tls_skip_verify
105 + description: Skip TLS certificate and hostname verification (insecure).
106 + default_value: yes
107 + required: false
108 + group: TLS
109 + - name: tls_ca
110 + description: Path to CA bundle used to validate the server certificate.
111 + default_value: ""
112 + required: false
113 + group: TLS
114 + - name: tls_cert
115 + description: Path to client TLS certificate (for mTLS).
116 + default_value: ""
117 + required: false
118 + group: TLS
119 + - name: tls_key
120 + description: Path to client TLS private key (for mTLS).
121 + default_value: ""
122 + required: false
123 + group: TLS
124 +
125 - name: proxy_url
91 - description: Proxy URL.
126 + description: HTTP proxy URL.
127 default_value: ""
128 required: false
129 + group: Proxy
130 - name: proxy_username
95 - description: Username for proxy basic HTTP authentication.
131 + description: Username for proxy Basic HTTP authentication.
132 default_value: ""
133 required: false
134 + group: Proxy
135 - name: proxy_password
99 - description: Password for proxy basic HTTP authentication.
136 + description: Password for proxy Basic HTTP authentication.
137 default_value: ""
138 required: false
139 + group: Proxy
140 +
141 - name: method
103 - description: HTTP request method.
104 - default_value: "GET"
142 + description: HTTP method to use.
143 + default_value: GET
144 required: false
145 + group: Request
146 - name: body
107 - description: HTTP request body.
147 + description: Request body (e.g., for POST/PUT).
148 default_value: ""
149 required: false
150 + group: Request
151 - name: headers
111 - description: HTTP request headers.
152 + description: "Additional HTTP headers (one per line as key: value)."
153 default_value: ""
154 required: false
155 + group: Request
156 - name: not_follow_redirects
115 - description: Redirect handling policy. Controls whether the client follows redirects.
157 + description: Do not follow HTTP redirects.
158 default_value: no
159 required: false
118 - - name: tls_skip_verify
119 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
120 - default_value: yes
121 - required: false
122 - - name: tls_ca
123 - description: Certification authority that the client uses when verifying the server's certificates.
124 - default_value: ""
125 - required: false
126 - - name: tls_cert
127 - description: Client TLS certificate.
128 - default_value: ""
160 + group: Request
161 + - name: force_http2
162 + description: Force HTTP/2 (including h2c over TCP).
163 + default_value: no
164 required: false
130 - - name: tls_key
131 - description: Client TLS key.
165 + group: Request
166 +
167 + - name: vnode
168 + 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).
169 default_value: ""
170 required: false
171 + group: Virtual Node
172 examples:
173 folding:
174 title: ""
src/go/plugin/go.d/collector/chrony/metadata.yaml
+15 -4
@@ -56,21 +56,32 @@ modules:
56 enabled: true
57 list:
58 - name: update_every
59 - description: Data collection frequency.
59 + description: Data collection interval (seconds).
60 default_value: 5
61 required: false
62 + group: Collection
63 - name: autodetection_retry
63 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
64 + description: Autodetection retry interval (seconds). Set 0 to disable.
65 default_value: 0
66 required: false
67 + group: Collection
68 +
69 - name: address
67 - description: Server address. The format is IP:PORT.
70 + description: Chrony server address (`IP:PORT`).
71 default_value: 127.0.0.1:323
72 required: true
73 + group: Target
74 - name: timeout
71 - description: Connection timeout. Zero means no timeout.
75 + description: Connection timeout (seconds). Set 0 to disable.
76 default_value: 1
77 required: false
78 + group: Target
79 +
80 + - name: vnode
81 + 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).
82 + default_value: ""
83 + required: false
84 + group: Virtual Node
85 examples:
86 folding:
87 title: Config
src/go/plugin/go.d/collector/clickhouse/metadata.yaml
+63 -25
@@ -63,73 +63,111 @@ modules:
63 enabled: true
64 list:
65 - name: update_every
66 - description: Data collection frequency.
66 + description: Data collection interval (seconds).
67 default_value: 1
68 required: false
69 + group: Collection
70 - name: autodetection_retry
70 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
71 + description: Autodetection retry interval (seconds). Set 0 to disable.
72 default_value: 0
73 required: false
74 + group: Collection
75 +
76 - name: url
74 - description: Server URL.
77 + description: Target endpoint URL.
78 default_value: http://127.0.0.1:8123
79 required: true
80 + group: Target
81 - name: timeout
78 - description: HTTP request timeout.
82 + description: HTTP request timeout (seconds).
83 default_value: 1
84 required: false
85 + group: Target
86 +
87 - name: username
82 - description: Username for basic HTTP authentication.
88 + description: Username for Basic HTTP authentication.
89 default_value: ""
90 required: false
91 + group: HTTP Auth
92 - name: password
86 - description: Password for basic HTTP authentication.
93 + description: Password for Basic HTTP authentication.
94 + default_value: ""
95 + required: false
96 + group: HTTP Auth
97 + - name: bearer_token_file
98 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
99 + default_value: ""
100 + required: false
101 + group: HTTP Auth
102 +
103 + - name: tls_skip_verify
104 + description: Skip TLS certificate and hostname verification (insecure).
105 + default_value: no
106 + required: false
107 + group: TLS
108 + - name: tls_ca
109 + description: Path to CA bundle used to validate the server certificate.
110 + default_value: ""
111 + required: false
112 + group: TLS
113 + - name: tls_cert
114 + description: Path to client TLS certificate (for mTLS).
115 default_value: ""
116 required: false
117 + group: TLS
118 + - name: tls_key
119 + description: Path to client TLS private key (for mTLS).
120 + default_value: ""
121 + required: false
122 + group: TLS
123 +
124 - name: proxy_url
90 - description: Proxy URL.
125 + description: HTTP proxy URL.
126 default_value: ""
127 required: false
128 + group: Proxy
129 - name: proxy_username
94 - description: Username for proxy basic HTTP authentication.
130 + description: Username for proxy Basic HTTP authentication.
131 default_value: ""
132 required: false
133 + group: Proxy
134 - name: proxy_password
98 - description: Password for proxy basic HTTP authentication.
135 + description: Password for proxy Basic HTTP authentication.
136 default_value: ""
137 required: false
138 + group: Proxy
139 +
140 - name: method
102 - description: HTTP request method.
141 + description: HTTP method to use.
142 default_value: "GET"
143 required: false
144 + group: Request
145 - name: body
106 - description: HTTP request body.
146 + description: Request body (e.g., for POST/PUT).
147 default_value: ""
148 required: false
149 + group: Request
150 - name: headers
110 - description: HTTP request headers.
151 + description: "Additional HTTP headers (one per line as key: value)."
152 default_value: ""
153 required: false
154 + group: Request
155 - name: not_follow_redirects
114 - description: Redirect handling policy. Controls whether the client follows redirects.
156 + description: Do not follow HTTP redirects.
157 default_value: no
158 required: false
117 - - name: tls_skip_verify
118 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
159 + group: Request
160 + - name: force_http2
161 + description: Force HTTP/2 (including h2c over TCP).
162 default_value: no
163 required: false
121 - - name: tls_ca
122 - description: Certification authority that the client uses when verifying the server's certificates.
123 - default_value: ""
124 - required: false
125 - - name: tls_cert
126 - description: Client TLS certificate.
127 - default_value: ""
128 - required: false
129 - - name: tls_key
130 - description: Client TLS key.
164 + group: Request
165 +
166 + - name: vnode
167 + 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).
168 default_value: ""
169 required: false
170 + group: Virtual Node
171 examples:
172 folding:
173 title: Config
src/go/plugin/go.d/collector/cockroachdb/metadata.yaml
+66 -28
@@ -51,73 +51,111 @@ modules:
51 enabled: true
52 list:
53 - name: update_every
54 - description: Data collection frequency.
54 + description: Data collection interval (seconds).
55 default_value: 10
56 required: false
57 + group: Collection
58 - name: autodetection_retry
58 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 + description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: url
62 - description: Server URL.
65 + description: Target endpoint URL.
66 default_value: http://127.0.0.1:8080/_status/vars
67 required: true
68 + group: Target
69 - name: timeout
66 - description: HTTP request timeout.
70 + description: HTTP request timeout (seconds).
71 default_value: 1
72 required: false
73 + group: Target
74 +
75 - name: username
70 - description: Username for basic HTTP authentication.
76 + description: Username for Basic HTTP authentication.
77 default_value: ""
78 required: false
79 + group: HTTP Auth
80 - name: password
74 - description: Password for basic HTTP authentication.
81 + description: Password for Basic HTTP authentication.
82 default_value: ""
83 required: false
84 + group: HTTP Auth
85 + - name: bearer_token_file
86 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
87 + default_value: ""
88 + required: false
89 + group: HTTP Auth
90 +
91 + - name: tls_skip_verify
92 + description: Skip TLS certificate and hostname verification (insecure).
93 + default_value: no
94 + required: false
95 + group: TLS
96 + - name: tls_ca
97 + description: Path to CA bundle used to validate the server certificate.
98 + default_value: ""
99 + required: false
100 + group: TLS
101 + - name: tls_cert
102 + description: Path to client TLS certificate (for mTLS).
103 + default_value: ""
104 + required: false
105 + group: TLS
106 + - name: tls_key
107 + description: Path to client TLS private key (for mTLS).
108 + default_value: ""
109 + required: false
110 + group: TLS
111 +
112 - name: proxy_url
78 - description: Proxy URL.
113 + description: HTTP proxy URL.
114 default_value: ""
115 required: false
116 + group: Proxy
117 - name: proxy_username
82 - description: Username for proxy basic HTTP authentication.
118 + description: Username for proxy Basic HTTP authentication.
119 default_value: ""
120 required: false
121 + group: Proxy
122 - name: proxy_password
86 - description: Password for proxy basic HTTP authentication.
123 + description: Password for proxy Basic HTTP authentication.
124 default_value: ""
125 required: false
126 + group: Proxy
127 +
128 - name: method
90 - description: HTTP request method.
91 - default_value: GET
129 + description: HTTP method to use.
130 + default_value: "GET"
131 required: false
132 + group: Request
133 - name: body
94 - description: HTTP request body.
134 + description: Request body (e.g., for POST/PUT).
135 default_value: ""
136 required: false
137 + group: Request
138 - name: headers
98 - description: HTTP request headers.
139 + description: "Additional HTTP headers (one per line as key: value)."
140 default_value: ""
141 required: false
142 + group: Request
143 - name: not_follow_redirects
102 - description: Redirect handling policy. Controls whether the client follows redirects.
103 - default_value: false
104 - required: false
105 - - name: tls_skip_verify
106 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
107 - default_value: false
108 - required: false
109 - - name: tls_ca
110 - description: Certification authority that the client uses when verifying the server's certificates.
111 - default_value: ""
144 + description: Do not follow HTTP redirects.
145 + default_value: no
146 required: false
113 - - name: tls_cert
114 - description: Client TLS certificate.
115 - default_value: ""
147 + group: Request
148 + - name: force_http2
149 + description: Force HTTP/2 (including h2c over TCP).
150 + default_value: no
151 required: false
117 - - name: tls_key
118 - description: Client TLS key.
152 + group: Request
153 +
154 + - name: vnode
155 + 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).
156 default_value: ""
157 required: false
158 + group: Virtual Node
159 examples:
160 folding:
161 title: Config
src/go/plugin/go.d/collector/consul/metadata.yaml
+68 -37
@@ -79,85 +79,116 @@ modules:
79 enabled: true
80 list:
81 - name: update_every
82 - description: Data collection frequency.
82 + description: Data collection interval (seconds).
83 default_value: 1
84 required: false
85 + group: Collection
86 - name: autodetection_retry
86 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
87 + description: Autodetection retry interval (seconds). Set 0 to disable.
88 default_value: 0
89 required: false
90 + group: Collection
91 +
92 - name: url
90 - description: Server URL.
93 + description: Consul HTTP API URL.
94 default_value: http://localhost:8500
95 required: true
96 + group: Target
97 + - name: timeout
98 + description: HTTP request timeout (seconds).
99 + default_value: 1
100 + required: false
101 + group: Target
102 +
103 - name: acl_token
94 - description: ACL token used in every request.
104 + description: Consul ACL token sent with every request (`X-Consul-Token` header).
105 default_value: ""
106 required: false
97 - - name: max_checks
98 - description: Checks processing/charting limit.
107 + group: HTTP Auth
108 + - name: username
109 + description: Username for Basic HTTP authentication.
110 default_value: ""
111 required: false
101 - - name: max_filter
102 - description: Checks processing/charting filter. Uses [simple patterns](/src/libnetdata/simple_pattern/README.md).
112 + group: HTTP Auth
113 + - name: password
114 + description: Password for Basic HTTP authentication.
115 default_value: ""
116 required: false
105 - - name: username
106 - description: Username for basic HTTP authentication.
117 + group: HTTP Auth
118 + - name: bearer_token_file
119 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
120 default_value: ""
121 required: false
109 - - name: password
110 - description: Password for basic HTTP authentication.
122 + group: HTTP Auth
123 +
124 + - name: tls_skip_verify
125 + description: Skip TLS certificate and hostname verification (insecure).
126 + default_value: no
127 + required: false
128 + group: TLS
129 + - name: tls_ca
130 + description: Path to CA bundle used to validate the server certificate.
131 default_value: ""
132 required: false
133 + group: TLS
134 + - name: tls_cert
135 + description: Path to client TLS certificate (for mTLS).
136 + default_value: ""
137 + required: false
138 + group: TLS
139 + - name: tls_key
140 + description: Path to client TLS private key (for mTLS).
141 + default_value: ""
142 + required: false
143 + group: TLS
144 +
145 - name: proxy_url
114 - description: Proxy URL.
146 + description: HTTP proxy URL.
147 default_value: ""
148 required: false
149 + group: Proxy
150 - name: proxy_username
118 - description: Username for proxy basic HTTP authentication.
151 + description: Username for proxy Basic HTTP authentication.
152 default_value: ""
153 required: false
154 + group: Proxy
155 - name: proxy_password
122 - description: Password for proxy basic HTTP authentication.
156 + description: Password for proxy Basic HTTP authentication.
157 default_value: ""
158 required: false
125 - - name: timeout
126 - description: HTTP request timeout.
127 - default_value: 1
128 - required: false
159 + group: Proxy
160 +
161 - name: method
130 - description: HTTP request method.
162 + description: HTTP method to use.
163 default_value: GET
164 required: false
165 + group: Request
166 - name: body
134 - description: HTTP request body.
167 + description: Request body (e.g., for POST/PUT).
168 default_value: ""
169 required: false
170 + group: Request
171 - name: headers
138 - description: HTTP request headers.
172 + description: "Additional HTTP headers (one per line as key: value)."
173 default_value: ""
174 required: false
175 + group: Request
176 - name: not_follow_redirects
142 - description: Redirect handling policy. Controls whether the client follows redirects.
143 - default_value: false
177 + description: Do not follow HTTP redirects.
178 + default_value: no
179 required: false
145 - - name: tls_skip_verify
146 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
147 - default_value: false
180 + group: Request
181 + - name: force_http2
182 + description: Force HTTP/2 (including h2c over TCP).
183 + default_value: no
184 required: false
149 - - name: tls_ca
150 - description: Certification authority that the client uses when verifying the server's certificates.
151 - default_value: ""
152 - required: false
153 - - name: tls_cert
154 - description: Client tls certificate.
155 - default_value: ""
156 - required: false
157 - - name: tls_key
158 - description: Client tls key.
185 + group: Request
186 +
187 + - name: vnode
188 + 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).
189 default_value: ""
190 required: false
191 + group: Virtual Node
192 examples:
193 folding:
194 title: Config
src/go/plugin/go.d/collector/coredns/metadata.yaml
+72 -31
@@ -52,21 +52,32 @@ modules:
52 enabled: true
53 list:
54 - name: update_every
55 - description: Data collection frequency.
55 + description: Data collection interval (seconds).
56 default_value: 1
57 required: false
58 + group: Collection
59 - name: autodetection_retry
59 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
60 + description: Autodetection retry interval (seconds). Set 0 to disable.
61 default_value: 0
62 required: false
63 + group: Collection
64 +
65 - name: url
63 - description: Server URL.
66 + description: Target endpoint URL.
67 default_value: http://127.0.0.1:9153/metrics
68 required: true
69 + group: Target
70 + - name: timeout
71 + description: HTTP request timeout (seconds).
72 + default_value: 1
73 + required: false
74 + group: Target
75 +
76 - name: per_server_stats
77 description: Server filter.
78 default_value: ""
79 required: false
80 + group: Filters
81 detailed_description: |
82 Metrics of servers matching the selector will be collected.
83 - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
@@ -86,6 +97,7 @@ modules:
97 description: Zone filter.
98 default_value: ""
99 required: false
100 + group: Filters
101 detailed_description: |
102 Metrics of zones matching the selector will be collected.
103 - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
@@ -101,62 +113,91 @@ modules:
113 - pattern3
114 - pattern4
115 ```
116 +
117 - name: username
105 - description: Username for basic HTTP authentication.
118 + description: Username for Basic HTTP authentication.
119 default_value: ""
120 required: false
121 + group: HTTP Auth
122 - name: password
109 - description: Password for basic HTTP authentication.
123 + description: Password for Basic HTTP authentication.
124 + default_value: ""
125 + required: false
126 + group: HTTP Auth
127 + - name: bearer_token_file
128 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
129 + default_value: ""
130 + required: false
131 + group: HTTP Auth
132 +
133 + - name: tls_skip_verify
134 + description: Skip TLS certificate and hostname verification (insecure).
135 + default_value: no
136 + required: false
137 + group: TLS
138 + - name: tls_ca
139 + description: Path to CA bundle used to validate the server certificate.
140 + default_value: ""
141 + required: false
142 + group: TLS
143 + - name: tls_cert
144 + description: Path to client TLS certificate (for mTLS).
145 default_value: ""
146 required: false
147 + group: TLS
148 + - name: tls_key
149 + description: Path to client TLS private key (for mTLS).
150 + default_value: ""
151 + required: false
152 + group: TLS
153 +
154 - name: proxy_url
113 - description: Proxy URL.
155 + description: HTTP proxy URL.
156 default_value: ""
157 required: false
158 + group: Proxy
159 - name: proxy_username
117 - description: Username for proxy basic HTTP authentication.
160 + description: Username for proxy Basic HTTP authentication.
161 default_value: ""
162 required: false
163 + group: Proxy
164 - name: proxy_password
121 - description: Password for proxy basic HTTP authentication.
165 + description: Password for proxy Basic HTTP authentication.
166 default_value: ""
167 required: false
124 - - name: timeout
125 - description: HTTP request timeout.
126 - default_value: 2
127 - required: false
168 + group: Proxy
169 +
170 - name: method
129 - description: HTTP request method.
130 - default_value: GET
171 + description: HTTP method to use.
172 + default_value: "GET"
173 required: false
174 + group: Request
175 - name: body
133 - description: HTTP request body.
176 + description: Request body (e.g., for POST/PUT).
177 default_value: ""
178 required: false
179 + group: Request
180 - name: headers
137 - description: HTTP request headers.
181 + description: "Additional HTTP headers (one per line as key: value)."
182 default_value: ""
183 required: false
184 + group: Request
185 - name: not_follow_redirects
141 - description: Redirect handling policy. Controls whether the client follows redirects.
142 - default_value: false
143 - required: false
144 - - name: tls_skip_verify
145 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
146 - default_value: false
147 - required: false
148 - - name: tls_ca
149 - description: Certification authority that the client uses when verifying the server's certificates.
150 - default_value: ""
186 + description: Do not follow HTTP redirects.
187 + default_value: no
188 required: false
152 - - name: tls_cert
153 - description: Client tls certificate.
154 - default_value: ""
189 + group: Request
190 + - name: force_http2
191 + description: Force HTTP/2 (including h2c over TCP).
192 + default_value: no
193 required: false
156 - - name: tls_key
157 - description: Client tls key.
194 + group: Request
195 +
196 + - name: vnode
197 + 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).
198 default_value: ""
199 required: false
200 + group: Virtual Node
201 examples:
202 folding:
203 title: Config
src/go/plugin/go.d/collector/couchbase/metadata.yaml
+72 -34
@@ -51,73 +51,111 @@ modules:
51 enabled: true
52 list:
53 - name: update_every
54 - description: Data collection frequency.
55 - default_value: 1
54 + description: Data collection interval (seconds).
55 + default_value: 5
56 required: false
57 + group: Collection
58 - name: autodetection_retry
58 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 + description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: url
62 - description: Server URL.
65 + description: Target endpoint URL.
66 default_value: http://127.0.0.1:8091
67 required: true
68 + group: Target
69 + - name: timeout
70 + description: HTTP request timeout (seconds).
71 + default_value: 1
72 + required: false
73 + group: Target
74 +
75 - name: username
66 - description: Username for basic HTTP authentication.
76 + description: Username for Basic HTTP authentication.
77 default_value: ""
78 required: false
79 + group: HTTP Auth
80 - name: password
70 - description: Password for basic HTTP authentication.
81 + description: Password for Basic HTTP authentication.
82 default_value: ""
83 required: false
84 + group: HTTP Auth
85 + - name: bearer_token_file
86 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
87 + default_value: ""
88 + required: false
89 + group: HTTP Auth
90 +
91 + - name: tls_skip_verify
92 + description: Skip TLS certificate and hostname verification (insecure).
93 + default_value: no
94 + required: false
95 + group: TLS
96 + - name: tls_ca
97 + description: Path to CA bundle used to validate the server certificate.
98 + default_value: ""
99 + required: false
100 + group: TLS
101 + - name: tls_cert
102 + description: Path to client TLS certificate (for mTLS).
103 + default_value: ""
104 + required: false
105 + group: TLS
106 + - name: tls_key
107 + description: Path to client TLS private key (for mTLS).
108 + default_value: ""
109 + required: false
110 + group: TLS
111 +
112 - name: proxy_url
74 - description: Proxy URL.
113 + description: HTTP proxy URL.
114 default_value: ""
115 required: false
116 + group: Proxy
117 - name: proxy_username
78 - description: Username for proxy basic HTTP authentication.
118 + description: Username for proxy Basic HTTP authentication.
119 default_value: ""
120 required: false
121 + group: Proxy
122 - name: proxy_password
82 - description: Password for proxy basic HTTP authentication.
123 + description: Password for proxy Basic HTTP authentication.
124 default_value: ""
125 required: false
85 - - name: timeout
86 - description: HTTP request timeout.
87 - default_value: 2
88 - required: false
126 + group: Proxy
127 +
128 - name: method
90 - description: HTTP request method.
91 - default_value: GET
129 + description: HTTP method to use.
130 + default_value: "GET"
131 required: false
132 + group: Request
133 - name: body
94 - description: HTTP request body.
134 + description: Request body (e.g., for POST/PUT).
135 default_value: ""
136 required: false
137 + group: Request
138 - name: headers
98 - description: HTTP request headers.
139 + description: "Additional HTTP headers (one per line as key: value)."
140 default_value: ""
141 required: false
142 + group: Request
143 - name: not_follow_redirects
102 - description: Redirect handling policy. Controls whether the client follows redirects.
103 - default_value: false
104 - required: false
105 - - name: tls_skip_verify
106 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
107 - default_value: false
108 - required: false
109 - - name: tls_ca
110 - description: Certification authority that the client uses when verifying the server's certificates.
111 - default_value: ""
112 - required: false
113 - - name: tls_cert
114 - description: Client tls certificate.
115 - default_value: ""
116 - required: false
117 - - name: tls_key
118 - description: Client tls key.
144 + description: Do not follow HTTP redirects.
145 + default_value: no
146 + required: false
147 + group: Request
148 + - name: force_http2
149 + description: Force HTTP/2 (including h2c over TCP).
150 + default_value: no
151 + required: false
152 + group: Request
153 +
154 + - name: vnode
155 + 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).
156 default_value: ""
157 required: false
158 + group: Virtual Node
159 examples:
160 folding:
161 title: Config
src/go/plugin/go.d/collector/couchdb/metadata.yaml
+75 -34
@@ -51,81 +51,122 @@ modules:
51 enabled: true
52 list:
53 - name: update_every
54 - description: Data collection frequency.
55 - default_value: 1
54 + description: Data collection interval (seconds).
55 + default_value: 10
56 required: false
57 + group: Collection
58 - name: autodetection_retry
58 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 + description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: url
62 - description: Server URL.
65 + description: Target endpoint URL.
66 default_value: http://127.0.0.1:5984
67 required: true
68 + group: Target
69 - name: node
66 - description: CouchDB node name. Same as -name vm.args argument.
70 + description: CouchDB node name (same as the `-name` argument in `vm.args`).
71 default_value: "_local"
72 + required: true
73 + group: Target
74 + - name: timeout
75 + description: HTTP request timeout (seconds).
76 + default_value: 2
77 required: false
78 + group: Target
79 +
80 - name: databases
70 - description: List of database names for which db-specific stats should be displayed, space separated.
81 + description: Space-separated list of databases to collect stats for.
82 default_value: ""
83 required: false
84 + group: Filters
85 +
86 - name: username
74 - description: Username for basic HTTP authentication.
87 + description: Username for Basic HTTP authentication.
88 default_value: ""
89 required: false
90 + group: HTTP Auth
91 - name: password
78 - description: Password for basic HTTP authentication.
92 + description: Password for Basic HTTP authentication.
93 + default_value: ""
94 + required: false
95 + group: HTTP Auth
96 + - name: bearer_token_file
97 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
98 + default_value: ""
99 + required: false
100 + group: HTTP Auth
101 +
102 + - name: tls_skip_verify
103 + description: Skip TLS certificate and hostname verification (insecure).
104 + default_value: no
105 + required: false
106 + group: TLS
107 + - name: tls_ca
108 + description: Path to CA bundle used to validate the server certificate.
109 default_value: ""
110 required: false
111 + group: TLS
112 + - name: tls_cert
113 + description: Path to client TLS certificate (for mTLS).
114 + default_value: ""
115 + required: false
116 + group: TLS
117 + - name: tls_key
118 + description: Path to client TLS private key (for mTLS).
119 + default_value: ""
120 + required: false
121 + group: TLS
122 +
123 - name: proxy_url
82 - description: Proxy URL.
124 + description: HTTP proxy URL.
125 default_value: ""
126 required: false
127 + group: Proxy
128 - name: proxy_username
86 - description: Username for proxy basic HTTP authentication.
129 + description: Username for proxy Basic HTTP authentication.
130 default_value: ""
131 required: false
132 + group: Proxy
133 - name: proxy_password
90 - description: Password for proxy basic HTTP authentication.
134 + description: Password for proxy Basic HTTP authentication.
135 default_value: ""
136 required: false
93 - - name: timeout
94 - description: HTTP request timeout.
95 - default_value: 2
96 - required: false
137 + group: Proxy
138 +
139 - name: method
98 - description: HTTP request method.
99 - default_value: GET
140 + description: HTTP method to use.
141 + default_value: "GET"
142 required: false
143 + group: Request
144 - name: body
102 - description: HTTP request body.
145 + description: Request body (e.g., for POST/PUT).
146 default_value: ""
147 required: false
148 + group: Request
149 - name: headers
106 - description: HTTP request headers.
150 + description: "Additional HTTP headers (one per line as key: value)."
151 default_value: ""
152 required: false
153 + group: Request
154 - name: not_follow_redirects
110 - description: Redirect handling policy. Controls whether the client follows redirects.
111 - default_value: false
155 + description: Do not follow HTTP redirects.
156 + default_value: no
157 required: false
113 - - name: tls_skip_verify
114 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
115 - default_value: false
158 + group: Request
159 + - name: force_http2
160 + description: Force HTTP/2 (including h2c over TCP).
161 + default_value: no
162 required: false
117 - - name: tls_ca
118 - description: Certification authority that the client uses when verifying the server's certificates.
119 - default_value: ""
120 - required: false
121 - - name: tls_cert
122 - description: Client tls certificate.
123 - default_value: ""
124 - required: false
125 - - name: tls_key
126 - description: Client tls key.
163 + group: Request
164 +
165 + - name: vnode
166 + 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).
167 default_value: ""
168 required: false
169 + group: Virtual Node
170 examples:
171 folding:
172 title: Config
src/go/plugin/go.d/collector/dnsdist/metadata.yaml
+69 -31
@@ -54,73 +54,111 @@ modules:
54 enabled: true
55 list:
56 - name: update_every
57 - description: Data collection frequency.
57 + description: Data collection interval (seconds).
58 default_value: 1
59 required: false
60 + group: Collection
61 - name: autodetection_retry
61 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: url
65 - description: Server URL.
68 + description: Target endpoint URL.
69 default_value: http://127.0.0.1:8083
70 required: true
71 + group: Target
72 + - name: timeout
73 + description: HTTP request timeout (seconds).
74 + default_value: 1
75 + required: false
76 + group: Target
77 +
78 - name: username
69 - description: Username for basic HTTP authentication.
79 + description: Username for Basic HTTP authentication.
80 default_value: ""
81 required: false
82 + group: HTTP Auth
83 - name: password
73 - description: Password for basic HTTP authentication.
84 + description: Password for Basic HTTP authentication.
85 + default_value: ""
86 + required: false
87 + group: HTTP Auth
88 + - name: bearer_token_file
89 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
90 + default_value: ""
91 + required: false
92 + group: HTTP Auth
93 +
94 + - name: tls_skip_verify
95 + description: Skip TLS certificate and hostname verification (insecure).
96 + default_value: no
97 + required: false
98 + group: TLS
99 + - name: tls_ca
100 + description: Path to CA bundle used to validate the server certificate.
101 default_value: ""
102 required: false
103 + group: TLS
104 + - name: tls_cert
105 + description: Path to client TLS certificate (for mTLS).
106 + default_value: ""
107 + required: false
108 + group: TLS
109 + - name: tls_key
110 + description: Path to client TLS private key (for mTLS).
111 + default_value: ""
112 + required: false
113 + group: TLS
114 +
115 - name: proxy_url
77 - description: Proxy URL.
116 + description: HTTP proxy URL.
117 default_value: ""
118 required: false
119 + group: Proxy
120 - name: proxy_username
81 - description: Username for proxy basic HTTP authentication.
121 + description: Username for proxy Basic HTTP authentication.
122 default_value: ""
123 required: false
124 + group: Proxy
125 - name: proxy_password
85 - description: Password for proxy basic HTTP authentication.
126 + description: Password for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
88 - - name: timeout
89 - description: HTTP request timeout.
90 - default_value: 1
91 - required: false
129 + group: Proxy
130 +
131 - name: method
93 - description: HTTP request method.
94 - default_value: GET
132 + description: HTTP method to use.
133 + default_value: "GET"
134 required: false
135 + group: Request
136 - name: body
97 - description: HTTP request body.
137 + description: Request body (e.g., for POST/PUT).
138 default_value: ""
139 required: false
140 + group: Request
141 - name: headers
101 - description: HTTP request headers.
142 + description: "Additional HTTP headers (one per line as key: value)."
143 default_value: ""
144 required: false
145 + group: Request
146 - name: not_follow_redirects
105 - description: Redirect handling policy. Controls whether the client follows redirects.
106 - default_value: false
147 + description: Do not follow HTTP redirects.
148 + default_value: no
149 required: false
108 - - name: tls_skip_verify
109 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
110 - default_value: false
150 + group: Request
151 + - name: force_http2
152 + description: Force HTTP/2 (including h2c over TCP).
153 + default_value: no
154 required: false
112 - - name: tls_ca
113 - description: Certification authority that the client uses when verifying the server's certificates.
114 - default_value: ""
115 - required: false
116 - - name: tls_cert
117 - description: Client tls certificate.
118 - default_value: ""
119 - required: false
120 - - name: tls_key
121 - description: Client tls key.
155 + group: Request
156 +
157 + - name: vnode
158 + 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).
159 default_value: ""
160 required: false
161 + group: Virtual Node
162 examples:
163 folding:
164 title: Config
src/go/plugin/go.d/collector/dnsmasq/metadata.yaml
+17 -5
@@ -51,25 +51,37 @@ modules:
51 enabled: true
52 list:
53 - name: update_every
54 - description: Data collection frequency.
54 + description: Data collection interval (seconds).
55 default_value: 1
56 required: false
57 + group: Collection
58 - name: autodetection_retry
58 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 + description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: address
62 - description: Server address in `ip:port` format.
65 + description: Dnsmasq server address (`IP:PORT`).
66 default_value: 127.0.0.1:53
67 required: true
68 + group: Target
69 - name: protocol
66 - description: 'DNS query transport protocol. Supported protocols: udp, tcp, tcp-tls.'
70 + description: "DNS query transport protocol. Options: `udp`, `tcp`, `tcp-tls`."
71 default_value: udp
72 required: false
73 + group: Target
74 - name: timeout
70 - description: DNS query timeout (dial, write and read) in seconds.
75 + description: DNS query timeout for dial, write, and read (seconds).
76 default_value: 1
77 required: false
78 + group: Target
79 +
80 + - name: vnode
81 + 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).
82 + default_value: ""
83 + required: false
84 + group: Virtual Node
85 examples:
86 folding:
87 title: Config
src/go/plugin/go.d/collector/dnsmasq_dhcp/metadata.yaml
+10 -4
@@ -58,25 +58,31 @@ modules:
58 enabled: true
59 list:
60 - name: update_every
61 - description: Data collection frequency.
61 + description: Data collection interval (seconds).
62 default_value: 1
63 required: false
64 + group: Collection
65 - name: autodetection_retry
65 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
66 + description: Autodetection retry interval (seconds). Set 0 to disable.
67 default_value: 0
68 required: false
69 + group: Collection
70 +
71 - name: leases_path
72 description: Path to dnsmasq DHCP leases file.
73 default_value: /var/lib/misc/dnsmasq.leases
74 required: false
75 + group: Target
76 - name: conf_path
73 - description: Path to dnsmasq configuration file.
77 + description: Path to dnsmasq configuration file (used to extract configured DHCP pools).
78 default_value: /etc/dnsmasq.conf
79 required: false
80 + group: Target
81 - name: conf_dir
77 - description: Path to dnsmasq configuration directory.
82 + description: Path to dnsmasq configuration directory (used to extract configured DHCP pools).
83 default_value: /etc/dnsmasq.d,.dpkg-dist,.dpkg-old,.dpkg-new
84 required: false
85 + group: Target
86 examples:
87 folding:
88 title: Config
src/go/plugin/go.d/collector/dnsquery/metadata.yaml
+27 -11
@@ -50,37 +50,53 @@ modules:
50 enabled: true
51 list:
52 - name: update_every
53 - description: Data collection frequency.
53 + description: Data collection interval (seconds).
54 default_value: 1
55 required: false
56 + group: Collection
57 - name: autodetection_retry
57 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
58 + description: Autodetection retry interval (seconds). Set 0 to disable.
59 default_value: 0
60 required: false
61 + group: Collection
62 +
63 - name: domains
61 - description: Domain or subdomains to query. The collector will choose a random domain from the list on every iteration.
62 - default_value: ""
64 + description: One or more domains/subdomains to query. A random domain from the list is selected on each iteration.
65 + default_value: "[]"
66 required: true
67 + group: Target
68 - name: servers
65 - description: Servers to query. If empty, the collector will automatically use DNS servers from `/etc/resolv.conf`.
66 - default_value: ""
69 + description: DNS servers to query. If empty, servers from `/etc/resolv.conf` are used automatically.
70 + default_value: "[]"
71 + required: false
72 + group: Target
73 + - name: timeout
74 + description: Query timeout (seconds).
75 + default_value: 2
76 required: false
77 + group: Target
78 - name: port
79 description: DNS server port.
80 default_value: 53
81 required: false
82 + group: Target
83 - name: network
73 - description: "Network protocol name. Available options: udp, tcp, tcp-tls."
84 + description: "DNS query transport protocol. Options: `udp`, `tcp`, `tcp-tls`."
85 default_value: udp
86 required: false
87 + group: Target
88 +
89 - name: record_types
77 - description: "Query record type. Available options: A, AAAA, CNAME, MX, NS, PTR, TXT, SOA, SPF, TXT, SRV."
90 + description: "DNS record types to query. Options: A, AAAA, CNAME, MX, NS, PTR, TXT, SOA, SPF, SRV."
91 default_value: A
92 required: false
80 - - name: timeout
81 - description: Query read timeout.
82 - default_value: 2
93 + group: DNS Query
94 +
95 + - name: vnode
96 + 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).
97 + default_value: ""
98 required: false
99 + group: Virtual Node
100 examples:
101 folding:
102 title: Config
src/go/plugin/go.d/collector/docker/metadata.yaml
+22 -7
@@ -58,29 +58,44 @@ modules:
58 enabled: true
59 list:
60 - name: update_every
61 - description: Data collection frequency.
61 + description: Data collection interval (seconds).
62 default_value: 1
63 required: false
64 + group: Collection
65 - name: autodetection_retry
65 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
66 + description: Autodetection retry interval (seconds). Set 0 to disable.
67 default_value: 0
68 required: false
69 + group: Collection
70 +
71 - name: address
69 - description: 'Docker daemon''s listening address. When using a TCP socket, the format is: tcp://[ip]:[port]'
72 + description: "Docker daemon address. For TCP sockets: `tcp://IP:PORT`."
73 default_value: unix:///var/run/docker.sock
74 required: true
75 + group: Target
76 - name: timeout
73 - description: Request timeout in seconds.
77 + description: Request timeout (seconds).
78 default_value: 2
79 required: false
80 + group: Target
81 +
82 - name: container_selector
77 - description: "[Pattern](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#readme) to specify which containers to monitor."
83 + description: "Container selector. Defines which containers to monitor. Uses [simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#readme)."
84 default_value: "*"
85 required: false
86 + group: Filters
87 +
88 - name: collect_container_size
81 - description: Whether to collect container writable layer size.
82 - default_value: "no"
89 + description: Collect container writable layer size metrics.
90 + default_value: no
91 required: false
92 + group: Metrics Selection
93 +
94 + - name: vnode
95 + 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).
96 + default_value: ""
97 + required: false
98 + group: Virtual Node
99 examples:
100 folding:
101 enabled: true
src/go/plugin/go.d/collector/docker_engine/metadata.yaml
+69 -31
@@ -57,73 +57,111 @@ modules:
57 enabled: true
58 list:
59 - name: update_every
60 - description: Data collection frequency.
60 + description: Data collection interval (seconds).
61 default_value: 1
62 required: false
63 + group: Collection
64 - name: autodetection_retry
64 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
65 + description: Autodetection retry interval (seconds). Set 0 to disable.
66 default_value: 0
67 required: false
68 + group: Collection
69 +
70 - name: url
68 - description: Server URL.
71 + description: Target endpoint URL.
72 default_value: http://127.0.0.1:9323/metrics
73 required: true
74 + group: Target
75 + - name: timeout
76 + description: HTTP request timeout (seconds).
77 + default_value: 1
78 + required: false
79 + group: Target
80 +
81 - name: username
72 - description: Username for basic HTTP authentication.
82 + description: Username for Basic HTTP authentication.
83 default_value: ""
84 required: false
85 + group: HTTP Auth
86 - name: password
76 - description: Password for basic HTTP authentication.
87 + description: Password for Basic HTTP authentication.
88 + default_value: ""
89 + required: false
90 + group: HTTP Auth
91 + - name: bearer_token_file
92 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
93 + default_value: ""
94 + required: false
95 + group: HTTP Auth
96 +
97 + - name: tls_skip_verify
98 + description: Skip TLS certificate and hostname verification (insecure).
99 + default_value: no
100 + required: false
101 + group: TLS
102 + - name: tls_ca
103 + description: Path to CA bundle used to validate the server certificate.
104 default_value: ""
105 required: false
106 + group: TLS
107 + - name: tls_cert
108 + description: Path to client TLS certificate (for mTLS).
109 + default_value: ""
110 + required: false
111 + group: TLS
112 + - name: tls_key
113 + description: Path to client TLS private key (for mTLS).
114 + default_value: ""
115 + required: false
116 + group: TLS
117 +
118 - name: proxy_url
80 - description: Proxy URL.
119 + description: HTTP proxy URL.
120 default_value: ""
121 required: false
122 + group: Proxy
123 - name: proxy_username
84 - description: Username for proxy basic HTTP authentication.
124 + description: Username for proxy Basic HTTP authentication.
125 default_value: ""
126 required: false
127 + group: Proxy
128 - name: proxy_password
88 - description: Password for proxy basic HTTP authentication.
129 + description: Password for proxy Basic HTTP authentication.
130 default_value: ""
131 required: false
91 - - name: timeout
92 - description: HTTP request timeout.
93 - default_value: 1
94 - required: false
132 + group: Proxy
133 +
134 - name: method
96 - description: HTTP request method.
97 - default_value: GET
135 + description: HTTP method to use.
136 + default_value: "GET"
137 required: false
138 + group: Request
139 - name: body
100 - description: HTTP request body.
140 + description: Request body (e.g., for POST/PUT).
141 default_value: ""
142 required: false
143 + group: Request
144 - name: headers
104 - description: HTTP request headers.
145 + description: "Additional HTTP headers (one per line as key: value)."
146 default_value: ""
147 required: false
148 + group: Request
149 - name: not_follow_redirects
108 - description: Redirect handling policy. Controls whether the client follows redirects.
109 - default_value: "no"
150 + description: Do not follow HTTP redirects.
151 + default_value: no
152 required: false
111 - - name: tls_skip_verify
112 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
113 - default_value: "no"
153 + group: Request
154 + - name: force_http2
155 + description: Force HTTP/2 (including h2c over TCP).
156 + default_value: no
157 required: false
115 - - name: tls_ca
116 - description: Certification authority that the client uses when verifying the server's certificates.
117 - default_value: ""
118 - required: false
119 - - name: tls_cert
120 - description: Client TLS certificate.
121 - default_value: ""
122 - required: false
123 - - name: tls_key
124 - description: Client TLS key.
158 + group: Request
159 +
160 + - name: vnode
161 + 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).
162 default_value: ""
163 required: false
164 + group: Virtual Node
165 examples:
166 folding:
167 title: Config
src/go/plugin/go.d/collector/dockerhub/metadata.yaml
+70 -31
@@ -50,77 +50,116 @@ modules:
50 enabled: true
51 list:
52 - name: update_every
53 - description: Data collection frequency.
54 - default_value: 1
53 + description: Data collection interval (seconds).
54 + default_value: 5
55 required: false
56 + group: Collection
57 - name: autodetection_retry
57 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
58 + description: Autodetection retry interval (seconds). Set 0 to disable.
59 default_value: 0
60 required: false
60 - - name: url
61 - description: DockerHub URL.
62 - default_value: https://hub.docker.com/v2/repositories
63 - required: true
61 + group: Collection
62 +
63 - name: repositories
65 - description: List of repositories to monitor.
64 + description: List of Docker Hub repositories to monitor.
65 default_value: ""
66 required: true
67 + group: Target
68 + - name: url
69 + description: DockerHub repositories endpoint URL
70 + default_value: https://hub.docker.com/v2/repositories
71 + required: true
72 + group: Target
73 - name: timeout
69 - description: HTTP request timeout.
70 - default_value: 1
74 + description: HTTP request timeout (seconds).
75 + default_value: 5
76 required: false
77 + group: Target
78 +
79 - name: username
73 - description: Username for basic HTTP authentication.
80 + description: Username for Basic HTTP authentication.
81 default_value: ""
82 required: false
83 + group: HTTP Auth
84 - name: password
77 - description: Password for basic HTTP authentication.
85 + description: Password for Basic HTTP authentication.
86 + default_value: ""
87 + required: false
88 + group: HTTP Auth
89 + - name: bearer_token_file
90 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
91 + default_value: ""
92 + required: false
93 + group: HTTP Auth
94 +
95 + - name: tls_skip_verify
96 + description: Skip TLS certificate and hostname verification (insecure).
97 + default_value: no
98 + required: false
99 + group: TLS
100 + - name: tls_ca
101 + description: Path to CA bundle used to validate the server certificate.
102 default_value: ""
103 required: false
104 + group: TLS
105 + - name: tls_cert
106 + description: Path to client TLS certificate (for mTLS).
107 + default_value: ""
108 + required: false
109 + group: TLS
110 + - name: tls_key
111 + description: Path to client TLS private key (for mTLS).
112 + default_value: ""
113 + required: false
114 + group: TLS
115 +
116 - name: proxy_url
81 - description: Proxy URL.
117 + description: HTTP proxy URL.
118 default_value: ""
119 required: false
120 + group: Proxy
121 - name: proxy_username
85 - description: Username for proxy basic HTTP authentication.
122 + description: Username for proxy Basic HTTP authentication.
123 default_value: ""
124 required: false
125 + group: Proxy
126 - name: proxy_password
89 - description: Password for proxy basic HTTP authentication.
127 + description: Password for proxy Basic HTTP authentication.
128 default_value: ""
129 required: false
130 + group: Proxy
131 +
132 - name: method
93 - description: HTTP request method.
133 + description: HTTP method to use.
134 default_value: "GET"
135 required: false
136 + group: Request
137 - name: body
97 - description: HTTP request body.
138 + description: Request body (e.g., for POST/PUT).
139 default_value: ""
140 required: false
141 + group: Request
142 - name: headers
101 - description: HTTP request headers.
143 + description: "Additional HTTP headers (one per line as key: value)."
144 default_value: ""
145 required: false
146 + group: Request
147 - name: not_follow_redirects
105 - description: Redirect handling policy. Controls whether the client follows redirects.
148 + description: Do not follow HTTP redirects.
149 default_value: no
150 required: false
108 - - name: tls_skip_verify
109 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
151 + group: Request
152 + - name: force_http2
153 + description: Force HTTP/2 (including h2c over TCP).
154 default_value: no
155 required: false
112 - - name: tls_ca
113 - description: Certification authority that the client uses when verifying the server's certificates.
114 - default_value: ""
115 - required: false
116 - - name: tls_cert
117 - description: Client TLS certificate.
118 - default_value: ""
119 - required: false
120 - - name: tls_key
121 - description: Client TLS key.
156 + group: Request
157 +
158 + - name: vnode
159 + 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).
160 default_value: ""
161 required: false
162 + group: Virtual Node
163 examples:
164 folding:
165 title: Config
src/go/plugin/go.d/collector/dovecot/metadata.yaml
+15 -4
@@ -60,21 +60,32 @@ modules:
60 enabled: true
61 list:
62 - name: update_every
63 - description: Data collection frequency.
63 + description: Data collection interval (seconds).
64 default_value: 1
65 required: false
66 + group: Collection
67 - name: autodetection_retry
67 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
68 + description: Autodetection retry interval (seconds). Set 0 to disable.
69 default_value: 0
70 required: false
71 + group: Collection
72 +
73 - name: address
71 - description: "The Unix or TCP socket address where the Dovecot [old_stats](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics) plugin listens for connections."
74 + description: "Dovecot socket address (Unix or TCP). Used by the [old_stats](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics) plugin."
75 default_value: 127.0.0.1:24242
76 required: true
77 + group: Target
78 - name: timeout
75 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
79 + description: Connection, read, write, and name resolution timeout (seconds).
80 default_value: 1
81 required: false
82 + group: Target
83 +
84 + - name: vnode
85 + 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).
86 + default_value: ""
87 + required: false
88 + group: Virtual Node
89 examples:
90 folding:
91 title: Config
src/go/plugin/go.d/collector/elasticsearch/metadata.yaml
+82 -38
@@ -74,93 +74,137 @@ modules:
74 enabled: true
75 list:
76 - name: update_every
77 - description: Data collection frequency.
77 + description: Data collection interval (seconds).
78 default_value: 5
79 required: false
80 + group: Collection
81 - name: autodetection_retry
81 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
82 + description: Autodetection retry interval (seconds). Set 0 to disable.
83 default_value: 0
84 required: false
85 + group: Collection
86 +
87 - name: url
85 - description: Server URL.
88 + description: Target endpoint URL.
89 default_value: http://127.0.0.1:9200
90 required: true
91 + group: Target
92 + - name: timeout
93 + description: HTTP request timeout (seconds).
94 + default_value: 2
95 + required: false
96 + group: Target
97 +
98 - name: cluster_mode
89 - description: Controls whether to collect metrics for all nodes in the cluster or only for the local node.
90 - default_value: "false"
99 + description: Collect metrics for all nodes in the cluster (yes) or only the local node (no).
100 + default_value: no
101 required: false
102 + group: Metrics Selection
103 - name: collect_node_stats
93 - description: Controls whether to collect nodes metrics.
94 - default_value: "true"
104 + description: Collect node metrics.
105 + default_value: yes
106 required: false
107 + group: Metrics Selection
108 - name: collect_cluster_health
97 - description: Controls whether to collect cluster health metrics.
98 - default_value: "true"
109 + description: Collect cluster health metrics.
110 + default_value: yes
111 required: false
112 + group: Metrics Selection
113 - name: collect_cluster_stats
101 - description: Controls whether to collect cluster stats metrics.
102 - default_value: "true"
114 + description: Collect cluster stats metrics.
115 + default_value: yes
116 required: false
117 + group: Metrics Selection
118 - name: collect_indices_stats
105 - description: Controls whether to collect indices metrics.
106 - default_value: "false"
107 - required: false
108 - - name: timeout
109 - description: HTTP request timeout.
110 - default_value: 2
119 + description: Collect index metrics.
120 + default_value: no
121 required: false
122 + group: Metrics Selection
123 +
124 - name: username
113 - description: Username for basic HTTP authentication.
125 + description: Username for Basic HTTP authentication.
126 default_value: ""
127 required: false
128 + group: HTTP Auth
129 - name: password
117 - description: Password for basic HTTP authentication.
130 + description: Password for Basic HTTP authentication.
131 + default_value: ""
132 + required: false
133 + group: HTTP Auth
134 + - name: bearer_token_file
135 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
136 + default_value: ""
137 + required: false
138 + group: HTTP Auth
139 +
140 + - name: tls_skip_verify
141 + description: Skip TLS certificate and hostname verification (insecure).
142 + default_value: no
143 + required: false
144 + group: TLS
145 + - name: tls_ca
146 + description: Path to CA bundle used to validate the server certificate.
147 + default_value: ""
148 + required: false
149 + group: TLS
150 + - name: tls_cert
151 + description: Path to client TLS certificate (for mTLS).
152 default_value: ""
153 required: false
154 + group: TLS
155 + - name: tls_key
156 + description: Path to client TLS private key (for mTLS).
157 + default_value: ""
158 + required: false
159 + group: TLS
160 +
161 - name: proxy_url
121 - description: Proxy URL.
162 + description: HTTP proxy URL.
163 default_value: ""
164 required: false
165 + group: Proxy
166 - name: proxy_username
125 - description: Username for proxy basic HTTP authentication.
167 + description: Username for proxy Basic HTTP authentication.
168 default_value: ""
169 required: false
170 + group: Proxy
171 - name: proxy_password
129 - description: Password for proxy basic HTTP authentication.
172 + description: Password for proxy Basic HTTP authentication.
173 default_value: ""
174 required: false
175 + group: Proxy
176 +
177 - name: method
133 - description: HTTP request method.
178 + description: HTTP method to use.
179 default_value: "GET"
180 required: false
181 + group: Request
182 - name: body
137 - description: HTTP request body.
183 + description: Request body (e.g., for POST/PUT).
184 default_value: ""
185 required: false
186 + group: Request
187 - name: headers
141 - description: HTTP request headers.
188 + description: "Additional HTTP headers (one per line as key: value)."
189 default_value: ""
190 required: false
191 + group: Request
192 - name: not_follow_redirects
145 - description: Redirect handling policy. Controls whether the client follows redirects.
193 + description: Do not follow HTTP redirects.
194 default_value: no
195 required: false
148 - - name: tls_skip_verify
149 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
196 + group: Request
197 + - name: force_http2
198 + description: Force HTTP/2 (including h2c over TCP).
199 default_value: no
200 required: false
152 - - name: tls_ca
153 - description: Certification authority that the client uses when verifying the server's certificates.
154 - default_value: ""
155 - required: false
156 - - name: tls_cert
157 - description: Client TLS certificate.
158 - default_value: ""
159 - required: false
160 - - name: tls_key
161 - description: Client TLS key.
201 + group: Request
202 +
203 + - name: vnode
204 + 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).
205 default_value: ""
206 required: false
207 + group: Virtual Node
208 examples:
209 folding:
210 title: Config
src/go/plugin/go.d/collector/envoy/metadata.yaml
+64 -26
@@ -54,73 +54,111 @@ modules:
54 enabled: true
55 list:
56 - name: update_every
57 - description: Data collection frequency.
57 + description: Data collection interval (seconds).
58 default_value: 1
59 required: false
60 + group: Collection
61 - name: autodetection_retry
61 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: url
65 - description: Server URL.
68 + description: Target endpoint URL.
69 default_value: http://127.0.0.1:9091/stats/prometheus
70 required: true
71 + group: Target
72 - name: timeout
69 - description: HTTP request timeout.
73 + description: HTTP request timeout (seconds).
74 default_value: 1
75 required: false
76 + group: Target
77 +
78 - name: username
73 - description: Username for basic HTTP authentication.
79 + description: Username for Basic HTTP authentication.
80 default_value: ""
81 required: false
82 + group: HTTP Auth
83 - name: password
77 - description: Password for basic HTTP authentication.
84 + description: Password for Basic HTTP authentication.
85 default_value: ""
86 required: false
87 + group: HTTP Auth
88 + - name: bearer_token_file
89 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
90 + default_value: ""
91 + required: false
92 + group: HTTP Auth
93 +
94 + - name: tls_skip_verify
95 + description: Skip TLS certificate and hostname verification (insecure).
96 + default_value: no
97 + required: false
98 + group: TLS
99 + - name: tls_ca
100 + description: Path to CA bundle used to validate the server certificate.
101 + default_value: ""
102 + required: false
103 + group: TLS
104 + - name: tls_cert
105 + description: Path to client TLS certificate (for mTLS).
106 + default_value: ""
107 + required: false
108 + group: TLS
109 + - name: tls_key
110 + description: Path to client TLS private key (for mTLS).
111 + default_value: ""
112 + required: false
113 + group: TLS
114 +
115 - name: proxy_url
81 - description: Proxy URL.
116 + description: HTTP proxy URL.
117 default_value: ""
118 required: false
119 + group: Proxy
120 - name: proxy_username
85 - description: Username for proxy basic HTTP authentication.
121 + description: Username for proxy Basic HTTP authentication.
122 default_value: ""
123 required: false
124 + group: Proxy
125 - name: proxy_password
89 - description: Password for proxy basic HTTP authentication.
126 + description: Password for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
129 + group: Proxy
130 +
131 - name: method
93 - description: HTTP request method.
94 - default_value: GET
132 + description: HTTP method to use.
133 + default_value: "GET"
134 required: false
135 + group: Request
136 - name: body
97 - description: HTTP request body.
137 + description: Request body (e.g., for POST/PUT).
138 default_value: ""
139 required: false
140 + group: Request
141 - name: headers
101 - description: HTTP request headers.
142 + description: "Additional HTTP headers (one per line as key: value)."
143 default_value: ""
144 required: false
145 + group: Request
146 - name: not_follow_redirects
105 - description: Redirect handling policy. Controls whether the client follows redirects.
147 + description: Do not follow HTTP redirects.
148 default_value: no
149 required: false
108 - - name: tls_skip_verify
109 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
150 + group: Request
151 + - name: force_http2
152 + description: Force HTTP/2 (including h2c over TCP).
153 default_value: no
154 required: false
112 - - name: tls_ca
113 - description: Certification authority that the client uses when verifying the server's certificates.
114 - default_value: ""
115 - required: false
116 - - name: tls_cert
117 - description: Client TLS certificate.
118 - default_value: ""
119 - required: false
120 - - name: tls_key
121 - description: Client TLS key.
155 + group: Request
156 +
157 + - name: vnode
158 + 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).
159 default_value: ""
160 required: false
161 + group: Virtual Node
162 examples:
163 folding:
164 title: Config
src/go/plugin/go.d/collector/filecheck/metadata.yaml
+14 -7
@@ -52,21 +52,25 @@ modules:
52 enabled: true
53 list:
54 - name: update_every
55 - description: Data collection frequency.
55 + description: Data collection interval (seconds).
56 default_value: 10
57 required: false
58 + group: Collection
59 - name: autodetection_retry
59 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
60 + description: Autodetection retry interval (seconds). Set 0 to disable.
61 default_value: 0
62 required: false
63 + group: Collection
64 +
65 - name: files
63 - description: List of files to monitor.
66 + description: File selector. Defines which files to monitor.
67 default_value: ""
68 required: true
69 + group: Target
70 detailed_description: |
71 Files matching the selector will be monitored.
72
69 - - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
73 + - Logic: (pattern1 OR pattern2) AND !(pattern3 OR pattern4)
74 - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
75 - Syntax:
76
@@ -80,13 +84,14 @@ modules:
84 - pattern4
85 ```
86 - name: dirs
83 - description: List of directories to monitor.
87 + description: Directory selector. Defines which directories to monitor.
88 default_value: ""
89 required: true
90 + group: Target
91 detailed_description: |
92 Directories matching the selector will be monitored.
93
89 - - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
94 + - Logic: (pattern1 OR pattern2) AND !(pattern3 OR pattern4)
95 - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
96 - Syntax:
97
@@ -99,10 +104,12 @@ modules:
104 - pattern3
105 - pattern4
106 ```
107 +
108 - name: discovery_every
103 - description: Files and directories discovery interval.
109 + description: Files and directories discovery interval (seconds).
110 default_value: 60
111 required: false
112 + group: Discovery
113 examples:
114 folding:
115 title: Config
src/go/plugin/go.d/collector/fluentd/metadata.yaml
+67 -25
@@ -53,70 +53,112 @@ modules:
53 title: Config options
54 enabled: true
55 list:
56 + - name: update_every
57 + description: Data collection interval (seconds).
58 + default_value: 1
59 + required: false
60 + group: Collection
61 - name: autodetection_retry
57 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: url
61 - description: Server URL.
68 + description: Target endpoint URL.
69 default_value: http://127.0.0.1:24220
70 required: true
71 + group: Target
72 - name: timeout
65 - description: HTTP request timeout.
73 + description: HTTP request timeout (seconds).
74 default_value: 1
75 required: false
76 + group: Target
77 +
78 - name: username
69 - description: Username for basic HTTP authentication.
79 + description: Username for Basic HTTP authentication.
80 default_value: ""
81 required: false
82 + group: HTTP Auth
83 - name: password
73 - description: Password for basic HTTP authentication.
84 + description: Password for Basic HTTP authentication.
85 + default_value: ""
86 + required: false
87 + group: HTTP Auth
88 + - name: bearer_token_file
89 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
90 + default_value: ""
91 + required: false
92 + group: HTTP Auth
93 +
94 + - name: tls_skip_verify
95 + description: Skip TLS certificate and hostname verification (insecure).
96 + default_value: no
97 + required: false
98 + group: TLS
99 + - name: tls_ca
100 + description: Path to CA bundle used to validate the server certificate.
101 + default_value: ""
102 + required: false
103 + group: TLS
104 + - name: tls_cert
105 + description: Path to client TLS certificate (for mTLS).
106 + default_value: ""
107 + required: false
108 + group: TLS
109 + - name: tls_key
110 + description: Path to client TLS private key (for mTLS).
111 default_value: ""
112 required: false
113 + group: TLS
114 +
115 - name: proxy_url
77 - description: Proxy URL.
116 + description: HTTP proxy URL.
117 default_value: ""
118 required: false
119 + group: Proxy
120 - name: proxy_username
81 - description: Username for proxy basic HTTP authentication.
121 + description: Username for proxy Basic HTTP authentication.
122 default_value: ""
123 required: false
124 + group: Proxy
125 - name: proxy_password
85 - description: Password for proxy basic HTTP authentication.
126 + description: Password for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
129 + group: Proxy
130 +
131 - name: method
89 - description: HTTP request method.
90 - default_value: GET
132 + description: HTTP method to use.
133 + default_value: "GET"
134 required: false
135 + group: Request
136 - name: body
93 - description: HTTP request body.
137 + description: Request body (e.g., for POST/PUT).
138 default_value: ""
139 required: false
140 + group: Request
141 - name: headers
97 - description: HTTP request headers.
142 + description: "Additional HTTP headers (one per line as key: value)."
143 default_value: ""
144 required: false
145 + group: Request
146 - name: not_follow_redirects
101 - description: Redirect handling policy. Controls whether the client follows redirects.
147 + description: Do not follow HTTP redirects.
148 default_value: no
149 required: false
104 - - name: tls_skip_verify
105 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
150 + group: Request
151 + - name: force_http2
152 + description: Force HTTP/2 (including h2c over TCP).
153 default_value: no
154 required: false
108 - - name: tls_ca
109 - description: Certification authority that the client uses when verifying the server's certificates.
110 - default_value: ""
111 - required: false
112 - - name: tls_cert
113 - description: Client TLS certificate.
114 - default_value: ""
115 - required: false
116 - - name: tls_key
117 - description: Client TLS key.
155 + group: Request
156 +
157 + - name: vnode
158 + 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).
159 default_value: ""
160 required: false
161 + group: Virtual Node
162 examples:
163 folding:
164 title: Config
src/go/plugin/go.d/collector/freeradius/metadata.yaml
+23 -5
@@ -57,25 +57,43 @@ modules:
57 enabled: true
58 list:
59 - name: update_every
60 - description: Data collection frequency.
60 + description: Data collection interval (seconds).
61 default_value: 1
62 required: false
63 + group: Collection
64 - name: autodetection_retry
64 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
65 + description: Autodetection retry interval (seconds). Set 0 to disable.
66 default_value: 0
67 required: false
68 + group: Collection
69 +
70 - name: address
68 - description: Server address.
71 + description: FreeRADIUS server address.
72 default_value: 127.0.0.1
73 required: true
74 + group: Target
75 + - name: timeout
76 + description: Connection, read, and write timeout (seconds).
77 + default_value: 1
78 + required: false
79 + group: Target
80 - name: port
72 - description: Server port.
81 + description: FreeRADIUS server port.
82 default_value: 18121
83 required: false
84 + group: Target
85 +
86 - name: secret
76 - description: FreeRADIUS secret.
87 + description: FreeRADIUS shared secret.
88 default_value: adminsecret
89 required: false
90 + group: Auth
91 +
92 + - name: vnode
93 + 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).
94 + default_value: ""
95 + required: false
96 + group: Virtual Node
97 examples:
98 folding:
99 title: Config
src/go/plugin/go.d/collector/gearman/metadata.yaml
+15 -4
@@ -55,21 +55,32 @@ modules:
55 enabled: true
56 list:
57 - name: update_every
58 - description: Data collection frequency.
58 + description: Data collection interval (seconds).
59 default_value: 1
60 required: false
61 + group: Collection
62 - name: autodetection_retry
62 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
63 + description: Autodetection retry interval (seconds). Set 0 to disable.
64 default_value: 0
65 required: false
66 + group: Collection
67 +
68 - name: address
66 - description: The IP address and port where the Gearman service listens for connections.
69 + description: Gearman server address (`IP:PORT`).
70 default_value: 127.0.0.1:11211
71 required: true
72 + group: Target
73 - name: timeout
70 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
74 + description: Connection, read, write, and name resolution timeout (seconds).
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
src/go/plugin/go.d/collector/haproxy/metadata.yaml
+63 -31
@@ -57,73 +57,105 @@ modules:
57 enabled: true
58 list:
59 - name: update_every
60 - description: Data collection frequency.
60 + description: Data collection interval (seconds).
61 default_value: 1
62 required: false
63 + group: Collection
64 - name: autodetection_retry
64 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
65 + description: Autodetection retry interval (seconds). Set 0 to disable.
66 default_value: 0
67 required: false
68 + group: Collection
69 +
70 - name: url
68 - description: Server URL.
69 - default_value: http://127.0.0.1
71 + description: Target endpoint URL.
72 + default_value: http://127.0.0.1:8404/metrics
73 required: true
74 + group: Target
75 - name: timeout
72 - description: HTTP request timeout.
76 + description: HTTP request timeout (seconds).
77 default_value: 1
78 required: false
79 + group: Target
80 +
81 - name: username
76 - description: Username for basic HTTP authentication.
82 + description: Username for Basic HTTP authentication.
83 default_value: ""
84 required: false
85 + group: HTTP Auth
86 - name: password
80 - description: Password for basic HTTP authentication.
87 + description: Password for Basic HTTP authentication.
88 default_value: ""
89 required: false
90 + group: HTTP Auth
91 + - name: bearer_token_file
92 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
93 + default_value: ""
94 + required: false
95 + group: HTTP Auth
96 +
97 + - name: tls_skip_verify
98 + description: Skip TLS certificate and hostname verification (insecure).
99 + default_value: no
100 + required: false
101 + group: TLS
102 + - name: tls_ca
103 + description: Path to CA bundle used to validate the server certificate.
104 + default_value: ""
105 + required: false
106 + group: TLS
107 + - name: tls_cert
108 + description: Path to client TLS certificate (for mTLS).
109 + default_value: ""
110 + required: false
111 + group: TLS
112 + - name: tls_key
113 + description: Path to client TLS private key (for mTLS).
114 + default_value: ""
115 + required: false
116 + group: TLS
117 +
118 - name: proxy_url
84 - description: Proxy URL.
119 + description: HTTP proxy URL.
120 default_value: ""
121 required: false
122 + group: Proxy
123 - name: proxy_username
88 - description: Username for proxy basic HTTP authentication.
124 + description: Username for proxy Basic HTTP authentication.
125 default_value: ""
126 required: false
127 + group: Proxy
128 - name: proxy_password
92 - description: Password for proxy basic HTTP authentication.
129 + description: Password for proxy Basic HTTP authentication.
130 default_value: ""
131 required: false
132 + group: Proxy
133 +
134 - name: method
96 - description: HTTP request method.
97 - default_value: GET
135 + description: HTTP method to use.
136 + default_value: "GET"
137 required: false
138 + group: Request
139 - name: body
100 - description: HTTP request body.
140 + description: Request body (e.g., for POST/PUT).
141 default_value: ""
142 required: false
143 + group: Request
144 - name: headers
104 - description: HTTP request headers.
145 + description: "Additional HTTP headers (one per line as key: value)."
146 default_value: ""
147 required: false
148 + group: Request
149 - name: not_follow_redirects
108 - description: Redirect handling policy. Controls whether the client follows redirects.
109 - default_value: false
110 - required: false
111 - - name: tls_skip_verify
112 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
113 - default_value: false
114 - required: false
115 - - name: tls_ca
116 - description: Certification authority that the client uses when verifying the server's certificates.
117 - default_value: ""
150 + description: Do not follow HTTP redirects.
151 + default_value: no
152 required: false
119 - - name: tls_cert
120 - description: Client TLS certificate.
121 - default_value: ""
122 - required: false
123 - - name: tls_key
124 - description: Client TLS key.
125 - default_value: ""
153 + group: Request
154 + - name: force_http2
155 + description: Force HTTP/2 (including h2c over TCP).
156 + default_value: no
157 required: false
158 + group: Request
159 examples:
160 folding:
161 title: Config
src/go/plugin/go.d/collector/hddtemp/metadata.yaml
+9 -4
@@ -58,21 +58,26 @@ modules:
58 enabled: true
59 list:
60 - name: update_every
61 - description: Data collection frequency.
61 + description: Data collection interval (seconds).
62 default_value: 1
63 required: false
64 + group: Collection
65 - name: autodetection_retry
65 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
66 + description: Autodetection retry interval (seconds). Set 0 to disable.
67 default_value: 0
68 required: false
69 + group: Collection
70 +
71 - name: address
69 - description: The IP address and port where the hddtemp daemon listens for connections.
72 + description: hddtemp server address (`IP:PORT`).
73 default_value: 127.0.0.1:7634
74 required: true
75 + group: Target
76 - name: timeout
73 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
77 + description: Connection, read, write, and name resolution timeout (seconds).
78 default_value: 1
79 required: false
80 + group: Target
81 examples:
82 folding:
83 title: Config
src/go/plugin/go.d/collector/hdfs/metadata.yaml
+63 -25
@@ -53,73 +53,111 @@ modules:
53 enabled: true
54 list:
55 - name: update_every
56 - description: Data collection frequency.
56 + description: Data collection interval (seconds).
57 default_value: 1
58 required: false
59 + group: Collection
60 - name: autodetection_retry
60 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
61 + description: Autodetection retry interval (seconds). Set 0 to disable.
62 default_value: 0
63 required: false
64 + group: Collection
65 +
66 - name: url
64 - description: Server URL.
67 + description: Target endpoint URL.
68 default_value: http://127.0.0.1:9870/jmx
69 required: true
70 + group: Target
71 - name: timeout
68 - description: HTTP request timeout.
72 + description: HTTP request timeout (seconds).
73 default_value: 1
74 required: false
75 + group: Target
76 +
77 - name: username
72 - description: Username for basic HTTP authentication.
78 + description: Username for Basic HTTP authentication.
79 default_value: ""
80 required: false
81 + group: HTTP Auth
82 - name: password
76 - description: Password for basic HTTP authentication.
83 + description: Password for Basic HTTP authentication.
84 + default_value: ""
85 + required: false
86 + group: HTTP Auth
87 + - name: bearer_token_file
88 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
89 + default_value: ""
90 + required: false
91 + group: HTTP Auth
92 +
93 + - name: tls_skip_verify
94 + description: Skip TLS certificate and hostname verification (insecure).
95 + default_value: no
96 + required: false
97 + group: TLS
98 + - name: tls_ca
99 + description: Path to CA bundle used to validate the server certificate.
100 + default_value: ""
101 + required: false
102 + group: TLS
103 + - name: tls_cert
104 + description: Path to client TLS certificate (for mTLS).
105 default_value: ""
106 required: false
107 + group: TLS
108 + - name: tls_key
109 + description: Path to client TLS private key (for mTLS).
110 + default_value: ""
111 + required: false
112 + group: TLS
113 +
114 - name: proxy_url
80 - description: Proxy URL.
115 + description: HTTP proxy URL.
116 default_value: ""
117 required: false
118 + group: Proxy
119 - name: proxy_username
84 - description: Username for proxy basic HTTP authentication.
120 + description: Username for proxy Basic HTTP authentication.
121 default_value: ""
122 required: false
123 + group: Proxy
124 - name: proxy_password
88 - description: Password for proxy basic HTTP authentication.
125 + description: Password for proxy Basic HTTP authentication.
126 default_value: ""
127 required: false
128 + group: Proxy
129 +
130 - name: method
92 - description: HTTP request method.
131 + description: HTTP method to use.
132 default_value: "GET"
133 required: false
134 + group: Request
135 - name: body
96 - description: HTTP request body.
136 + description: Request body (e.g., for POST/PUT).
137 default_value: ""
138 required: false
139 + group: Request
140 - name: headers
100 - description: HTTP request headers.
141 + description: "Additional HTTP headers (one per line as key: value)."
142 default_value: ""
143 required: false
144 + group: Request
145 - name: not_follow_redirects
104 - description: Redirect handling policy. Controls whether the client follows redirects.
146 + description: Do not follow HTTP redirects.
147 default_value: no
148 required: false
107 - - name: tls_skip_verify
108 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
149 + group: Request
150 + - name: force_http2
151 + description: Force HTTP/2 (including h2c over TCP).
152 default_value: no
153 required: false
111 - - name: tls_ca
112 - description: Certification authority that the client uses when verifying the server's certificates.
113 - default_value: ""
114 - required: false
115 - - name: tls_cert
116 - description: Client TLS certificate.
117 - default_value: ""
118 - required: false
119 - - name: tls_key
120 - description: Client TLS key.
154 + group: Request
155 +
156 + - name: vnode
157 + 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).
158 default_value: ""
159 required: false
160 + group: Virtual Node
161 examples:
162 folding:
163 title: Config
src/go/plugin/go.d/collector/httpcheck/metadata.yaml
+85 -39
@@ -62,101 +62,147 @@ modules:
62 enabled: true
63 list:
64 - name: update_every
65 - description: Data collection frequency.
65 + description: Data collection interval (seconds).
66 default_value: 5
67 required: false
68 + group: Collection
69 - name: autodetection_retry
69 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
70 + description: Autodetection retry interval (seconds). Set 0 to disable.
71 default_value: 0
72 required: false
73 + group: Collection
74 +
75 - name: url
73 - description: Server URL.
76 + description: Target endpoint URL.
77 default_value: ""
78 required: true
79 + group: Target
80 + - name: timeout
81 + description: HTTP request timeout (seconds).
82 + default_value: 1
83 + required: false
84 + group: Target
85 +
86 - name: status_accepted
77 - description: "HTTP accepted response statuses. Anything else will result in 'bad status' in the status chart."
87 + description: "HTTP accepted response statuses. Anything else results in 'bad status' in the status chart."
88 default_value: "[200]"
89 required: false
90 + group: Validation
91 - name: response_match
81 - description: If the status code is accepted, the content of the response will be matched against this regular expression.
92 + description: If the status code is accepted, match the response body against this regular expression.
93 default_value: ""
94 required: false
95 + group: Validation
96 - name: header_match
85 - description: "This option defines a set of rules that check for specific key-value pairs in the HTTP headers of the response."
97 + description: "A set of rules to check for specific key-value pairs in response headers."
98 default_value: "[]"
99 required: false
100 + group: Validation
101 - name: header_match.exclude
89 - description: "This option determines whether the rule should check for the presence of the specified key-value pair or the absence of it."
90 - default_value: false
102 + description: "When yes, the rule asserts the key-value pair must be absent."
103 + default_value: no
104 required: false
105 + group: Validation
106 - name: header_match.key
93 - description: "The exact name of the HTTP header to check for."
107 + description: "Exact HTTP header name to check."
108 default_value: ""
109 required: true
110 + group: Validation
111 - name: header_match.value
97 - description: "The [pattern](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#supported-format) to match against the value of the specified header."
112 + description: "The [pattern](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#supported-format) to match against the header's value."
113 default_value: ""
114 required: false
100 - - name: cookie_file
101 - description: Path to cookie file. See [cookie file format](https://everything.curl.dev/http/cookies/fileformat).
115 + group: Validation
116 +
117 + - name: username
118 + description: Username for Basic HTTP authentication.
119 default_value: ""
120 required: false
104 - - name: timeout
105 - description: HTTP request timeout.
106 - default_value: 1
121 + group: HTTP Auth
122 + - name: password
123 + description: Password for Basic HTTP authentication.
124 + default_value: ""
125 required: false
108 - - name: username
109 - description: Username for basic HTTP authentication.
126 + group: HTTP Auth
127 + - name: bearer_token_file
128 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
129 default_value: ""
130 required: false
112 - - name: password
113 - description: Password for basic HTTP authentication.
131 + group: HTTP Auth
132 +
133 + - name: tls_skip_verify
134 + description: Skip TLS certificate and hostname verification (insecure).
135 + default_value: no
136 + required: false
137 + group: TLS
138 + - name: tls_ca
139 + description: Path to CA bundle used to validate the server certificate.
140 default_value: ""
141 required: false
142 + group: TLS
143 + - name: tls_cert
144 + description: Path to client TLS certificate (for mTLS).
145 + default_value: ""
146 + required: false
147 + group: TLS
148 + - name: tls_key
149 + description: Path to client TLS private key (for mTLS).
150 + default_value: ""
151 + required: false
152 + group: TLS
153 +
154 - name: proxy_url
117 - description: Proxy URL.
155 + description: HTTP proxy URL.
156 default_value: ""
157 required: false
158 + group: Proxy
159 - name: proxy_username
121 - description: Username for proxy basic HTTP authentication.
160 + description: Username for proxy Basic HTTP authentication.
161 default_value: ""
162 required: false
163 + group: Proxy
164 - name: proxy_password
125 - description: Password for proxy basic HTTP authentication.
165 + description: Password for proxy Basic HTTP authentication.
166 default_value: ""
167 required: false
168 + group: Proxy
169 +
170 - name: method
129 - description: HTTP request method.
130 - default_value: "GET"
171 + description: HTTP method to use.
172 + default_value: GET
173 required: false
174 + group: Request
175 - name: body
133 - description: HTTP request body.
176 + description: Request body (e.g., for POST/PUT).
177 default_value: ""
178 required: false
179 + group: Request
180 - name: headers
137 - description: HTTP request headers.
181 + description: "Additional HTTP headers (one per line as key: value)."
182 default_value: ""
183 required: false
184 + group: Request
185 + - name: cookie_file
186 + description: Path to cookie file. See [cookie file format](https://everything.curl.dev/http/cookies/fileformat).
187 + default_value: ""
188 + required: false
189 + group: Request
190 - name: not_follow_redirects
141 - description: Redirect handling policy. Controls whether the client follows redirects.
191 + description: Do not follow HTTP redirects.
192 default_value: no
193 required: false
144 - - name: tls_skip_verify
145 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
194 + group: Request
195 + - name: force_http2
196 + description: Force HTTP/2 (including h2c over TCP).
197 default_value: no
198 required: false
148 - - name: tls_ca
149 - description: Certification authority that the client uses when verifying the server's certificates.
150 - default_value: ""
151 - required: false
152 - - name: tls_cert
153 - description: Client TLS certificate.
154 - default_value: ""
155 - required: false
156 - - name: tls_key
157 - description: Client TLS key.
199 + group: Request
200 +
201 + - name: vnode
202 + 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).
203 default_value: ""
204 required: false
205 + group: Virtual Node
206 examples:
207 folding:
208 title: Config
src/go/plugin/go.d/collector/icecast/metadata.yaml
+66 -28
@@ -52,73 +52,111 @@ modules:
52 enabled: true
53 list:
54 - name: update_every
55 - description: Data collection frequency.
55 + description: Data collection interval (seconds).
56 default_value: 1
57 required: false
58 + group: Collection
59 - name: autodetection_retry
59 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
60 + description: Autodetection retry interval (seconds). Set 0 to disable.
61 default_value: 0
62 required: false
63 + group: Collection
64 +
65 - name: url
63 - description: Server URL.
66 + description: Target endpoint URL.
67 default_value: http://127.0.0.1:8000
68 required: true
69 + group: Target
70 - name: timeout
67 - description: HTTP request timeout.
71 + description: HTTP request timeout (seconds).
72 default_value: 1
73 required: false
74 + group: Target
75 +
76 - name: username
71 - description: Username for basic HTTP authentication.
77 + description: Username for Basic HTTP authentication.
78 default_value: ""
79 required: false
80 + group: HTTP Auth
81 - name: password
75 - description: Password for basic HTTP authentication.
82 + description: Password for Basic HTTP authentication.
83 + default_value: ""
84 + required: false
85 + group: HTTP Auth
86 + - name: bearer_token_file
87 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
88 + default_value: ""
89 + required: false
90 + group: HTTP Auth
91 +
92 + - name: tls_skip_verify
93 + description: Skip TLS certificate and hostname verification (insecure).
94 + default_value: no
95 + required: false
96 + group: TLS
97 + - name: tls_ca
98 + description: Path to CA bundle used to validate the server certificate.
99 default_value: ""
100 required: false
101 + group: TLS
102 + - name: tls_cert
103 + description: Path to client TLS certificate (for mTLS).
104 + default_value: ""
105 + required: false
106 + group: TLS
107 + - name: tls_key
108 + description: Path to client TLS private key (for mTLS).
109 + default_value: ""
110 + required: false
111 + group: TLS
112 +
113 - name: proxy_url
79 - description: Proxy URL.
114 + description: HTTP proxy URL.
115 default_value: ""
116 required: false
117 + group: Proxy
118 - name: proxy_username
83 - description: Username for proxy basic HTTP authentication.
119 + description: Username for proxy Basic HTTP authentication.
120 default_value: ""
121 required: false
122 + group: Proxy
123 - name: proxy_password
87 - description: Password for proxy basic HTTP authentication.
124 + description: Password for proxy Basic HTTP authentication.
125 default_value: ""
126 required: false
127 + group: Proxy
128 +
129 - name: method
91 - description: HTTP request method.
92 - default_value: POST
130 + description: HTTP method to use.
131 + default_value: "GET"
132 required: false
133 + group: Request
134 - name: body
95 - description: HTTP request body.
135 + description: Request body (e.g., for POST/PUT).
136 default_value: ""
137 required: false
138 + group: Request
139 - name: headers
99 - description: HTTP request headers.
140 + description: "Additional HTTP headers (one per line as key: value)."
141 default_value: ""
142 required: false
143 + group: Request
144 - name: not_follow_redirects
103 - description: Redirect handling policy. Controls whether the client follows redirects.
104 - default_value: false
145 + description: Do not follow HTTP redirects.
146 + default_value: no
147 required: false
106 - - name: tls_skip_verify
107 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
108 - default_value: false
148 + group: Request
149 + - name: force_http2
150 + description: Force HTTP/2 (including h2c over TCP).
151 + default_value: no
152 required: false
110 - - name: tls_ca
111 - description: Certification authority that the client uses when verifying the server's certificates.
112 - default_value: ""
113 - required: false
114 - - name: tls_cert
115 - description: Client TLS certificate.
116 - default_value: ""
117 - required: false
118 - - name: tls_key
119 - description: Client TLS key.
153 + group: Request
154 +
155 + - name: vnode
156 + 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).
157 default_value: ""
158 required: false
159 + group: Virtual Node
160 examples:
161 folding:
162 enabled: true
src/go/plugin/go.d/collector/ipfs/metadata.yaml
+77 -36
@@ -65,81 +65,122 @@ modules:
65 enabled: true
66 list:
67 - name: update_every
68 - description: Data collection frequency.
68 + description: Data collection interval (seconds).
69 default_value: 1
70 required: false
71 + group: Collection
72 - name: autodetection_retry
72 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
73 + description: Autodetection retry interval (seconds). Set 0 to disable.
74 default_value: 0
75 required: false
75 - - name: repoapi
76 - description: Enables querying the [/api/v0/stats/repo](https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-stat) endpoint for repository statistics.
77 - default_value: false
78 - required: false
79 - - name: pinapi
80 - description: Enables querying the [/api/v0/pin/ls](https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-ls) endpoint to retrieve a list of all pinned objects.
81 - default_value: false
82 - required: false
76 + group: Collection
77 +
78 - name: url
84 - description: Server URL.
79 + description: Target endpoint URL.
80 default_value: http://127.0.0.1:5001
81 required: true
82 + group: Target
83 - name: timeout
88 - description: HTTP request timeout.
84 + description: HTTP request timeout (seconds).
85 default_value: 1
86 required: false
87 + group: Target
88 +
89 + - name: repoapi
90 + description: Collect repository statistics from the [/api/v0/stats/repo](https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-repo-stat) endpoint.
91 + default_value: no
92 + required: false
93 + group: Metrics Selection
94 + - name: pinapi
95 + description: Collect pinned objects list from the [/api/v0/pin/ls](https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-ls) endpoint.
96 + default_value: no
97 + required: false
98 + group: Metrics Selection
99 +
100 - name: username
92 - description: Username for basic HTTP authentication.
101 + description: Username for Basic HTTP authentication.
102 default_value: ""
103 required: false
104 + group: HTTP Auth
105 - name: password
96 - description: Password for basic HTTP authentication.
106 + description: Password for Basic HTTP authentication.
107 + default_value: ""
108 + required: false
109 + group: HTTP Auth
110 + - name: bearer_token_file
111 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
112 + default_value: ""
113 + required: false
114 + group: HTTP Auth
115 +
116 + - name: tls_skip_verify
117 + description: Skip TLS certificate and hostname verification (insecure).
118 + default_value: no
119 + required: false
120 + group: TLS
121 + - name: tls_ca
122 + description: Path to CA bundle used to validate the server certificate.
123 default_value: ""
124 required: false
125 + group: TLS
126 + - name: tls_cert
127 + description: Path to client TLS certificate (for mTLS).
128 + default_value: ""
129 + required: false
130 + group: TLS
131 + - name: tls_key
132 + description: Path to client TLS private key (for mTLS).
133 + default_value: ""
134 + required: false
135 + group: TLS
136 +
137 - name: proxy_url
100 - description: Proxy URL.
138 + description: HTTP proxy URL.
139 default_value: ""
140 required: false
141 + group: Proxy
142 - name: proxy_username
104 - description: Username for proxy basic HTTP authentication.
143 + description: Username for proxy Basic HTTP authentication.
144 default_value: ""
145 required: false
146 + group: Proxy
147 - name: proxy_password
108 - description: Password for proxy basic HTTP authentication.
148 + description: Password for proxy Basic HTTP authentication.
149 default_value: ""
150 required: false
151 + group: Proxy
152 +
153 - name: method
112 - description: HTTP request method.
113 - default_value: POST
154 + description: HTTP method to use.
155 + default_value: "GET"
156 required: false
157 + group: Request
158 - name: body
116 - description: HTTP request body.
159 + description: Request body (e.g., for POST/PUT).
160 default_value: ""
161 required: false
162 + group: Request
163 - name: headers
120 - description: HTTP request headers.
164 + description: "Additional HTTP headers (one per line as key: value)."
165 default_value: ""
166 required: false
167 + group: Request
168 - name: not_follow_redirects
124 - description: Redirect handling policy. Controls whether the client follows redirects.
125 - default_value: false
169 + description: Do not follow HTTP redirects.
170 + default_value: no
171 required: false
127 - - name: tls_skip_verify
128 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
129 - default_value: false
172 + group: Request
173 + - name: force_http2
174 + description: Force HTTP/2 (including h2c over TCP).
175 + default_value: no
176 required: false
131 - - name: tls_ca
132 - description: Certification authority that the client uses when verifying the server's certificates.
133 - default_value: ""
134 - required: false
135 - - name: tls_cert
136 - description: Client TLS certificate.
137 - default_value: ""
138 - required: false
139 - - name: tls_key
140 - description: Client TLS key.
177 + group: Request
178 +
179 + - name: vnode
180 + 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).
181 default_value: ""
182 required: false
183 + group: Virtual Node
184 examples:
185 folding:
186 enabled: true
src/go/plugin/go.d/collector/isc_dhcpd/metadata.yaml
+8 -3
@@ -51,21 +51,26 @@ modules:
51 enabled: true
52 list:
53 - name: update_every
54 - description: Data collection frequency.
54 + description: Data collection interval (seconds).
55 default_value: 1
56 required: false
57 + group: Collection
58 - name: autodetection_retry
58 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 + description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: leases_path
65 description: Path to DHCP client lease database.
66 default_value: /var/lib/dhcp/dhcpd.leases
67 required: false
68 + group: Target
69 - name: pools
66 - description: List of IP pools to monitor.
70 + description: DHCP IP pools to monitor.
71 default_value: ""
72 required: true
73 + group: Target
74 detailed_description: |
75 List of IP pools to monitor.
76
src/go/plugin/go.d/collector/k8s_kubelet/metadata.yaml
+63 -25
@@ -54,73 +54,111 @@ modules:
54 enabled: true
55 list:
56 - name: update_every
57 - description: Data collection frequency.
57 + description: Data collection interval (seconds).
58 default_value: 1
59 required: false
60 + group: Collection
61 - name: autodetection_retry
61 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: url
65 - description: Server URL.
68 + description: Target endpoint URL.
69 default_value: http://127.0.0.1:10255/metrics
70 required: true
71 + group: Target
72 - name: timeout
69 - description: HTTP request timeout.
73 + description: HTTP request timeout (seconds).
74 default_value: 1
75 required: false
76 + group: Target
77 +
78 - name: username
73 - description: Username for basic HTTP authentication.
79 + description: Username for Basic HTTP authentication.
80 default_value: ""
81 required: false
82 + group: HTTP Auth
83 - name: password
77 - description: Password for basic HTTP authentication.
84 + description: Password for Basic HTTP authentication.
85 default_value: ""
86 required: false
87 + group: HTTP Auth
88 + - name: bearer_token_file
89 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
90 + default_value: "/var/run/secrets/kubernetes.io/serviceaccount/token"
91 + required: false
92 + group: HTTP Auth
93 +
94 + - name: tls_skip_verify
95 + description: Skip TLS certificate and hostname verification (insecure).
96 + default_value: no
97 + required: false
98 + group: TLS
99 + - name: tls_ca
100 + description: Path to CA bundle used to validate the server certificate.
101 + default_value: ""
102 + required: false
103 + group: TLS
104 + - name: tls_cert
105 + description: Path to client TLS certificate (for mTLS).
106 + default_value: ""
107 + required: false
108 + group: TLS
109 + - name: tls_key
110 + description: Path to client TLS private key (for mTLS).
111 + default_value: ""
112 + required: false
113 + group: TLS
114 +
115 - name: proxy_url
81 - description: Proxy URL.
116 + description: HTTP proxy URL.
117 default_value: ""
118 required: false
119 + group: Proxy
120 - name: proxy_username
85 - description: Username for proxy basic HTTP authentication.
121 + description: Username for proxy Basic HTTP authentication.
122 default_value: ""
123 required: false
124 + group: Proxy
125 - name: proxy_password
89 - description: Password for proxy basic HTTP authentication.
126 + description: Password for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
129 + group: Proxy
130 +
131 - name: method
93 - description: HTTP request method.
132 + description: HTTP method to use.
133 default_value: "GET"
134 required: false
135 + group: Request
136 - name: body
97 - description: HTTP request body.
137 + description: Request body (e.g., for POST/PUT).
138 default_value: ""
139 required: false
140 + group: Request
141 - name: headers
101 - description: HTTP request headers.
142 + description: "Additional HTTP headers (one per line as key: value)."
143 default_value: ""
144 required: false
145 + group: Request
146 - name: not_follow_redirects
105 - description: Redirect handling policy. Controls whether the client follows redirects.
147 + description: Do not follow HTTP redirects.
148 default_value: no
149 required: false
108 - - name: tls_skip_verify
109 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
150 + group: Request
151 + - name: force_http2
152 + description: Force HTTP/2 (including h2c over TCP).
153 default_value: no
154 required: false
112 - - name: tls_ca
113 - description: Certification authority that the client uses when verifying the server's certificates.
114 - default_value: ""
115 - required: false
116 - - name: tls_cert
117 - description: Client TLS certificate.
118 - default_value: ""
119 - required: false
120 - - name: tls_key
121 - description: Client TLS key.
155 + group: Request
156 +
157 + - name: vnode
158 + 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).
159 default_value: ""
160 required: false
161 + group: Virtual Node
162 examples:
163 folding:
164 title: Config
src/go/plugin/go.d/collector/k8s_kubeproxy/metadata.yaml
+64 -26
@@ -54,73 +54,111 @@ modules:
54 enabled: true
55 list:
56 - name: update_every
57 - description: Data collection frequency.
57 + description: Data collection interval (seconds).
58 default_value: 1
59 required: false
60 + group: Collection
61 - name: autodetection_retry
61 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: url
65 - description: Server URL.
68 + description: Target endpoint URL.
69 default_value: http://127.0.0.1:10249/metrics
70 required: true
71 + group: Target
72 - name: timeout
69 - description: HTTP request timeout.
73 + description: HTTP request timeout (seconds).
74 default_value: 1
75 required: false
76 + group: Target
77 +
78 - name: username
73 - description: Username for basic HTTP authentication.
79 + description: Username for Basic HTTP authentication.
80 default_value: ""
81 required: false
82 + group: HTTP Auth
83 - name: password
77 - description: Password for basic HTTP authentication.
84 + description: Password for Basic HTTP authentication.
85 default_value: ""
86 required: false
87 + group: HTTP Auth
88 + - name: bearer_token_file
89 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
90 + default_value: ""
91 + required: false
92 + group: HTTP Auth
93 +
94 + - name: tls_skip_verify
95 + description: Skip TLS certificate and hostname verification (insecure).
96 + default_value: no
97 + required: false
98 + group: TLS
99 + - name: tls_ca
100 + description: Path to CA bundle used to validate the server certificate.
101 + default_value: ""
102 + required: false
103 + group: TLS
104 + - name: tls_cert
105 + description: Path to client TLS certificate (for mTLS).
106 + default_value: ""
107 + required: false
108 + group: TLS
109 + - name: tls_key
110 + description: Path to client TLS private key (for mTLS).
111 + default_value: ""
112 + required: false
113 + group: TLS
114 +
115 - name: proxy_url
81 - description: Proxy URL.
116 + description: HTTP proxy URL.
117 default_value: ""
118 required: false
119 + group: Proxy
120 - name: proxy_username
85 - description: Username for proxy basic HTTP authentication.
121 + description: Username for proxy Basic HTTP authentication.
122 default_value: ""
123 required: false
124 + group: Proxy
125 - name: proxy_password
89 - description: Password for proxy basic HTTP authentication.
126 + description: Password for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
129 + group: Proxy
130 +
131 - name: method
93 - description: HTTP request method.
94 - default_value: GET
132 + description: HTTP method to use.
133 + default_value: "GET"
134 required: false
135 + group: Request
136 - name: body
97 - description: HTTP request body.
137 + description: Request body (e.g., for POST/PUT).
138 default_value: ""
139 required: false
140 + group: Request
141 - name: headers
101 - description: HTTP request headers.
142 + description: "Additional HTTP headers (one per line as key: value)."
143 default_value: ""
144 required: false
145 + group: Request
146 - name: not_follow_redirects
105 - description: Redirect handling policy. Controls whether the client follows redirects.
147 + description: Do not follow HTTP redirects.
148 default_value: no
149 required: false
108 - - name: tls_skip_verify
109 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
150 + group: Request
151 + - name: force_http2
152 + description: Force HTTP/2 (including h2c over TCP).
153 default_value: no
154 required: false
112 - - name: tls_ca
113 - description: Certification authority that the client uses when verifying the server's certificates.
114 - default_value: ""
115 - required: false
116 - - name: tls_cert
117 - description: Client TLS certificate.
118 - default_value: ""
119 - required: false
120 - - name: tls_key
121 - description: Client TLS key.
155 + group: Request
156 +
157 + - name: vnode
158 + 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).
159 default_value: ""
160 required: false
161 + group: Virtual Node
162 examples:
163 folding:
164 title: Config
src/go/plugin/go.d/collector/lighttpd/metadata.yaml
+64 -26
@@ -66,73 +66,111 @@ modules:
66 enabled: true
67 list:
68 - name: update_every
69 - description: Data collection frequency.
69 + description: Data collection interval (seconds).
70 default_value: 1
71 required: false
72 + group: Collection
73 - name: autodetection_retry
73 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
74 + description: Autodetection retry interval (seconds). Set 0 to disable.
75 default_value: 0
76 required: false
77 + group: Collection
78 +
79 - name: url
77 - description: Server URL.
80 + description: Target endpoint URL.
81 default_value: http://127.0.0.1/server-status?auto
82 required: true
83 + group: Target
84 - name: timeout
81 - description: HTTP request timeout.
82 - default_value: 1
85 + description: HTTP request timeout (seconds).
86 + default_value: 2
87 required: false
88 + group: Target
89 +
90 - name: username
85 - description: Username for basic HTTP authentication.
91 + description: Username for Basic HTTP authentication.
92 default_value: ""
93 required: false
94 + group: HTTP Auth
95 - name: password
89 - description: Password for basic HTTP authentication.
96 + description: Password for Basic HTTP authentication.
97 + default_value: ""
98 + required: false
99 + group: HTTP Auth
100 + - name: bearer_token_file
101 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
102 + default_value: ""
103 + required: false
104 + group: HTTP Auth
105 +
106 + - name: tls_skip_verify
107 + description: Skip TLS certificate and hostname verification (insecure).
108 + default_value: no
109 + required: false
110 + group: TLS
111 + - name: tls_ca
112 + description: Path to CA bundle used to validate the server certificate.
113 + default_value: ""
114 + required: false
115 + group: TLS
116 + - name: tls_cert
117 + description: Path to client TLS certificate (for mTLS).
118 default_value: ""
119 required: false
120 + group: TLS
121 + - name: tls_key
122 + description: Path to client TLS private key (for mTLS).
123 + default_value: ""
124 + required: false
125 + group: TLS
126 +
127 - name: proxy_url
93 - description: Proxy URL.
128 + description: HTTP proxy URL.
129 default_value: ""
130 required: false
131 + group: Proxy
132 - name: proxy_username
97 - description: Username for proxy basic HTTP authentication.
133 + description: Username for proxy Basic HTTP authentication.
134 default_value: ""
135 required: false
136 + group: Proxy
137 - name: proxy_password
101 - description: Password for proxy basic HTTP authentication.
138 + description: Password for proxy Basic HTTP authentication.
139 default_value: ""
140 required: false
141 + group: Proxy
142 +
143 - name: method
105 - description: HTTP request method.
144 + description: HTTP method to use.
145 default_value: "GET"
146 required: false
147 + group: Request
148 - name: body
109 - description: HTTP request body.
149 + description: Request body (e.g., for POST/PUT).
150 default_value: ""
151 required: false
152 + group: Request
153 - name: headers
113 - description: HTTP request headers.
154 + description: "Additional HTTP headers (one per line as key: value)."
155 default_value: ""
156 required: false
157 + group: Request
158 - name: not_follow_redirects
117 - description: Redirect handling policy. Controls whether the client follows redirects.
159 + description: Do not follow HTTP redirects.
160 default_value: no
161 required: false
120 - - name: tls_skip_verify
121 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
162 + group: Request
163 + - name: force_http2
164 + description: Force HTTP/2 (including h2c over TCP).
165 default_value: no
166 required: false
124 - - name: tls_ca
125 - description: Certification authority that the client uses when verifying the server's certificates.
126 - default_value: ""
127 - required: false
128 - - name: tls_cert
129 - description: Client TLS certificate.
130 - default_value: ""
131 - required: false
132 - - name: tls_key
133 - description: Client TLS key.
167 + group: Request
168 +
169 + - name: vnode
170 + 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).
171 default_value: ""
172 required: false
173 + group: Virtual Node
174 examples:
175 folding:
176 title: Config
src/go/plugin/go.d/collector/logstash/metadata.yaml
+66 -28
@@ -50,73 +50,111 @@ modules:
50 enabled: true
51 list:
52 - name: update_every
53 - description: Data collection frequency.
53 + description: Data collection interval (seconds).
54 default_value: 1
55 required: false
56 + group: Collection
57 - name: autodetection_retry
57 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
58 + description: Autodetection retry interval (seconds). Set 0 to disable.
59 default_value: 0
60 required: false
61 + group: Collection
62 +
63 - name: url
61 - description: Server URL.
64 + description: Target endpoint URL.
65 default_value: http://localhost:9600
66 required: true
67 + group: Target
68 - name: timeout
65 - description: HTTP request timeout.
69 + description: HTTP request timeout (seconds).
70 default_value: 1
71 required: false
72 + group: Target
73 +
74 - name: username
69 - description: Username for basic HTTP authentication.
75 + description: Username for Basic HTTP authentication.
76 default_value: ""
77 required: false
78 + group: HTTP Auth
79 - name: password
73 - description: Password for basic HTTP authentication.
80 + description: Password for Basic HTTP authentication.
81 default_value: ""
82 required: false
83 + group: HTTP Auth
84 + - name: bearer_token_file
85 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
86 + default_value: ""
87 + required: false
88 + group: HTTP Auth
89 +
90 + - name: tls_skip_verify
91 + description: Skip TLS certificate and hostname verification (insecure).
92 + default_value: no
93 + required: false
94 + group: TLS
95 + - name: tls_ca
96 + description: Path to CA bundle used to validate the server certificate.
97 + default_value: ""
98 + required: false
99 + group: TLS
100 + - name: tls_cert
101 + description: Path to client TLS certificate (for mTLS).
102 + default_value: ""
103 + required: false
104 + group: TLS
105 + - name: tls_key
106 + description: Path to client TLS private key (for mTLS).
107 + default_value: ""
108 + required: false
109 + group: TLS
110 +
111 - name: proxy_url
77 - description: Proxy URL.
112 + description: HTTP proxy URL.
113 default_value: ""
114 required: false
115 + group: Proxy
116 - name: proxy_username
81 - description: Username for proxy basic HTTP authentication.
117 + description: Username for proxy Basic HTTP authentication.
118 default_value: ""
119 required: false
120 + group: Proxy
121 - name: proxy_password
85 - description: Password for proxy basic HTTP authentication.
122 + description: Password for proxy Basic HTTP authentication.
123 default_value: ""
124 required: false
125 + group: Proxy
126 +
127 - name: method
89 - description: HTTP request method.
90 - default_value: GET
128 + description: HTTP method to use.
129 + default_value: "GET"
130 required: false
131 + group: Request
132 - name: body
93 - description: HTTP request body.
133 + description: Request body (e.g., for POST/PUT).
134 default_value: ""
135 required: false
136 + group: Request
137 - name: headers
97 - description: HTTP request headers.
138 + description: "Additional HTTP headers (one per line as key: value)."
139 default_value: ""
140 required: false
141 + group: Request
142 - name: not_follow_redirects
101 - description: Redirect handling policy. Controls whether the client follows redirects.
102 - default_value: false
103 - required: false
104 - - name: tls_skip_verify
105 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
106 - default_value: false
107 - required: false
108 - - name: tls_ca
109 - description: Certification authority that the client uses when verifying the server's certificates.
110 - default_value: ""
143 + description: Do not follow HTTP redirects.
144 + default_value: no
145 required: false
112 - - name: tls_cert
113 - description: Client TLS certificate.
114 - default_value: ""
146 + group: Request
147 + - name: force_http2
148 + description: Force HTTP/2 (including h2c over TCP).
149 + default_value: no
150 required: false
116 - - name: tls_key
117 - description: Client TLS key.
151 + group: Request
152 +
153 + - name: vnode
154 + 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).
155 default_value: ""
156 required: false
157 + group: Virtual Node
158 examples:
159 folding:
160 title: Config
src/go/plugin/go.d/collector/maxscale/metadata.yaml
+66 -28
@@ -63,73 +63,111 @@ modules:
63 enabled: true
64 list:
65 - name: update_every
66 - description: Data collection frequency.
66 + description: Data collection interval (seconds).
67 default_value: 1
68 required: false
69 + group: Collection
70 - name: autodetection_retry
70 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
71 + description: Autodetection retry interval (seconds). Set 0 to disable.
72 default_value: 0
73 required: false
74 + group: Collection
75 +
76 - name: url
74 - description: The URL of the MaxScale HTTP API endpoint.
77 + description: Target endpoint URL.
78 default_value: http://127.0.0.1:8989
79 required: true
80 + group: Target
81 - name: timeout
78 - description: HTTP request timeout.
82 + description: HTTP request timeout (seconds).
83 default_value: 1
84 required: false
85 + group: Target
86 +
87 - name: username
82 - description: Username for basic HTTP authentication.
88 + description: Username for Basic HTTP authentication.
89 default_value: "admin"
90 required: false
91 + group: HTTP Auth
92 - name: password
86 - description: Password for basic HTTP authentication.
93 + description: Password for Basic HTTP authentication.
94 default_value: "mariadb"
95 required: false
96 + group: HTTP Auth
97 + - name: bearer_token_file
98 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
99 + default_value: ""
100 + required: false
101 + group: HTTP Auth
102 +
103 + - name: tls_skip_verify
104 + description: Skip TLS certificate and hostname verification (insecure).
105 + default_value: no
106 + required: false
107 + group: TLS
108 + - name: tls_ca
109 + description: Path to CA bundle used to validate the server certificate.
110 + default_value: ""
111 + required: false
112 + group: TLS
113 + - name: tls_cert
114 + description: Path to client TLS certificate (for mTLS).
115 + default_value: ""
116 + required: false
117 + group: TLS
118 + - name: tls_key
119 + description: Path to client TLS private key (for mTLS).
120 + default_value: ""
121 + required: false
122 + group: TLS
123 +
124 - name: proxy_url
90 - description: Proxy URL.
125 + description: HTTP proxy URL.
126 default_value: ""
127 required: false
128 + group: Proxy
129 - name: proxy_username
94 - description: Username for proxy basic HTTP authentication.
130 + description: Username for proxy Basic HTTP authentication.
131 default_value: ""
132 required: false
133 + group: Proxy
134 - name: proxy_password
98 - description: Password for proxy basic HTTP authentication.
135 + description: Password for proxy Basic HTTP authentication.
136 default_value: ""
137 required: false
138 + group: Proxy
139 +
140 - name: method
102 - description: HTTP request method.
103 - default_value: GET
141 + description: HTTP method to use.
142 + default_value: "GET"
143 required: false
144 + group: Request
145 - name: body
106 - description: HTTP request body.
146 + description: Request body (e.g., for POST/PUT).
147 default_value: ""
148 required: false
149 + group: Request
150 - name: headers
110 - description: HTTP request headers.
151 + description: "Additional HTTP headers (one per line as key: value)."
152 default_value: ""
153 required: false
154 + group: Request
155 - name: not_follow_redirects
114 - description: Redirect handling policy. Controls whether the client follows redirects.
115 - default_value: false
156 + description: Do not follow HTTP redirects.
157 + default_value: no
158 required: false
117 - - name: tls_skip_verify
118 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
119 - default_value: false
159 + group: Request
160 + - name: force_http2
161 + description: Force HTTP/2 (including h2c over TCP).
162 + default_value: no
163 required: false
121 - - name: tls_ca
122 - description: Certification authority that the client uses when verifying the server's certificates.
123 - default_value: ""
124 - required: false
125 - - name: tls_cert
126 - description: Client TLS certificate.
127 - default_value: ""
128 - required: false
129 - - name: tls_key
130 - description: Client TLS key.
164 + group: Request
165 +
166 + - name: vnode
167 + 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).
168 default_value: ""
169 required: false
170 + group: Virtual Node
171 examples:
172 folding:
173 title: Config
src/go/plugin/go.d/collector/memcached/metadata.yaml
+15 -4
@@ -65,21 +65,32 @@ modules:
65 enabled: true
66 list:
67 - name: update_every
68 - description: Data collection frequency.
68 + description: Data collection interval (seconds).
69 default_value: 1
70 required: false
71 + group: Collection
72 - name: autodetection_retry
72 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
73 + description: Autodetection retry interval (seconds). Set 0 to disable.
74 default_value: 0
75 required: false
76 + group: Collection
77 +
78 - name: address
76 - description: The IP address and port where the memcached service listens for connections.
79 + description: Memcached server address (`IP:PORT`).
80 default_value: 127.0.0.1:11211
81 required: true
82 + group: Target
83 - name: timeout
80 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
84 + description: Connection, read, write, and name resolution timeout (seconds).
85 default_value: 1
86 required: false
87 + group: Target
88 +
89 + - name: vnode
90 + 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).
91 + default_value: ""
92 + required: false
93 + group: Virtual Node
94 examples:
95 folding:
96 title: Config
src/go/plugin/go.d/collector/mongodb/metadata.yaml
+20 -7
@@ -81,34 +81,41 @@ modules:
81 enabled: true
82 list:
83 - name: update_every
84 - description: Data collection frequency.
84 + description: Data collection interval (seconds).
85 default_value: 5
86 required: false
87 + group: Collection
88 - name: autodetection_retry
88 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
89 + description: Autodetection retry interval (seconds). Set 0 to disable.
90 default_value: 0
91 required: false
92 + group: Collection
93 +
94 - name: uri
92 - description: MongoDB connection string. See [URI syntax](https://www.mongodb.com/docs/manual/reference/connection-string/).
95 + description: "MongoDB connection string. See [URI syntax](https://www.mongodb.com/docs/manual/reference/connection-string/)."
96 default_value: mongodb://localhost:27017
97 required: true
98 + group: Target
99 - name: timeout
96 - description: Query timeout in seconds.
100 + description: Query timeout (seconds).
101 default_value: 1
102 required: false
103 + group: Target
104 +
105 - name: databases
100 - description: Databases selector. Determines which database metrics will be collected.
106 + description: Database selector. Defines which databases to collect metrics from.
107 default_value: ""
108 required: false
109 + group: Filters
110 details: |
111 Metrics of databases matching the selector will be collected.
112
106 - - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
113 + - Logic: (pattern1 OR pattern2) AND !(pattern3 OR pattern4)
114 - Pattern syntax: [matcher](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#supported-format).
115 - Syntax:
116
117 ```yaml
111 - per_user_stats:
118 + databases:
119 includes:
120 - pattern1
121 - pattern2
@@ -116,6 +123,12 @@ modules:
123 - pattern3
124 - pattern4
125 ```
126 +
127 + - name: vnode
128 + 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).
129 + default_value: ""
130 + required: false
131 + group: Virtual Node
132 examples:
133 folding:
134 title: Config
src/go/plugin/go.d/collector/monit/metadata.yaml
+66 -28
@@ -62,73 +62,111 @@ modules:
62 enabled: true
63 list:
64 - name: update_every
65 - description: Data collection frequency.
65 + description: Data collection interval (seconds).
66 default_value: 1
67 required: false
68 + group: Collection
69 - name: autodetection_retry
69 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
70 + description: Autodetection retry interval (seconds). Set 0 to disable.
71 default_value: 0
72 required: false
73 + group: Collection
74 +
75 - name: url
73 - description: Server URL.
76 + description: Target endpoint URL.
77 default_value: http://127.0.0.1:2812
78 required: true
79 + group: Target
80 - name: timeout
77 - description: HTTP request timeout.
81 + description: HTTP request timeout (seconds).
82 default_value: 1
83 required: false
84 + group: Target
85 +
86 - name: username
81 - description: Username for basic HTTP authentication.
87 + description: Username for Basic HTTP authentication.
88 default_value: "admin"
89 required: false
90 + group: HTTP Auth
91 - name: password
85 - description: Password for basic HTTP authentication.
92 + description: Password for Basic HTTP authentication.
93 default_value: "monit"
94 required: false
95 + group: HTTP Auth
96 + - name: bearer_token_file
97 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
98 + default_value: ""
99 + required: false
100 + group: HTTP Auth
101 +
102 + - name: tls_skip_verify
103 + description: Skip TLS certificate and hostname verification (insecure).
104 + default_value: no
105 + required: false
106 + group: TLS
107 + - name: tls_ca
108 + description: Path to CA bundle used to validate the server certificate.
109 + default_value: ""
110 + required: false
111 + group: TLS
112 + - name: tls_cert
113 + description: Path to client TLS certificate (for mTLS).
114 + default_value: ""
115 + required: false
116 + group: TLS
117 + - name: tls_key
118 + description: Path to client TLS private key (for mTLS).
119 + default_value: ""
120 + required: false
121 + group: TLS
122 +
123 - name: proxy_url
89 - description: Proxy URL.
124 + description: HTTP proxy URL.
125 default_value: ""
126 required: false
127 + group: Proxy
128 - name: proxy_username
93 - description: Username for proxy basic HTTP authentication.
129 + description: Username for proxy Basic HTTP authentication.
130 default_value: ""
131 required: false
132 + group: Proxy
133 - name: proxy_password
97 - description: Password for proxy basic HTTP authentication.
134 + description: Password for proxy Basic HTTP authentication.
135 default_value: ""
136 required: false
137 + group: Proxy
138 +
139 - name: method
101 - description: HTTP request method.
102 - default_value: GET
140 + description: HTTP method to use.
141 + default_value: "GET"
142 required: false
143 + group: Request
144 - name: body
105 - description: HTTP request body.
145 + description: Request body (e.g., for POST/PUT).
146 default_value: ""
147 required: false
148 + group: Request
149 - name: headers
109 - description: HTTP request headers.
150 + description: "Additional HTTP headers (one per line as key: value)."
151 default_value: ""
152 required: false
153 + group: Request
154 - name: not_follow_redirects
113 - description: Redirect handling policy. Controls whether the client follows redirects.
114 - default_value: false
155 + description: Do not follow HTTP redirects.
156 + default_value: no
157 required: false
116 - - name: tls_skip_verify
117 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
118 - default_value: false
158 + group: Request
159 + - name: force_http2
160 + description: Force HTTP/2 (including h2c over TCP).
161 + default_value: no
162 required: false
120 - - name: tls_ca
121 - description: Certification authority that the client uses when verifying the server's certificates.
122 - default_value: ""
123 - required: false
124 - - name: tls_cert
125 - description: Client TLS certificate.
126 - default_value: ""
127 - required: false
128 - - name: tls_key
129 - description: Client TLS key.
163 + group: Request
164 +
165 + - name: vnode
166 + 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).
167 default_value: ""
168 required: false
169 + group: Virtual Node
170 examples:
171 folding:
172 title: Config
src/go/plugin/go.d/collector/mysql/metadata.yaml
+17 -5
@@ -104,25 +104,37 @@ modules:
104 enabled: true
105 list:
106 - name: update_every
107 - description: Data collection frequency.
107 + description: Data collection interval (seconds).
108 default_value: 5
109 required: false
110 + group: Collection
111 - name: autodetection_retry
111 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
112 + description: Autodetection retry interval (seconds). Set 0 to disable.
113 default_value: 0
114 required: false
115 + group: Collection
116 +
117 - name: dsn
115 - description: MySQL server DSN (Data Source Name). See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name).
118 + description: "MySQL server DSN (Data Source Name). See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name)."
119 default_value: root@tcp(localhost:3306)/
120 required: true
121 + group: Target
122 - name: my.cnf
119 - description: Specifies the my.cnf file to read the connection settings from the [client] section.
123 + description: Path to a `my.cnf` file to read connection settings from the `[client]` section.
124 default_value: ""
125 required: false
126 + group: Target
127 - name: timeout
123 - description: Query timeout in seconds.
128 + description: Query timeout (seconds).
129 default_value: 1
130 required: false
131 + group: Target
132 +
133 + - name: vnode
134 + 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).
135 + default_value: ""
136 + required: false
137 + group: Virtual Node
138 examples:
139 folding:
140 title: Config
src/go/plugin/go.d/collector/nats/metadata.yaml
+70 -30
@@ -61,77 +61,117 @@ modules:
61 enabled: true
62 list:
63 - name: update_every
64 - description: Data collection frequency.
64 + description: Data collection interval (seconds).
65 default_value: 1
66 required: false
67 + group: Collection
68 - name: autodetection_retry
68 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
69 + description: Autodetection retry interval (seconds). Set 0 to disable.
70 default_value: 0
71 required: false
72 + group: Collection
73 +
74 - name: url
72 - description: Server URL.
75 + description: Target endpoint URL.
76 default_value: http://127.0.0.1:8222
77 required: true
78 + group: Target
79 - name: timeout
76 - description: HTTP request timeout.
80 + description: HTTP request timeout (seconds).
81 default_value: 1
82 required: false
83 + group: Target
84 +
85 - name: healthz_check
80 - description: "Controls the behavior of the `/healthz` endpoint [health check](https://docs.nats.io/running-a-nats-service/nats_admin/monitoring#health)."
81 - default_value: "default"
86 + description: "Selects the `/healthz` [endpoint mode](https://docs.nats.io/running-a-nats-service/nats_admin/monitoring#health-healthz). Options: `default` (standard check), `js-enabled-only` (error if JetStream is disabled), `js-server-only` (skip account/stream/consumer checks)."
87 + default_value: default
88 required: false
89 + group: Validation
90 +
91 - name: username
84 - description: Username for basic HTTP authentication.
92 + description: Username for Basic HTTP authentication.
93 default_value: ""
94 required: false
95 + group: HTTP Auth
96 - name: password
88 - description: Password for basic HTTP authentication.
97 + description: Password for Basic HTTP authentication.
98 + default_value: ""
99 + required: false
100 + group: HTTP Auth
101 + - name: bearer_token_file
102 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
103 + default_value: ""
104 + required: false
105 + group: HTTP Auth
106 +
107 + - name: tls_skip_verify
108 + description: Skip TLS certificate and hostname verification (insecure).
109 + default_value: no
110 + required: false
111 + group: TLS
112 + - name: tls_ca
113 + description: Path to CA bundle used to validate the server certificate.
114 + default_value: ""
115 + required: false
116 + group: TLS
117 + - name: tls_cert
118 + description: Path to client TLS certificate (for mTLS).
119 default_value: ""
120 required: false
121 + group: TLS
122 + - name: tls_key
123 + description: Path to client TLS private key (for mTLS).
124 + default_value: ""
125 + required: false
126 + group: TLS
127 +
128 - name: proxy_url
92 - description: Proxy URL.
129 + description: HTTP proxy URL.
130 default_value: ""
131 required: false
132 + group: Proxy
133 - name: proxy_username
96 - description: Username for proxy basic HTTP authentication.
134 + description: Username for proxy Basic HTTP authentication.
135 default_value: ""
136 required: false
137 + group: Proxy
138 - name: proxy_password
100 - description: Password for proxy basic HTTP authentication.
139 + description: Password for proxy Basic HTTP authentication.
140 default_value: ""
141 required: false
142 + group: Proxy
143 +
144 - name: method
104 - description: HTTP request method.
105 - default_value: GET
145 + description: HTTP method to use.
146 + default_value: "GET"
147 required: false
148 + group: Request
149 - name: body
108 - description: HTTP request body.
150 + description: Request body (e.g., for POST/PUT).
151 default_value: ""
152 required: false
153 + group: Request
154 - name: headers
112 - description: HTTP request headers.
155 + description: "Additional HTTP headers (one per line as key: value)."
156 default_value: ""
157 required: false
158 + group: Request
159 - name: not_follow_redirects
116 - description: Redirect handling policy. Controls whether the client follows redirects.
117 - default_value: false
118 - required: false
119 - - name: tls_skip_verify
120 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
121 - default_value: false
160 + description: Do not follow HTTP redirects.
161 + default_value: no
162 required: false
123 - - name: tls_ca
124 - description: Certification authority that the client uses when verifying the server's certificates.
125 - default_value: ""
163 + group: Request
164 + - name: force_http2
165 + description: Force HTTP/2 (including h2c over TCP).
166 + default_value: no
167 required: false
127 - - name: tls_cert
128 - description: Client TLS certificate.
129 - default_value: ""
130 - required: false
131 - - name: tls_key
132 - description: Client TLS key.
168 + group: Request
169 +
170 + - name: vnode
171 + 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).
172 default_value: ""
173 required: false
174 + group: Virtual Node
175 examples:
176 folding:
177 title: Config
src/go/plugin/go.d/collector/nginx/metadata.yaml
+61 -28
@@ -113,73 +113,106 @@ modules:
113 enabled: true
114 list:
115 - name: update_every
116 - description: Data collection frequency.
116 + description: Data collection interval (seconds).
117 default_value: 1
118 required: false
119 + group: Collection
120 - name: autodetection_retry
120 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
121 + description: Autodetection retry interval (seconds). Set 0 to disable.
122 default_value: 0
123 required: false
124 + group: Collection
125 +
126 - name: url
124 - description: Server URL.
127 + description: Target endpoint URL.
128 default_value: http://127.0.0.1/stub_status
129 required: true
130 + group: Target
131 - name: timeout
128 - description: HTTP request timeout.
132 + description: HTTP request timeout (seconds).
133 default_value: 1
134 required: false
135 + group: Target
136 +
137 - name: username
132 - description: Username for basic HTTP authentication.
138 + description: Username for Basic HTTP authentication.
139 default_value: ""
140 required: false
141 + group: HTTP Auth
142 - name: password
136 - description: Password for basic HTTP authentication.
143 + description: Password for Basic HTTP authentication.
144 + default_value: ""
145 + required: false
146 + group: HTTP Auth
147 + - name: bearer_token_file
148 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
149 + default_value: ""
150 + required: false
151 + group: HTTP Auth
152 +
153 + - name: tls_skip_verify
154 + description: Skip TLS certificate and hostname verification (insecure).
155 + default_value: no
156 + required: false
157 + group: TLS
158 + - name: tls_ca
159 + description: Path to CA bundle used to validate the server certificate.
160 + default_value: ""
161 + required: false
162 + group: TLS
163 + - name: tls_cert
164 + description: Path to client TLS certificate (for mTLS).
165 + default_value: ""
166 + required: false
167 + group: TLS
168 + - name: tls_key
169 + description: Path to client TLS private key (for mTLS).
170 default_value: ""
171 required: false
172 + group: TLS
173 +
174 - name: proxy_url
140 - description: Proxy URL.
175 + description: HTTP proxy URL.
176 default_value: ""
177 required: false
178 + group: Proxy
179 - name: proxy_username
144 - description: Username for proxy basic HTTP authentication.
180 + description: Username for proxy Basic HTTP authentication.
181 default_value: ""
182 required: false
183 + group: Proxy
184 - name: proxy_password
148 - description: Password for proxy basic HTTP authentication.
185 + description: Password for proxy Basic HTTP authentication.
186 default_value: ""
187 required: false
188 + group: Proxy
189 +
190 - name: method
152 - description: HTTP request method.
191 + description: HTTP method to use.
192 default_value: GET
193 required: false
194 + group: Request
195 - name: body
156 - description: HTTP request body.
196 + description: Request body (e.g., for POST/PUT).
197 default_value: ""
198 required: false
199 + group: Request
200 - name: headers
160 - description: HTTP request headers.
201 + description: "Additional HTTP headers (one per line as key: value)."
202 default_value: ""
203 required: false
204 + group: Request
205 - name: not_follow_redirects
164 - description: Redirect handling policy. Controls whether the client follows redirects.
165 - default_value: false
166 - required: false
167 - - name: tls_skip_verify
168 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
169 - default_value: false
170 - required: false
171 - - name: tls_ca
172 - description: Certification authority that the client uses when verifying the server's certificates.
173 - default_value: ""
206 + description: Do not follow HTTP redirects.
207 + default_value: no
208 required: false
175 - - name: tls_cert
176 - description: Client TLS certificate.
177 - default_value: ""
178 - required: false
179 - - name: tls_key
180 - description: Client TLS key.
209 + group: Request
210 +
211 + - name: vnode
212 + 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).
213 default_value: ""
214 required: false
215 + group: Virtual Node
216 examples:
217 folding:
218 title: Config
src/go/plugin/go.d/collector/nginxplus/metadata.yaml
+66 -28
@@ -58,73 +58,111 @@ modules:
58 enabled: true
59 list:
60 - name: update_every
61 - description: Data collection frequency.
61 + description: Data collection interval (seconds).
62 default_value: 1
63 required: false
64 + group: Collection
65 - name: autodetection_retry
65 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
66 + description: Autodetection retry interval (seconds). Set 0 to disable.
67 default_value: 0
68 required: false
69 + group: Collection
70 +
71 - name: url
69 - description: Server URL.
72 + description: Target endpoint URL.
73 default_value: http://127.0.0.1
74 required: true
75 + group: Target
76 - name: timeout
73 - description: HTTP request timeout.
77 + description: HTTP request timeout (seconds).
78 default_value: 1
79 required: false
80 + group: Target
81 +
82 - name: username
77 - description: Username for basic HTTP authentication.
83 + description: Username for Basic HTTP authentication.
84 default_value: ""
85 required: false
86 + group: HTTP Auth
87 - name: password
81 - description: Password for basic HTTP authentication.
88 + description: Password for Basic HTTP authentication.
89 default_value: ""
90 required: false
91 + group: HTTP Auth
92 + - name: bearer_token_file
93 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
94 + default_value: ""
95 + required: false
96 + group: HTTP Auth
97 +
98 + - name: tls_skip_verify
99 + description: Skip TLS certificate and hostname verification (insecure).
100 + default_value: no
101 + required: false
102 + group: TLS
103 + - name: tls_ca
104 + description: Path to CA bundle used to validate the server certificate.
105 + default_value: ""
106 + required: false
107 + group: TLS
108 + - name: tls_cert
109 + description: Path to client TLS certificate (for mTLS).
110 + default_value: ""
111 + required: false
112 + group: TLS
113 + - name: tls_key
114 + description: Path to client TLS private key (for mTLS).
115 + default_value: ""
116 + required: false
117 + group: TLS
118 +
119 - name: proxy_url
85 - description: Proxy URL.
120 + description: HTTP proxy URL.
121 default_value: ""
122 required: false
123 + group: Proxy
124 - name: proxy_username
89 - description: Username for proxy basic HTTP authentication.
125 + description: Username for proxy Basic HTTP authentication.
126 default_value: ""
127 required: false
128 + group: Proxy
129 - name: proxy_password
93 - description: Password for proxy basic HTTP authentication.
130 + description: Password for proxy Basic HTTP authentication.
131 default_value: ""
132 required: false
133 + group: Proxy
134 +
135 - name: method
97 - description: HTTP request method.
98 - default_value: GET
136 + description: HTTP method to use.
137 + default_value: "GET"
138 required: false
139 + group: Request
140 - name: body
101 - description: HTTP request body.
141 + description: Request body (e.g., for POST/PUT).
142 default_value: ""
143 required: false
144 + group: Request
145 - name: headers
105 - description: HTTP request headers.
146 + description: "Additional HTTP headers (one per line as key: value)."
147 default_value: ""
148 required: false
149 + group: Request
150 - name: not_follow_redirects
109 - description: Redirect handling policy. Controls whether the client follows redirects.
110 - default_value: false
111 - required: false
112 - - name: tls_skip_verify
113 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
114 - default_value: false
115 - required: false
116 - - name: tls_ca
117 - description: Certification authority that the client uses when verifying the server's certificates.
118 - default_value: ""
151 + description: Do not follow HTTP redirects.
152 + default_value: no
153 required: false
120 - - name: tls_cert
121 - description: Client TLS certificate.
122 - default_value: ""
154 + group: Request
155 + - name: force_http2
156 + description: Force HTTP/2 (including h2c over TCP).
157 + default_value: no
158 required: false
124 - - name: tls_key
125 - description: Client TLS key.
159 + group: Request
160 +
161 + - name: vnode
162 + 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).
163 default_value: ""
164 required: false
165 + group: Virtual Node
166 examples:
167 folding:
168 title: Config
src/go/plugin/go.d/collector/nginxunit/metadata.yaml
+66 -28
@@ -63,73 +63,111 @@ modules:
63 enabled: true
64 list:
65 - name: update_every
66 - description: Data collection frequency.
66 + description: Data collection interval (seconds).
67 default_value: 1
68 required: false
69 + group: Collection
70 - name: autodetection_retry
70 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
71 + description: Autodetection retry interval (seconds). Set 0 to disable.
72 default_value: 0
73 required: false
74 + group: Collection
75 +
76 - name: url
74 - description: The URL of the NGINX Unit HTTP Control API.
77 + description: Target endpoint URL.
78 default_value: http://127.0.0.1:8000
79 required: true
80 + group: Target
81 - name: timeout
78 - description: HTTP request timeout.
82 + description: HTTP request timeout (seconds).
83 default_value: 1
84 required: false
85 + group: Target
86 +
87 - name: username
82 - description: Username for basic HTTP authentication.
88 + description: Username for Basic HTTP authentication.
89 default_value: ""
90 required: false
91 + group: HTTP Auth
92 - name: password
86 - description: Password for basic HTTP authentication.
93 + description: Password for Basic HTTP authentication.
94 + default_value: ""
95 + required: false
96 + group: HTTP Auth
97 + - name: bearer_token_file
98 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
99 + default_value: ""
100 + required: false
101 + group: HTTP Auth
102 +
103 + - name: tls_skip_verify
104 + description: Skip TLS certificate and hostname verification (insecure).
105 + default_value: no
106 + required: false
107 + group: TLS
108 + - name: tls_ca
109 + description: Path to CA bundle used to validate the server certificate.
110 default_value: ""
111 required: false
112 + group: TLS
113 + - name: tls_cert
114 + description: Path to client TLS certificate (for mTLS).
115 + default_value: ""
116 + required: false
117 + group: TLS
118 + - name: tls_key
119 + description: Path to client TLS private key (for mTLS).
120 + default_value: ""
121 + required: false
122 + group: TLS
123 +
124 - name: proxy_url
90 - description: Proxy URL.
125 + description: HTTP proxy URL.
126 default_value: ""
127 required: false
128 + group: Proxy
129 - name: proxy_username
94 - description: Username for proxy basic HTTP authentication.
130 + description: Username for proxy Basic HTTP authentication.
131 default_value: ""
132 required: false
133 + group: Proxy
134 - name: proxy_password
98 - description: Password for proxy basic HTTP authentication.
135 + description: Password for proxy Basic HTTP authentication.
136 default_value: ""
137 required: false
138 + group: Proxy
139 +
140 - name: method
102 - description: HTTP request method.
103 - default_value: GET
141 + description: HTTP method to use.
142 + default_value: "GET"
143 required: false
144 + group: Request
145 - name: body
106 - description: HTTP request body.
146 + description: Request body (e.g., for POST/PUT).
147 default_value: ""
148 required: false
149 + group: Request
150 - name: headers
110 - description: HTTP request headers.
151 + description: "Additional HTTP headers (one per line as key: value)."
152 default_value: ""
153 required: false
154 + group: Request
155 - name: not_follow_redirects
114 - description: Redirect handling policy. Controls whether the client follows redirects.
115 - default_value: false
156 + description: Do not follow HTTP redirects.
157 + default_value: no
158 required: false
117 - - name: tls_skip_verify
118 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
119 - default_value: false
159 + group: Request
160 + - name: force_http2
161 + description: Force HTTP/2 (including h2c over TCP).
162 + default_value: no
163 required: false
121 - - name: tls_ca
122 - description: Certification authority that the client uses when verifying the server's certificates.
123 - default_value: ""
124 - required: false
125 - - name: tls_cert
126 - description: Client TLS certificate.
127 - default_value: ""
128 - required: false
129 - - name: tls_key
130 - description: Client TLS key.
164 + group: Request
165 +
166 + - name: vnode
167 + 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).
168 default_value: ""
169 required: false
170 + group: Virtual Node
171 examples:
172 folding:
173 title: Config
src/go/plugin/go.d/collector/nginxvts/metadata.yaml
+65 -27
@@ -62,73 +62,111 @@ modules:
62 enabled: true
63 list:
64 - name: update_every
65 - description: Data collection frequency.
65 + description: Data collection interval (seconds).
66 default_value: 1
67 required: false
68 + group: Collection
69 - name: autodetection_retry
69 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
70 + description: Autodetection retry interval (seconds). Set 0 to disable.
71 default_value: 0
72 required: false
73 + group: Collection
74 +
75 - name: url
73 - description: Server URL.
74 - default_value: http://127.0.0.1/status/format/json
76 + description: Target endpoint URL.
77 + default_value: http://localhost/status/format/json
78 required: true
79 + group: Target
80 - name: timeout
77 - description: HTTP request timeout.
81 + description: HTTP request timeout (seconds).
82 default_value: 1
83 required: false
84 + group: Target
85 +
86 - name: username
81 - description: Username for basic HTTP authentication.
87 + description: Username for Basic HTTP authentication.
88 default_value: ""
89 required: false
90 + group: HTTP Auth
91 - name: password
85 - description: Password for basic HTTP authentication.
92 + description: Password for Basic HTTP authentication.
93 default_value: ""
94 required: false
95 + group: HTTP Auth
96 + - name: bearer_token_file
97 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
98 + default_value: ""
99 + required: false
100 + group: HTTP Auth
101 +
102 + - name: tls_skip_verify
103 + description: Skip TLS certificate and hostname verification (insecure).
104 + default_value: no
105 + required: false
106 + group: TLS
107 + - name: tls_ca
108 + description: Path to CA bundle used to validate the server certificate.
109 + default_value: ""
110 + required: false
111 + group: TLS
112 + - name: tls_cert
113 + description: Path to client TLS certificate (for mTLS).
114 + default_value: ""
115 + required: false
116 + group: TLS
117 + - name: tls_key
118 + description: Path to client TLS private key (for mTLS).
119 + default_value: ""
120 + required: false
121 + group: TLS
122 +
123 - name: proxy_url
89 - description: Proxy URL.
124 + description: HTTP proxy URL.
125 default_value: ""
126 required: false
127 + group: Proxy
128 - name: proxy_username
93 - description: Username for proxy basic HTTP authentication.
129 + description: Username for proxy Basic HTTP authentication.
130 default_value: ""
131 required: false
132 + group: Proxy
133 - name: proxy_password
97 - description: Password for proxy basic HTTP authentication.
134 + description: Password for proxy Basic HTTP authentication.
135 default_value: ""
136 required: false
137 + group: Proxy
138 +
139 - name: method
101 - description: HTTP request method.
102 - default_value: GET
140 + description: HTTP method to use.
141 + default_value: "GET"
142 required: false
143 + group: Request
144 - name: body
105 - description: HTTP request body.
145 + description: Request body (e.g., for POST/PUT).
146 default_value: ""
147 required: false
148 + group: Request
149 - name: headers
109 - description: HTTP request headers.
150 + description: "Additional HTTP headers (one per line as key: value)."
151 default_value: ""
152 required: false
153 + group: Request
154 - name: not_follow_redirects
113 - description: Redirect handling policy. Controls whether the client follows redirects.
155 + description: Do not follow HTTP redirects.
156 default_value: no
157 required: false
116 - - name: tls_skip_verify
117 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
158 + group: Request
159 + - name: force_http2
160 + description: Force HTTP/2 (including h2c over TCP).
161 default_value: no
162 required: false
120 - - name: tls_ca
121 - description: Certification authority that the client uses when verifying the server's certificates.
122 - default_value: ""
123 - required: false
124 - - name: tls_cert
125 - description: Client TLS certificate.
126 - default_value: ""
127 - required: false
128 - - name: tls_key
129 - description: Client TLS key.
163 + group: Request
164 +
165 + - name: vnode
166 + 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).
167 default_value: ""
168 required: false
169 + group: Virtual Node
170 examples:
171 folding:
172 title: Config
src/go/plugin/go.d/collector/ntpd/metadata.yaml
+18 -5
@@ -54,25 +54,38 @@ modules:
54 enabled: true
55 list:
56 - name: update_every
57 - description: Data collection frequency.
57 + description: Data collection interval (seconds).
58 default_value: 1
59 required: false
60 + group: Collection
61 - name: autodetection_retry
61 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: address
65 - description: Server address in IP:PORT format.
68 + description: NTP server address (`IP:PORT`).
69 default_value: 127.0.0.1:123
70 required: true
71 + group: Target
72 - name: timeout
69 - description: Connection/read/write timeout.
73 + description: Connection, read, and write timeout (seconds).
74 default_value: 1
75 required: false
76 + group: Target
77 +
78 - name: collect_peers
73 - description: Determines whether peer metrics will be collected.
79 + description: Collect peer metrics.
80 default_value: false
81 required: false
82 + group: Metrics Selection
83 +
84 + - name: vnode
85 + 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).
86 + default_value: ""
87 + required: false
88 + group: Virtual Node
89 examples:
90 folding:
91 title: Config
src/go/plugin/go.d/collector/openldap/metadata.yaml
+34 -11
@@ -55,41 +55,64 @@ modules:
55 enabled: true
56 list:
57 - name: update_every
58 - description: Data collection frequency.
58 + description: Data collection interval (seconds).
59 default_value: 1
60 required: false
61 - - name: timeout
62 - description: Timeout for establishing a connection and communication (reading and writing) in seconds.
63 - default_value: 2
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: url
69 description: LDAP server URL.
70 default_value: ldap://127.0.0.1:389
71 required: true
72 + group: Target
73 + - name: timeout
74 + description: Connection and communication timeout (seconds).
75 + default_value: 2
76 + required: false
77 + group: Target
78 +
79 - name: username
70 - description: The distinguished name (DN) of the user authorized to view the monitor database.
80 + description: Distinguished Name (DN) of the user authorized to query the monitor database.
81 default_value: ""
82 required: true
83 + group: Auth
84 - name: password
74 - description: The password associated with the user identified by the DN.
85 + description: Password for the DN user.
86 default_value: ""
87 required: true
88 + group: Auth
89 +
90 - name: tls_skip_verify
78 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
79 - default_value: false
91 + description: Skip TLS certificate and hostname verification (insecure).
92 + default_value: no
93 required: false
94 + group: TLS
95 - name: tls_ca
82 - description: Certification authority that the client uses when verifying the server's certificates.
96 + description: Path to CA bundle used to validate the server certificate.
97 default_value: ""
98 required: false
99 + group: TLS
100 - name: tls_cert
86 - description: Client TLS certificate.
101 + description: Path to client TLS certificate (for mTLS).
102 default_value: ""
103 required: false
104 + group: TLS
105 - name: tls_key
90 - description: Client TLS key.
106 + description: Path to client TLS private key (for mTLS).
107 + default_value: ""
108 + required: false
109 + group: TLS
110 +
111 + - name: vnode
112 + 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).
113 default_value: ""
114 required: false
115 + group: Virtual Node
116 examples:
117 folding:
118 title: ""
src/go/plugin/go.d/collector/openvpn/metadata.yaml
+19 -6
@@ -61,29 +61,36 @@ modules:
61 enabled: true
62 list:
63 - name: update_every
64 - description: Data collection frequency.
64 + description: Data collection interval (seconds).
65 default_value: 1
66 required: false
67 + group: Collection
68 - name: autodetection_retry
68 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
69 + description: Autodetection retry interval (seconds). Set 0 to disable.
70 default_value: 0
71 required: false
72 + group: Collection
73 +
74 - name: address
72 - description: Server address in IP:PORT format.
75 + description: OpenVPN server address (`IP:PORT`).
76 default_value: 127.0.0.1:7505
77 required: true
78 + group: Target
79 - name: timeout
76 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
80 + description: Connection, read, write, and name resolution timeout (seconds).
81 default_value: 1
82 required: false
83 + group: Target
84 +
85 - name: per_user_stats
80 - description: User selector. Determines which user metrics will be collected.
86 + description: User selector. Defines which user metrics to collect.
87 default_value: ""
88 required: false
89 + group: Filters
90 details: |
91 Metrics of users matching the selector will be collected.
92
86 - - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
93 + - Logic: (pattern1 OR pattern2) AND !(pattern3 OR pattern4)
94 - Pattern syntax: [matcher](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#supported-format).
95 - Syntax:
96
@@ -96,6 +103,12 @@ modules:
103 - pattern3
104 - pattern4
105 ```
106 +
107 + - name: vnode
108 + 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).
109 + default_value: ""
110 + required: false
111 + group: Virtual Node
112 examples:
113 folding:
114 title: Config
src/go/plugin/go.d/collector/oracledb/metadata.yaml
+15 -4
@@ -82,21 +82,32 @@ modules:
82 enabled: true
83 list:
84 - name: update_every
85 - description: Data collection frequency.
85 + description: Data collection interval (seconds).
86 default_value: 1
87 required: false
88 + group: Collection
89 - name: autodetection_retry
89 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
90 + description: Autodetection retry interval (seconds). Set 0 to disable.
91 default_value: 0
92 required: false
93 + group: Collection
94 +
95 - name: dsn
93 - description: Oracle server DSN (Data Source Name). Format is `oracle://username:password@host:port/service?param1=value1&...&paramN=valueN`.
96 + description: "Oracle server DSN (Data Source Name). Format: `oracle://username:password@host:port/service?param1=value1&...&paramN=valueN`."
97 default_value: ""
98 required: true
99 + group: Target
100 - name: timeout
97 - description: Query timeout in seconds.
101 + description: Query timeout (seconds).
102 default_value: 1
103 required: false
104 + group: Target
105 +
106 + - name: vnode
107 + 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).
108 + default_value: ""
109 + required: false
110 + group: Virtual Node
111 examples:
112 folding:
113 title: Config
src/go/plugin/go.d/collector/pgbouncer/metadata.yaml
+15 -4
@@ -85,21 +85,32 @@ modules:
85 enabled: true
86 list:
87 - name: update_every
88 - description: Data collection frequency.
88 + description: Data collection interval (seconds).
89 default_value: 5
90 required: false
91 + group: Collection
92 - name: autodetection_retry
92 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
93 + description: Autodetection retry interval (seconds). Set 0 to disable.
94 default_value: 0
95 required: false
96 + group: Collection
97 +
98 - name: dsn
96 - description: PgBouncer server DSN (Data Source Name). See [DSN syntax](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING).
99 + description: "PgBouncer server DSN (Data Source Name). See [DSN syntax](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)."
100 default_value: postgres://postgres:postgres@127.0.0.1:6432/pgbouncer
101 required: true
102 + group: Target
103 - name: timeout
100 - description: Query timeout in seconds.
104 + description: Query timeout (seconds).
105 default_value: 1
106 required: false
107 + group: Target
108 +
109 + - name: vnode
110 + 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).
111 + default_value: ""
112 + required: false
113 + group: Virtual Node
114 examples:
115 folding:
116 title: Config
src/go/plugin/go.d/collector/phpdaemon/metadata.yaml
+67 -29
@@ -125,73 +125,111 @@ modules:
125 enabled: true
126 list:
127 - name: update_every
128 - description: Data collection frequency.
128 + description: Data collection interval (seconds).
129 default_value: 1
130 required: false
131 + group: Collection
132 - name: autodetection_retry
132 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
133 + description: Autodetection retry interval (seconds). Set 0 to disable.
134 default_value: 0
135 required: false
136 + group: Collection
137 +
138 - name: url
136 - description: Server URL.
139 + description: Target endpoint URL.
140 default_value: http://127.0.0.1:8509/FullStatus
141 required: true
142 + group: Target
143 - name: timeout
140 - description: HTTP request timeout.
141 - default_value: 2
144 + description: HTTP request timeout (seconds).
145 + default_value: 1
146 required: false
147 + group: Target
148 +
149 - name: username
144 - description: Username for basic HTTP authentication.
150 + description: Username for Basic HTTP authentication.
151 default_value: ""
152 required: false
153 + group: HTTP Auth
154 - name: password
148 - description: Password for basic HTTP authentication.
155 + description: Password for Basic HTTP authentication.
156 + default_value: ""
157 + required: false
158 + group: HTTP Auth
159 + - name: bearer_token_file
160 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
161 + default_value: ""
162 + required: false
163 + group: HTTP Auth
164 +
165 + - name: tls_skip_verify
166 + description: Skip TLS certificate and hostname verification (insecure).
167 + default_value: no
168 + required: false
169 + group: TLS
170 + - name: tls_ca
171 + description: Path to CA bundle used to validate the server certificate.
172 + default_value: ""
173 + required: false
174 + group: TLS
175 + - name: tls_cert
176 + description: Path to client TLS certificate (for mTLS).
177 default_value: ""
178 required: false
179 + group: TLS
180 + - name: tls_key
181 + description: Path to client TLS private key (for mTLS).
182 + default_value: ""
183 + required: false
184 + group: TLS
185 +
186 - name: proxy_url
152 - description: Proxy URL.
187 + description: HTTP proxy URL.
188 default_value: ""
189 required: false
190 + group: Proxy
191 - name: proxy_username
156 - description: Username for proxy basic HTTP authentication.
192 + description: Username for proxy Basic HTTP authentication.
193 default_value: ""
194 required: false
195 + group: Proxy
196 - name: proxy_password
160 - description: Password for proxy basic HTTP authentication.
197 + description: Password for proxy Basic HTTP authentication.
198 default_value: ""
199 required: false
200 + group: Proxy
201 +
202 - name: method
164 - description: HTTP request method.
165 - default_value: GET
203 + description: HTTP method to use.
204 + default_value: "GET"
205 required: false
206 + group: Request
207 - name: body
168 - description: HTTP request body.
208 + description: Request body (e.g., for POST/PUT).
209 default_value: ""
210 required: false
211 + group: Request
212 - name: headers
172 - description: HTTP request headers.
213 + description: "Additional HTTP headers (one per line as key: value)."
214 default_value: ""
215 required: false
216 + group: Request
217 - name: not_follow_redirects
176 - description: Redirect handling policy. Controls whether the client follows redirects.
177 - default_value: false
218 + description: Do not follow HTTP redirects.
219 + default_value: no
220 required: false
179 - - name: tls_skip_verify
180 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
181 - default_value: false
221 + group: Request
222 + - name: force_http2
223 + description: Force HTTP/2 (including h2c over TCP).
224 + default_value: no
225 required: false
183 - - name: tls_ca
184 - description: Certification authority that the client uses when verifying the server's certificates.
185 - default_value: ""
186 - required: false
187 - - name: tls_cert
188 - description: Client TLS certificate.
189 - default_value: ""
190 - required: false
191 - - name: tls_key
192 - description: Client TLS key.
226 + group: Request
227 +
228 + - name: vnode
229 + 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).
230 default_value: ""
231 required: false
232 + group: Virtual Node
233 examples:
234 folding:
235 title: Config
src/go/plugin/go.d/collector/phpfpm/metadata.yaml
+75 -34
@@ -54,85 +54,126 @@ modules:
54 enabled: true
55 list:
56 - name: update_every
57 - description: Data collection frequency.
57 + description: Data collection interval (seconds).
58 default_value: 1
59 required: false
60 + group: Collection
61 - name: autodetection_retry
61 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: url
65 - description: Server URL.
66 - default_value: http://127.0.0.1/status?full&json
68 + description: PHP-FPM URL.
69 + default_value: http://127.0.0.1/server-status?auto
70 required: true
68 - - name: socket
69 - description: Server Unix socket.
71 + group: Target
72 + - name: address
73 + description: PHP-FPM TCP listening address in IP:PORT format. Preferred over `url` if set.
74 default_value: ""
75 required: false
72 - - name: address
73 - description: Server address in IP:PORT format.
76 + group: Target
77 + - name: socket
78 + description: PHP-FPM Unix socket. Preferred over both `url` and `address` if set.
79 default_value: ""
80 required: false
81 + group: Target
82 - name: fcgi_path
77 - description: Status path.
83 + description: URI path to the [FPM status page](https://www.php.net/manual/en/fpm.status.php).
84 default_value: /status
85 required: false
86 + group: Target
87 - name: timeout
81 - description: HTTP request timeout.
88 + description: HTTP request timeout (seconds).
89 default_value: 1
90 required: false
91 + group: Target
92 +
93 - name: username
85 - description: Username for basic HTTP authentication.
94 + description: Username for Basic HTTP authentication.
95 default_value: ""
96 required: false
97 + group: HTTP Auth
98 - name: password
89 - description: Password for basic HTTP authentication.
99 + description: Password for Basic HTTP authentication.
100 default_value: ""
101 required: false
102 + group: HTTP Auth
103 + - name: bearer_token_file
104 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
105 + default_value: ""
106 + required: false
107 + group: HTTP Auth
108 +
109 + - name: tls_skip_verify
110 + description: Skip TLS certificate and hostname verification (insecure).
111 + default_value: no
112 + required: false
113 + group: TLS
114 + - name: tls_ca
115 + description: Path to CA bundle used to validate the server certificate.
116 + default_value: ""
117 + required: false
118 + group: TLS
119 + - name: tls_cert
120 + description: Path to client TLS certificate (for mTLS).
121 + default_value: ""
122 + required: false
123 + group: TLS
124 + - name: tls_key
125 + description: Path to client TLS private key (for mTLS).
126 + default_value: ""
127 + required: false
128 + group: TLS
129 +
130 - name: proxy_url
93 - description: Proxy URL.
131 + description: HTTP proxy URL.
132 default_value: ""
133 required: false
134 + group: Proxy
135 - name: proxy_username
97 - description: Username for proxy basic HTTP authentication.
136 + description: Username for proxy Basic HTTP authentication.
137 default_value: ""
138 required: false
139 + group: Proxy
140 - name: proxy_password
101 - description: Password for proxy basic HTTP authentication.
141 + description: Password for proxy Basic HTTP authentication.
142 default_value: ""
143 required: false
144 + group: Proxy
145 +
146 - name: method
105 - description: HTTP request method.
106 - default_value: GET
147 + description: HTTP method to use.
148 + default_value: "GET"
149 required: false
150 + group: Request
151 - name: body
109 - description: HTTP request body.
152 + description: Request body (e.g., for POST/PUT).
153 default_value: ""
154 required: false
155 + group: Request
156 - name: headers
113 - description: HTTP request headers.
157 + description: "Additional HTTP headers (one per line as key: value)."
158 default_value: ""
159 required: false
160 + group: Request
161 - name: not_follow_redirects
117 - description: Redirect handling policy. Controls whether the client follows redirects.
118 - default_value: false
119 - required: false
120 - - name: tls_skip_verify
121 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
122 - default_value: false
162 + description: Do not follow HTTP redirects.
163 + default_value: no
164 required: false
124 - - name: tls_ca
125 - description: Certification authority that the client uses when verifying the server's certificates.
126 - default_value: ""
127 - required: false
128 - - name: tls_cert
129 - description: Client TLS certificate.
130 - default_value: ""
165 + group: Request
166 + - name: force_http2
167 + description: Force HTTP/2 (including h2c over TCP).
168 + default_value: no
169 required: false
132 - - name: tls_key
133 - description: Client TLS key.
170 + group: Request
171 +
172 + - name: vnode
173 + 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).
174 default_value: ""
175 required: false
176 + group: Virtual Node
177 examples:
178 folding:
179 title: Config
src/go/plugin/go.d/collector/pihole/metadata.yaml
+67 -29
@@ -67,73 +67,111 @@ modules:
67 enabled: true
68 list:
69 - name: update_every
70 - description: Data collection frequency.
70 + description: Data collection interval (seconds).
71 default_value: 1
72 required: false
73 + group: Collection
74 - name: autodetection_retry
74 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
75 + description: Autodetection retry interval (seconds). Set 0 to disable.
76 default_value: 0
77 required: false
78 + group: Collection
79 +
80 - name: url
78 - description: Server URL.
81 + description: Target endpoint URL.
82 default_value: http://127.0.0.1
83 required: true
84 + group: Target
85 - name: timeout
82 - description: HTTP request timeout.
86 + description: HTTP request timeout (seconds).
87 default_value: 1
88 required: false
89 + group: Target
90 +
91 - name: username
86 - description: Username for basic HTTP authentication.
92 + description: Username for Basic HTTP authentication.
93 default_value: ""
88 - required: false
94 + required: true
95 + group: HTTP Auth
96 - name: password
90 - description: Password for basic HTTP authentication.
97 + description: Password for Basic HTTP authentication.
98 default_value: ""
99 required: true
100 + group: HTTP Auth
101 + - name: bearer_token_file
102 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
103 + default_value: ""
104 + required: false
105 + group: HTTP Auth
106 +
107 + - name: tls_skip_verify
108 + description: Skip TLS certificate and hostname verification (insecure).
109 + default_value: no
110 + required: false
111 + group: TLS
112 + - name: tls_ca
113 + description: Path to CA bundle used to validate the server certificate.
114 + default_value: ""
115 + required: false
116 + group: TLS
117 + - name: tls_cert
118 + description: Path to client TLS certificate (for mTLS).
119 + default_value: ""
120 + required: false
121 + group: TLS
122 + - name: tls_key
123 + description: Path to client TLS private key (for mTLS).
124 + default_value: ""
125 + required: false
126 + group: TLS
127 +
128 - name: proxy_url
94 - description: Proxy URL.
129 + description: HTTP proxy URL.
130 default_value: ""
131 required: false
132 + group: Proxy
133 - name: proxy_username
98 - description: Username for proxy basic HTTP authentication.
134 + description: Username for proxy Basic HTTP authentication.
135 default_value: ""
136 required: false
137 + group: Proxy
138 - name: proxy_password
102 - description: Password for proxy basic HTTP authentication.
139 + description: Password for proxy Basic HTTP authentication.
140 default_value: ""
141 required: false
142 + group: Proxy
143 +
144 - name: method
106 - description: HTTP request method.
107 - default_value: GET
145 + description: HTTP method to use.
146 + default_value: "GET"
147 required: false
148 + group: Request
149 - name: body
110 - description: HTTP request body.
150 + description: Request body (e.g., for POST/PUT).
151 default_value: ""
152 required: false
153 + group: Request
154 - name: headers
114 - description: HTTP request headers.
155 + description: "Additional HTTP headers (one per line as key: value)."
156 default_value: ""
157 required: false
158 + group: Request
159 - name: not_follow_redirects
118 - description: Redirect handling policy. Controls whether the client follows redirects.
119 - default_value: false
120 - required: false
121 - - name: tls_skip_verify
122 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
123 - default_value: false
160 + description: Do not follow HTTP redirects.
161 + default_value: no
162 required: false
125 - - name: tls_ca
126 - description: Certification authority that the client uses when verifying the server's certificates.
127 - default_value: ""
163 + group: Request
164 + - name: force_http2
165 + description: Force HTTP/2 (including h2c over TCP).
166 + default_value: no
167 required: false
129 - - name: tls_cert
130 - description: Client TLS certificate.
131 - default_value: ""
132 - required: false
133 - - name: tls_key
134 - description: Client TLS key.
168 + group: Request
169 +
170 + - name: vnode
171 + 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).
172 default_value: ""
173 required: false
174 + group: Virtual Node
175 examples:
176 folding:
177 title: Config
src/go/plugin/go.d/collector/pika/metadata.yaml
+30 -11
@@ -55,50 +55,69 @@ modules:
55 enabled: true
56 list:
57 - name: update_every
58 - description: Data collection frequency.
58 + description: Data collection frequency (seconds).
59 default_value: 5
60 required: false
61 + group: Collection
62 - name: autodetection_retry
62 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
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: Pika server address.
70 default_value: redis://@localhost:9221
71 required: true
72 + group: Target
73 details: |
70 - There are two connection types: by tcp socket and by unix socket.
71 -
72 - - Tcp connection: `redis://<user>:<password>@<host>:<port>/<db_number>`
74 + There are two connection types: by TCP socket and by Unix socket.
75 +
76 + - TCP connection: `redis://<user>:<password>@<host>:<port>/<db_number>`
77 - Unix connection: `unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>`
78 - name: timeout
75 - description: Dial (establishing new connections), read (socket reads) and write (socket writes) timeout in seconds.
79 + description: Dial (establishing new connections), read (socket reads), and write (socket writes) timeout (seconds).
80 default_value: 1
81 required: false
82 + group: Target
83 +
84 - name: username
79 - description: Username used for authentication.
85 + description: Username for authentication.
86 default_value: ""
87 required: false
88 + group: Auth
89 - name: password
83 - description: Password used for authentication.
90 + description: Password for authentication.
91 default_value: ""
92 required: false
93 + group: Auth
94 +
95 - name: tls_skip_verify
96 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
97 default_value: false
98 required: false
99 + group: TLS
100 - name: tls_ca
91 - description: Certificate authority that client use when verifying server certificates.
101 + description: Certification authority that the client uses when verifying the server’s certificates.
102 default_value: ""
103 required: false
104 + group: TLS
105 - name: tls_cert
95 - description: Client tls certificate.
106 + description: Client TLS certificate.
107 default_value: ""
108 required: false
109 + group: TLS
110 - name: tls_key
99 - description: Client tls key.
111 + description: Client TLS key.
112 + default_value: ""
113 + required: false
114 + group: TLS
115 +
116 + - name: vnode
117 + 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).
118 default_value: ""
119 required: false
120 + group: Virtual Node
121 examples:
122 folding:
123 title: Config
src/go/plugin/go.d/collector/ping/metadata.yaml
+27 -11
@@ -74,37 +74,53 @@ modules:
74 enabled: true
75 list:
76 - name: update_every
77 - description: Data collection frequency.
77 + description: Data collection interval (seconds).
78 default_value: 5
79 required: false
80 + group: Collection
81 - name: autodetection_retry
81 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
82 + description: Autodetection retry interval (seconds). Set 0 to disable.
83 default_value: 0
84 required: false
85 + group: Collection
86 +
87 - name: hosts
85 - description: Network hosts.
86 - default_value: ""
88 + description: List of hosts to ping.
89 + default_value: "[]"
90 required: true
91 + group: Target
92 +
93 - name: network
89 - description: "Allows configuration of DNS resolution. Supported options: ip (select IPv4 or IPv6), ip4 (select IPv4), ip6 (select IPv6)."
90 - default_value: "ip"
94 + description: "DNS resolution mode. Options: `ip` (IPv4 or IPv6), `ip4` (IPv4 only), `ip6` (IPv6 only)."
95 + default_value: ip
96 required: false
97 + group: Ping Settings
98 - name: interface
93 - description: "The network device name (e.g., `eth0`, `wlan0`) used as the source for ICMP echo requests."
99 + description: "Network interface to use for ICMP echo requests (e.g., `eth0`, `wlan0`)."
100 default_value: ""
101 required: false
102 + group: Ping Settings
103 - name: privileged
97 - description: Ping packets type. "yes" means raw ICMP ping, "no" - "unprivileged" UDP ping.
98 - default_value: true
104 + description: "Ping packet type. `yes` = raw ICMP ping, `no` = unprivileged UDP ping."
105 + default_value: yes
106 required: true
107 + group: Ping Settings
108 - name: packets
101 - description: Number of ping packets to send.
109 + description: Number of ping packets to send per iteration.
110 default_value: 5
111 required: false
112 + group: Ping Settings
113 - name: interval
105 - description: Timeout between sending ping packets.
114 + description: Interval between sending ping packets.
115 default_value: 100ms
116 required: false
117 + group: Ping Settings
118 +
119 + - name: vnode
120 + 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).
121 + default_value: ""
122 + required: false
123 + group: Virtual Node
124 examples:
125 folding:
126 title: Config
src/go/plugin/go.d/collector/portcheck/metadata.yaml
+21 -8
@@ -71,29 +71,42 @@ modules:
71 enabled: true
72 list:
73 - name: update_every
74 - description: Data collection frequency.
74 + description: Data collection frequency (seconds).
75 default_value: 5
76 required: false
77 + group: Collection
78 - name: autodetection_retry
78 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
79 + description: Autodetection retry interval (seconds). Set 0 to disable.
80 default_value: 0
81 required: false
82 + group: Collection
83 +
84 - name: host
82 - description: Remote host address in IPv4, IPv6 format, or DNS name.
85 + description: Remote host address (IPv4, IPv6, or DNS name).
86 default_value: ""
87 required: true
88 + group: Target
89 - name: ports
86 - description: Target TCP ports. Must be specified in numeric format.
87 - default_value: ""
90 + description: List of TCP ports to check (numeric format).
91 + default_value: "[]"
92 required: false
93 + group: Target
94 - name: udp_ports
90 - description: Target UDP ports. Must be specified in numeric format.
91 - default_value: ""
95 + description: List of UDP ports to check (numeric format).
96 + default_value: "[]"
97 required: false
98 + group: Target
99 - name: timeout
94 - description: HTTP request timeout.
100 + description: Port check timeout (seconds).
101 default_value: 2
102 required: false
103 + group: Target
104 +
105 + - name: vnode
106 + 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).
107 + default_value: ""
108 + required: false
109 + group: Virtual Node
110 examples:
111 folding:
112 title: Config
src/go/plugin/go.d/collector/postgres/metadata.yaml
+24 -8
@@ -82,33 +82,49 @@ modules:
82 enabled: true
83 list:
84 - name: update_every
85 - description: Data collection frequency.
86 - default_value: 5
85 + description: Data collection interval (seconds).
86 + default_value: 1
87 required: false
88 + group: Collection
89 - name: autodetection_retry
89 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
90 + description: Autodetection retry interval (seconds). Set 0 to disable.
91 default_value: 0
92 required: false
93 + group: Collection
94 +
95 - name: dsn
93 - description: Postgres server DSN (Data Source Name). See [DSN syntax](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING).
96 + description: Postgres connection string (DSN). See [DSN syntax](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING).
97 default_value: postgres://postgres:postgres@127.0.0.1:5432/postgres
98 required: true
99 + group: Target
100 - name: timeout
97 - description: Query timeout in seconds.
101 + description: Query timeout (seconds).
102 default_value: 2
103 required: false
104 + group: Target
105 +
106 - name: collect_databases_matching
101 - description: Databases selector. Determines which database metrics will be collected. Syntax is [simple patterns](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#simple-patterns-matcher).
107 + description: Database selector. Controls which databases are included. Uses [simple patterns](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#simple-patterns-matcher).
108 default_value: ""
109 required: false
110 + group: Filters
111 +
112 - name: max_db_tables
105 - description: Maximum number of tables in the database. Table metrics will not be collected for databases that have more tables than max_db_tables. 0 means no limit.
113 + description: Maximum number of tables per database to collect metrics for (0 = no limit).
114 default_value: 50
115 required: false
116 + group: Limits
117 - name: max_db_indexes
109 - description: Maximum number of indexes in the database. Index metrics will not be collected for databases that have more indexes than max_db_indexes. 0 means no limit.
118 + description: Maximum number of indexes per database to collect metrics for (0 = no limit).
119 default_value: 250
120 required: false
121 + group: Limits
122 +
123 + - name: vnode
124 + 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).
125 + default_value: ""
126 + required: false
127 + group: Virtual Node
128 examples:
129 folding:
130 title: Config
src/go/plugin/go.d/collector/powerdns/metadata.yaml
+68 -30
@@ -62,73 +62,111 @@ modules:
62 enabled: true
63 list:
64 - name: update_every
65 - description: Data collection frequency.
65 + description: Data collection interval (seconds).
66 default_value: 1
67 required: false
68 + group: Collection
69 - name: autodetection_retry
69 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
70 + description: Autodetection retry interval (seconds). Set 0 to disable.
71 default_value: 0
72 required: false
73 + group: Collection
74 +
75 - name: url
73 - description: Server URL.
76 + description: Target endpoint URL.
77 default_value: http://127.0.0.1:8081
78 required: true
79 + group: Target
80 - name: timeout
77 - description: HTTP request timeout.
81 + description: HTTP request timeout (seconds).
82 default_value: 1
83 required: false
84 + group: Target
85 +
86 - name: username
81 - description: Username for basic HTTP authentication.
87 + description: Username for Basic HTTP authentication.
88 default_value: ""
89 required: false
90 + group: HTTP Auth
91 - name: password
85 - description: Password for basic HTTP authentication.
92 + description: Password for Basic HTTP authentication.
93 default_value: ""
94 required: false
95 + group: HTTP Auth
96 + - name: bearer_token_file
97 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
98 + default_value: ""
99 + required: false
100 + group: HTTP Auth
101 +
102 + - name: tls_skip_verify
103 + description: Skip TLS certificate and hostname verification (insecure).
104 + default_value: no
105 + required: false
106 + group: TLS
107 + - name: tls_ca
108 + description: Path to CA bundle used to validate the server certificate.
109 + default_value: ""
110 + required: false
111 + group: TLS
112 + - name: tls_cert
113 + description: Path to client TLS certificate (for mTLS).
114 + default_value: ""
115 + required: false
116 + group: TLS
117 + - name: tls_key
118 + description: Path to client TLS private key (for mTLS).
119 + default_value: ""
120 + required: false
121 + group: TLS
122 +
123 - name: proxy_url
89 - description: Proxy URL.
124 + description: HTTP proxy URL.
125 default_value: ""
126 required: false
127 + group: Proxy
128 - name: proxy_username
93 - description: Username for proxy basic HTTP authentication.
129 + description: Username for proxy Basic HTTP authentication.
130 default_value: ""
131 required: false
132 + group: Proxy
133 - name: proxy_password
97 - description: Password for proxy basic HTTP authentication.
134 + description: Password for proxy Basic HTTP authentication.
135 default_value: ""
136 required: false
137 + group: Proxy
138 +
139 - name: method
101 - description: HTTP request method.
102 - default_value: GET
140 + description: HTTP method to use.
141 + default_value: "GET"
142 required: false
143 + group: Request
144 - name: body
105 - description: HTTP request body.
145 + description: Request body (e.g., for POST/PUT).
146 default_value: ""
147 required: false
148 + group: Request
149 - name: headers
109 - description: HTTP request headers.
150 + description: "Additional HTTP headers (one per line as key: value)."
151 default_value: ""
152 required: false
153 + group: Request
154 - name: not_follow_redirects
113 - description: Redirect handling policy. Controls whether the client follows redirects.
114 - default_value: false
115 - required: false
116 - - name: tls_skip_verify
117 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
118 - default_value: false
119 - required: false
120 - - name: tls_ca
121 - description: Certification authority that the client uses when verifying the server's certificates.
122 - default_value: ""
123 - required: false
124 - - name: tls_cert
125 - description: Client TLS certificate.
126 - default_value: ""
127 - required: false
128 - - name: tls_key
129 - description: Client TLS key.
155 + description: Do not follow HTTP redirects.
156 + default_value: no
157 + required: false
158 + group: Request
159 + - name: force_http2
160 + description: Force HTTP/2 (including h2c over TCP).
161 + default_value: no
162 + required: false
163 + group: Request
164 +
165 + - name: vnode
166 + 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).
167 default_value: ""
168 required: false
169 + group: Virtual Node
170 examples:
171 folding:
172 title: Config
src/go/plugin/go.d/collector/powerdns_recursor/metadata.yaml
+67 -29
@@ -63,73 +63,111 @@ modules:
63 enabled: true
64 list:
65 - name: update_every
66 - description: Data collection frequency.
67 - default_value: 5
66 + description: Data collection interval (seconds).
67 + default_value: 1
68 required: false
69 + group: Collection
70 - name: autodetection_retry
70 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
71 + description: Autodetection retry interval (seconds). Set 0 to disable.
72 default_value: 0
73 required: false
74 + group: Collection
75 +
76 - name: url
74 - description: Server URL.
77 + description: Target endpoint URL.
78 default_value: http://127.0.0.1:8081
79 required: true
80 + group: Target
81 - name: timeout
78 - description: HTTP request timeout.
82 + description: HTTP request timeout (seconds).
83 default_value: 1
84 required: false
85 + group: Target
86 +
87 - name: username
82 - description: Username for basic HTTP authentication.
88 + description: Username for Basic HTTP authentication.
89 default_value: ""
90 required: false
91 + group: HTTP Auth
92 - name: password
86 - description: Password for basic HTTP authentication.
93 + description: Password for Basic HTTP authentication.
94 + default_value: ""
95 + required: false
96 + group: HTTP Auth
97 + - name: bearer_token_file
98 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
99 + default_value: ""
100 + required: false
101 + group: HTTP Auth
102 +
103 + - name: tls_skip_verify
104 + description: Skip TLS certificate and hostname verification (insecure).
105 + default_value: no
106 + required: false
107 + group: TLS
108 + - name: tls_ca
109 + description: Path to CA bundle used to validate the server certificate.
110 + default_value: ""
111 + required: false
112 + group: TLS
113 + - name: tls_cert
114 + description: Path to client TLS certificate (for mTLS).
115 default_value: ""
116 required: false
117 + group: TLS
118 + - name: tls_key
119 + description: Path to client TLS private key (for mTLS).
120 + default_value: ""
121 + required: false
122 + group: TLS
123 +
124 - name: proxy_url
90 - description: Proxy URL.
125 + description: HTTP proxy URL.
126 default_value: ""
127 required: false
128 + group: Proxy
129 - name: proxy_username
94 - description: Username for proxy basic HTTP authentication.
130 + description: Username for proxy Basic HTTP authentication.
131 default_value: ""
132 required: false
133 + group: Proxy
134 - name: proxy_password
98 - description: Password for proxy basic HTTP authentication.
135 + description: Password for proxy Basic HTTP authentication.
136 default_value: ""
137 required: false
138 + group: Proxy
139 +
140 - name: method
102 - description: HTTP request method.
103 - default_value: GET
141 + description: HTTP method to use.
142 + default_value: "GET"
143 required: false
144 + group: Request
145 - name: body
106 - description: HTTP request body.
146 + description: Request body (e.g., for POST/PUT).
147 default_value: ""
148 required: false
149 + group: Request
150 - name: headers
110 - description: HTTP request headers.
151 + description: "Additional HTTP headers (one per line as key: value)."
152 default_value: ""
153 required: false
154 + group: Request
155 - name: not_follow_redirects
114 - description: Redirect handling policy. Controls whether the client follows redirects.
115 - default_value: false
156 + description: Do not follow HTTP redirects.
157 + default_value: no
158 required: false
117 - - name: tls_skip_verify
118 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
119 - default_value: false
159 + group: Request
160 + - name: force_http2
161 + description: Force HTTP/2 (including h2c over TCP).
162 + default_value: no
163 required: false
121 - - name: tls_ca
122 - description: Certification authority that the client uses when verifying the server's certificates.
123 - default_value: ""
124 - required: false
125 - - name: tls_cert
126 - description: Client TLS certificate.
127 - default_value: ""
128 - required: false
129 - - name: tls_key
130 - description: Client TLS key.
164 + group: Request
165 +
166 + - name: vnode
167 + 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).
168 default_value: ""
169 required: false
170 + group: Virtual Node
171 examples:
172 folding:
173 title: Config
src/go/plugin/go.d/collector/prometheus/metadata.yaml
+86 -38
@@ -55,21 +55,32 @@ modules:
55 enabled: true
56 list:
57 - name: update_every
58 - description: Data collection frequency.
58 + description: Data collection interval (seconds).
59 default_value: 10
60 required: false
61 + group: Collection
62 - name: autodetection_retry
62 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
63 + description: Autodetection retry interval (seconds). Set 0 to disable.
64 default_value: 0
65 required: false
66 + group: Collection
67 +
68 - name: url
66 - description: Server URL.
69 + description: Target endpoint URL.
70 default_value: ""
71 required: true
72 + group: Target
73 + - name: timeout
74 + description: HTTP request timeout (seconds).
75 + default_value: 10
76 + required: false
77 + group: Target
78 +
79 - name: selector
80 description: Time series selector (filter).
81 default_value: ""
82 required: false
83 + group: Filters
84 detailed_description: |
85 This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
86
@@ -86,10 +97,24 @@ modules:
97 - pattern3
98 - pattern4
99 ```
100 +
101 + - name: max_time_series
102 + description: Global time series limit. If an endpoint returns more time series than this, the data is not processed.
103 + default_value: 2000
104 + required: false
105 + group: Limits
106 +
107 + - name: max_time_series_per_metric
108 + description: Per-metric time series limit. Metrics with more time series than this are skipped.
109 + default_value: 200
110 + required: false
111 + group: Limits
112 +
113 - name: fallback_type
90 - description: Time series selector (filter).
114 + description: Fallback type rules for untyped metrics.
115 default_value: ""
116 required: false
117 + group: Customization
118 detailed_description: |
119 This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
120
@@ -105,74 +130,97 @@ modules:
130 - metric_name_pattern3
131 - metric_name_pattern4
132 ```
108 - - name: max_time_series
109 - description: Global time series limit. If an endpoint returns number of time series > limit the data is not processed.
110 - default_value: 2000
111 - required: false
112 - - name: max_time_series_per_metric
113 - description: Time series per metric (metric name) limit. Metrics with number of time series > limit are skipped.
114 - default_value: 200
115 - required: false
133 +
134 - name: label_prefix
117 - description: "An optional prefix that will be added to all labels of all charts. If set, the label names will be automatically formatted as `prefix_name` (the prefix followed by an underscore and the original name)."
135 + description: "Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`."
136 default_value: ""
137 required: false
120 - - name: timeout
121 - description: HTTP request timeout.
122 - default_value: 10
123 - required: false
138 + group: Customization
139 +
140 - name: username
125 - description: Username for basic HTTP authentication.
141 + description: Username for Basic HTTP authentication.
142 default_value: ""
143 required: false
144 + group: HTTP Auth
145 - name: password
129 - description: Password for basic HTTP authentication.
146 + description: Password for Basic HTTP authentication.
147 default_value: ""
148 required: false
149 + group: HTTP Auth
150 + - name: bearer_token_file
151 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
152 + default_value: ""
153 + required: false
154 + group: HTTP Auth
155 +
156 + - name: tls_skip_verify
157 + description: Skip TLS certificate and hostname verification (insecure).
158 + default_value: no
159 + required: false
160 + group: TLS
161 + - name: tls_ca
162 + description: Path to CA bundle used to validate the server certificate.
163 + default_value: ""
164 + required: false
165 + group: TLS
166 + - name: tls_cert
167 + description: Path to client TLS certificate (for mTLS).
168 + default_value: ""
169 + required: false
170 + group: TLS
171 + - name: tls_key
172 + description: Path to client TLS private key (for mTLS).
173 + default_value: ""
174 + required: false
175 + group: TLS
176 +
177 - name: proxy_url
133 - description: Proxy URL.
178 + description: HTTP proxy URL.
179 default_value: ""
180 required: false
181 + group: Proxy
182 - name: proxy_username
137 - description: Username for proxy basic HTTP authentication.
183 + description: Username for proxy Basic HTTP authentication.
184 default_value: ""
185 required: false
186 + group: Proxy
187 - name: proxy_password
141 - description: Password for proxy basic HTTP authentication.
188 + description: Password for proxy Basic HTTP authentication.
189 default_value: ""
190 required: false
191 + group: Proxy
192 +
193 - name: method
145 - description: HTTP request method.
194 + description: HTTP method to use.
195 default_value: "GET"
196 required: false
197 + group: Request
198 - name: body
149 - description: HTTP request body.
199 + description: Request body (e.g., for POST/PUT).
200 default_value: ""
201 required: false
202 + group: Request
203 - name: headers
153 - description: HTTP request headers.
204 + description: "Additional HTTP headers (one per line as key: value)."
205 default_value: ""
206 required: false
207 + group: Request
208 - name: not_follow_redirects
157 - description: Redirect handling policy. Controls whether the client follows redirects.
209 + description: Do not follow HTTP redirects.
210 default_value: no
211 required: false
160 - - name: tls_skip_verify
161 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
212 + group: Request
213 + - name: force_http2
214 + description: Force HTTP/2 (including h2c over TCP).
215 default_value: no
216 required: false
164 - - name: tls_ca
165 - description: Certification authority that the client uses when verifying the server's certificates.
166 - default_value: ""
167 - required: false
168 - - name: tls_cert
169 - description: Client TLS certificate.
170 - default_value: ""
171 - required: false
172 - - name: tls_key
173 - description: Client TLS key.
217 + group: Request
218 +
219 + - name: vnode
220 + 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).
221 default_value: ""
222 required: false
223 + group: Virtual Node
224 examples:
225 folding:
226 title: Config
src/go/plugin/go.d/collector/proxysql/metadata.yaml
+15 -4
@@ -52,21 +52,32 @@ modules:
52 enabled: true
53 list:
54 - name: update_every
55 - description: Data collection frequency.
55 + description: Data collection frequency (seconds).
56 default_value: 1
57 required: false
58 + group: Collection
59 - name: autodetection_retry
59 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
60 + description: Autodetection retry interval (seconds). Set 0 to disable.
61 default_value: 0
62 required: false
63 + group: Collection
64 +
65 - name: dsn
63 - description: Data Source Name. See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name).
66 + description: ProxySQL server DSN (Data Source Name). See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name).
67 default_value: stats:stats@tcp(127.0.0.1:6032)/
68 required: true
69 + group: Target
70 - name: timeout
67 - description: Query timeout in seconds.
71 + description: Query timeout (seconds).
72 default_value: 1
73 required: false
74 + group: Target
75 +
76 + - name: vnode
77 + 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).
78 + default_value: ""
79 + required: false
80 + group: Virtual Node
81 examples:
82 folding:
83 title: Config
src/go/plugin/go.d/collector/pulsar/metadata.yaml
+66 -28
@@ -54,73 +54,111 @@ modules:
54 enabled: true
55 list:
56 - name: update_every
57 - description: Data collection frequency.
58 - default_value: 1
57 + description: Data collection interval (seconds).
58 + default_value: 60
59 required: false
60 + group: Collection
61 - name: autodetection_retry
61 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
62 + description: Autodetection retry interval (seconds). Set 0 to disable.
63 default_value: 0
64 required: false
65 + group: Collection
66 +
67 - name: url
65 - description: Server URL.
68 + description: Target endpoint URL.
69 default_value: http://127.0.0.1:8080/metrics
70 required: true
71 + group: Target
72 - name: timeout
69 - description: HTTP request timeout.
70 - default_value: 1
73 + description: HTTP request timeout (seconds).
74 + default_value: 5
75 required: false
76 + group: Target
77 +
78 - name: username
73 - description: Username for basic HTTP authentication.
79 + description: Username for Basic HTTP authentication.
80 default_value: ""
81 required: false
82 + group: HTTP Auth
83 - name: password
77 - description: Password for basic HTTP authentication.
84 + description: Password for Basic HTTP authentication.
85 default_value: ""
86 required: false
87 + group: HTTP Auth
88 + - name: bearer_token_file
89 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
90 + default_value: ""
91 + required: false
92 + group: HTTP Auth
93 +
94 + - name: tls_skip_verify
95 + description: Skip TLS certificate and hostname verification (insecure).
96 + default_value: no
97 + required: false
98 + group: TLS
99 + - name: tls_ca
100 + description: Path to CA bundle used to validate the server certificate.
101 + default_value: ""
102 + required: false
103 + group: TLS
104 + - name: tls_cert
105 + description: Path to client TLS certificate (for mTLS).
106 + default_value: ""
107 + required: false
108 + group: TLS
109 + - name: tls_key
110 + description: Path to client TLS private key (for mTLS).
111 + default_value: ""
112 + required: false
113 + group: TLS
114 +
115 - name: proxy_url
81 - description: Proxy URL.
116 + description: HTTP proxy URL.
117 default_value: ""
118 required: false
119 + group: Proxy
120 - name: proxy_username
85 - description: Username for proxy basic HTTP authentication.
121 + description: Username for proxy Basic HTTP authentication.
122 default_value: ""
123 required: false
124 + group: Proxy
125 - name: proxy_password
89 - description: Password for proxy basic HTTP authentication.
126 + description: Password for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
129 + group: Proxy
130 +
131 - name: method
93 - description: HTTP request method.
94 - default_value: GET
132 + description: HTTP method to use.
133 + default_value: "GET"
134 required: false
135 + group: Request
136 - name: body
97 - description: HTTP request body.
137 + description: Request body (e.g., for POST/PUT).
138 default_value: ""
139 required: false
140 + group: Request
141 - name: headers
101 - description: HTTP request headers.
142 + description: "Additional HTTP headers (one per line as key: value)."
143 default_value: ""
144 required: false
145 + group: Request
146 - name: not_follow_redirects
105 - description: Redirect handling policy. Controls whether the client follows redirects.
147 + description: Do not follow HTTP redirects.
148 default_value: no
149 required: false
108 - - name: tls_skip_verify
109 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
150 + group: Request
151 + - name: force_http2
152 + description: Force HTTP/2 (including h2c over TCP).
153 default_value: no
154 required: false
112 - - name: tls_ca
113 - description: Certification authority that the client uses when verifying the server's certificates.
114 - default_value: ""
115 - required: false
116 - - name: tls_cert
117 - description: Client TLS certificate.
118 - default_value: ""
119 - required: false
120 - - name: tls_key
121 - description: Client TLS key.
155 + group: Request
156 +
157 + - name: vnode
158 + 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).
159 default_value: ""
160 required: false
161 + group: Virtual Node
162 examples:
163 folding:
164 title: Config
src/go/plugin/go.d/collector/puppet/metadata.yaml
+72 -26
@@ -54,66 +54,112 @@ modules:
54 title: ""
55 enabled: true
56 list:
57 + - name: update_every
58 + description: Data collection interval (seconds).
59 + default_value: 1
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: url
58 - description: The base URL where the Puppet instance can be accessed.
69 + description: Target endpoint URL.
70 default_value: https://127.0.0.1:8140
71 required: true
72 + group: Target
73 - name: timeout
62 - description: HTTPS request timeout.
74 + description: HTTP request timeout (seconds).
75 default_value: 1
76 required: false
77 + group: Target
78 +
79 - name: username
66 - description: Username for basic HTTPS authentication.
80 + description: Username for Basic HTTP authentication.
81 default_value: ""
82 required: false
83 + group: HTTP Auth
84 - name: password
70 - description: Password for basic HTTPS authentication.
85 + description: Password for Basic HTTP authentication.
86 + default_value: ""
87 + required: false
88 + group: HTTP Auth
89 + - name: bearer_token_file
90 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
91 + default_value: ""
92 + required: false
93 + group: HTTP Auth
94 +
95 + - name: tls_skip_verify
96 + description: Skip TLS certificate and hostname verification (insecure).
97 + default_value: no
98 + required: false
99 + group: TLS
100 + - name: tls_ca
101 + description: Path to CA bundle used to validate the server certificate.
102 + default_value: ""
103 + required: false
104 + group: TLS
105 + - name: tls_cert
106 + description: Path to client TLS certificate (for mTLS).
107 + default_value: ""
108 + required: false
109 + group: TLS
110 + - name: tls_key
111 + description: Path to client TLS private key (for mTLS).
112 default_value: ""
113 required: false
114 + group: TLS
115 +
116 - name: proxy_url
74 - description: Proxy URL.
117 + description: HTTP proxy URL.
118 default_value: ""
119 required: false
120 + group: Proxy
121 - name: proxy_username
78 - description: Username for proxy basic HTTPS authentication.
122 + description: Username for proxy Basic HTTP authentication.
123 default_value: ""
124 required: false
125 + group: Proxy
126 - name: proxy_password
82 - description: Password for proxy basic HTTPS authentication.
127 + description: Password for proxy Basic HTTP authentication.
128 default_value: ""
129 required: false
130 + group: Proxy
131 +
132 - name: method
86 - description: HTTPS request method.
87 - default_value: POST
133 + description: HTTP method to use.
134 + default_value: "GET"
135 required: false
136 + group: Request
137 - name: body
90 - description: HTTPS request body.
138 + description: Request body (e.g., for POST/PUT).
139 default_value: ""
140 required: false
141 + group: Request
142 - name: headers
94 - description: HTTPS request headers.
143 + description: "Additional HTTP headers (one per line as key: value)."
144 default_value: ""
145 required: false
146 + group: Request
147 - name: not_follow_redirects
98 - description: Redirect handling policy. Controls whether the client follows redirects.
99 - default_value: false
148 + description: Do not follow HTTP redirects.
149 + default_value: no
150 required: false
101 - - name: tls_skip_verify
102 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
103 - default_value: false
151 + group: Request
152 + - name: force_http2
153 + description: Force HTTP/2 (including h2c over TCP).
154 + default_value: no
155 required: false
105 - - name: tls_ca
106 - description: Certification authority that the client uses when verifying the server's certificates.
107 - default_value: ""
108 - required: false
109 - - name: tls_cert
110 - description: Client TLS certificate.
111 - default_value: ""
112 - required: false
113 - - name: tls_key
114 - description: Client TLS key.
156 + group: Request
157 +
158 + - name: vnode
159 + 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).
160 default_value: ""
161 required: false
162 + group: Virtual Node
163 examples:
164 folding:
165 enabled: true
src/go/plugin/go.d/collector/rabbitmq/metadata.yaml
+74 -34
@@ -64,77 +64,117 @@ modules:
64 enabled: true
65 list:
66 - name: update_every
67 - description: Data collection frequency.
67 + description: Data collection interval (seconds).
68 default_value: 1
69 required: false
70 + group: Collection
71 - name: autodetection_retry
71 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
72 + description: Autodetection retry interval (seconds). Set 0 to disable.
73 default_value: 0
74 required: false
75 + group: Collection
76 +
77 - name: url
75 - description: Server URL.
76 - default_value: http://localhost:15672
78 + description: Target endpoint URL.
79 + default_value: http://localhost:15672"
80 required: true
78 - - name: collect_queues_metrics
79 - description: Collect stats per vhost per queues. Enabling this can introduce serious overhead on both Netdata and RabbitMQ if many queues are configured and used.
80 - default_value: false
81 - required: false
81 + group: Target
82 - name: timeout
83 - description: HTTP request timeout.
83 + description: HTTP request timeout (seconds).
84 default_value: 1
85 required: false
86 + group: Target
87 +
88 + - name: collect_queues_metrics
89 + description: Collect per-vhost, per-queue metrics. May cause significant overhead if many queues exist.
90 + default_value: no
91 + required: false
92 + group: Metrics Selection
93 +
94 - name: username
87 - description: Username for basic HTTP authentication.
88 - default_value: ""
95 + description: Username for Basic HTTP authentication.
96 + default_value: "guest"
97 required: false
98 + group: HTTP Auth
99 - name: password
91 - description: Password for basic HTTP authentication.
100 + description: Password for Basic HTTP authentication.
101 + default_value: "guest"
102 + required: false
103 + group: HTTP Auth
104 + - name: bearer_token_file
105 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
106 default_value: ""
107 required: false
108 + group: HTTP Auth
109 +
110 + - name: tls_skip_verify
111 + description: Skip TLS certificate and hostname verification (insecure).
112 + default_value: no
113 + required: false
114 + group: TLS
115 + - name: tls_ca
116 + description: Path to CA bundle used to validate the server certificate.
117 + default_value: ""
118 + required: false
119 + group: TLS
120 + - name: tls_cert
121 + description: Path to client TLS certificate (for mTLS).
122 + default_value: ""
123 + required: false
124 + group: TLS
125 + - name: tls_key
126 + description: Path to client TLS private key (for mTLS).
127 + default_value: ""
128 + required: false
129 + group: TLS
130 +
131 - name: proxy_url
95 - description: Proxy URL.
132 + description: HTTP proxy URL.
133 default_value: ""
134 required: false
135 + group: Proxy
136 - name: proxy_username
99 - description: Username for proxy basic HTTP authentication.
137 + description: Username for proxy Basic HTTP authentication.
138 default_value: ""
139 required: false
140 + group: Proxy
141 - name: proxy_password
103 - description: Password for proxy basic HTTP authentication.
142 + description: Password for proxy Basic HTTP authentication.
143 default_value: ""
144 required: false
145 + group: Proxy
146 +
147 - name: method
107 - description: HTTP request method.
108 - default_value: GET
148 + description: HTTP method to use.
149 + default_value: "GET"
150 required: false
151 + group: Request
152 - name: body
111 - description: HTTP request body.
153 + description: Request body (e.g., for POST/PUT).
154 default_value: ""
155 required: false
156 + group: Request
157 - name: headers
115 - description: HTTP request headers.
158 + description: "Additional HTTP headers (one per line as key: value)."
159 default_value: ""
160 required: false
161 + group: Request
162 - name: not_follow_redirects
119 - description: Redirect handling policy. Controls whether the client follows redirects.
120 - default_value: false
121 - required: false
122 - - name: tls_skip_verify
123 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
124 - default_value: false
163 + description: Do not follow HTTP redirects.
164 + default_value: no
165 required: false
126 - - name: tls_ca
127 - description: Certification authority that the client uses when verifying the server's certificates.
128 - default_value: ""
129 - required: false
130 - - name: tls_cert
131 - description: Client TLS certificate.
132 - default_value: ""
166 + group: Request
167 + - name: force_http2
168 + description: Force HTTP/2 (including h2c over TCP).
169 + default_value: no
170 required: false
134 - - name: tls_key
135 - description: Client TLS key.
171 + group: Request
172 +
173 + - name: vnode
174 + 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).
175 default_value: ""
176 required: false
177 + group: Virtual Node
178 examples:
179 folding:
180 title: Config
src/go/plugin/go.d/collector/redis/metadata.yaml
+33 -14
@@ -66,50 +66,69 @@ modules:
66 enabled: true
67 list:
68 - name: update_every
69 - description: Data collection frequency.
69 + description: Data collection interval (seconds).
70 default_value: 5
71 required: false
72 + group: Collection
73 - name: autodetection_retry
73 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
74 + description: Autodetection retry interval (seconds). Set 0 to disable.
75 default_value: 0
76 required: false
77 + group: Collection
78 +
79 - name: address
77 - description: Redis server address.
80 + description: Redis server address (TCP or Unix socket).
81 default_value: redis://@localhost:6379
82 required: true
83 + group: Target
84 details: |
81 - There are two connection types: by tcp socket and by unix socket.
85 + There are two connection types: TCP socket and Unix socket.
86
83 - - Tcp connection: `redis://<user>:<password>@<host>:<port>/<db_number>`
84 - - Unix connection: `unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>`
87 + - TCP: `redis://<user>:<password>@<host>:<port>/<db_number>`
88 + - Unix: `unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>`
89 - name: timeout
86 - description: Dial (establishing new connections), read (socket reads) and write (socket writes) timeout in seconds.
90 + description: Dial, read, and write timeout (seconds).
91 default_value: 1
92 required: false
93 + group: Target
94 +
95 - name: username
90 - description: Username used for authentication.
96 + description: Username for authentication.
97 default_value: ""
98 required: false
99 + group: Auth
100 - name: password
94 - description: Password used for authentication.
101 + description: Password for authentication.
102 default_value: ""
103 required: false
104 + group: Auth
105 +
106 - name: tls_skip_verify
98 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
99 - default_value: false
107 + description: Skip TLS certificate and hostname verification (insecure).
108 + default_value: no
109 required: false
110 + group: TLS
111 - name: tls_ca
102 - description: Certificate authority that client use when verifying server certificates.
112 + description: Path to CA bundle used to validate the server certificate.
113 default_value: ""
114 required: false
115 + group: TLS
116 - name: tls_cert
106 - description: Client tls certificate.
117 + description: Path to client TLS certificate (for mTLS).
118 default_value: ""
119 required: false
120 + group: TLS
121 - name: tls_key
110 - description: Client tls key.
122 + description: Path to client TLS private key (for mTLS).
123 default_value: ""
124 required: false
125 + group: TLS
126 +
127 + - name: vnode
128 + 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).
129 + default_value: ""
130 + required: false
131 + group: Virtual Node
132 examples:
133 folding:
134 title: Config
src/go/plugin/go.d/collector/rethinkdb/metadata.yaml
+20 -6
@@ -55,29 +55,43 @@ modules:
55 enabled: true
56 list:
57 - name: update_every
58 - description: Data collection frequency.
58 + description: Data collection frequency (seconds).
59 default_value: 1
60 required: false
61 + group: Collection
62 - name: autodetection_retry
62 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
63 + description: Autodetection retry interval (seconds). Set 0 to disable.
64 default_value: 0
65 required: false
66 + group: Collection
67 +
68 - name: address
66 - description: The IP address and port where the RethinkDB service listens for connections.
69 + description: RethinkDB server address (IP:PORT).
70 default_value: 127.0.0.1:28015
71 required: true
72 + group: Target
73 - name: timeout
70 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
74 + description: Connection, read, and write timeout duration (seconds). Includes name resolution.
75 default_value: 1
76 required: false
77 + group: Target
78 +
79 - name: username
74 - description: Username used for authentication.
80 + description: Username for authentication.
81 default_value: ""
82 required: false
83 + group: Auth
84 - name: password
78 - description: Password used for authentication.
85 + description: Password for authentication.
86 + default_value: ""
87 + required: false
88 + group: Auth
89 +
90 + - name: vnode
91 + 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).
92 default_value: ""
93 required: false
94 + group: Virtual Node
95 examples:
96 folding:
97 title: Config
src/go/plugin/go.d/collector/riakkv/metadata.yaml
+67 -29
@@ -61,73 +61,111 @@ modules:
61 enabled: true
62 list:
63 - name: update_every
64 - description: Data collection frequency.
65 - default_value: 1
64 + description: Data collection interval (seconds).
65 + default_value: 2
66 required: false
67 + group: Collection
68 - name: autodetection_retry
68 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
69 + description: Autodetection retry interval (seconds). Set 0 to disable.
70 default_value: 0
71 required: false
72 + group: Collection
73 +
74 - name: url
72 - description: Server URL.
75 + description: Target endpoint URL.
76 default_value: http://127.0.0.1:8098/stats
77 required: true
78 + group: Target
79 - name: timeout
76 - description: HTTP request timeout.
80 + description: HTTP request timeout (seconds).
81 default_value: 1
82 required: false
83 + group: Target
84 +
85 - name: username
80 - description: Username for basic HTTP authentication.
86 + description: Username for Basic HTTP authentication.
87 default_value: ""
88 required: false
89 + group: HTTP Auth
90 - name: password
84 - description: Password for basic HTTP authentication.
91 + description: Password for Basic HTTP authentication.
92 + default_value: ""
93 + required: false
94 + group: HTTP Auth
95 + - name: bearer_token_file
96 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
97 + default_value: ""
98 + required: false
99 + group: HTTP Auth
100 +
101 + - name: tls_skip_verify
102 + description: Skip TLS certificate and hostname verification (insecure).
103 + default_value: no
104 + required: false
105 + group: TLS
106 + - name: tls_ca
107 + description: Path to CA bundle used to validate the server certificate.
108 + default_value: ""
109 + required: false
110 + group: TLS
111 + - name: tls_cert
112 + description: Path to client TLS certificate (for mTLS).
113 default_value: ""
114 required: false
115 + group: TLS
116 + - name: tls_key
117 + description: Path to client TLS private key (for mTLS).
118 + default_value: ""
119 + required: false
120 + group: TLS
121 +
122 - name: proxy_url
88 - description: Proxy URL.
123 + description: HTTP proxy URL.
124 default_value: ""
125 required: false
126 + group: Proxy
127 - name: proxy_username
92 - description: Username for proxy basic HTTP authentication.
128 + description: Username for proxy Basic HTTP authentication.
129 default_value: ""
130 required: false
131 + group: Proxy
132 - name: proxy_password
96 - description: Password for proxy basic HTTP authentication.
133 + description: Password for proxy Basic HTTP authentication.
134 default_value: ""
135 required: false
136 + group: Proxy
137 +
138 - name: method
100 - description: HTTP request method.
101 - default_value: GET
139 + description: HTTP method to use.
140 + default_value: "GET"
141 required: false
142 + group: Request
143 - name: body
104 - description: HTTP request body.
144 + description: Request body (e.g., for POST/PUT).
145 default_value: ""
146 required: false
147 + group: Request
148 - name: headers
108 - description: HTTP request headers.
149 + description: "Additional HTTP headers (one per line as key: value)."
150 default_value: ""
151 required: false
152 + group: Request
153 - name: not_follow_redirects
112 - description: Redirect handling policy. Controls whether the client follows redirects.
113 - default_value: false
114 - required: false
115 - - name: tls_skip_verify
116 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
117 - default_value: false
154 + description: Do not follow HTTP redirects.
155 + default_value: no
156 required: false
119 - - name: tls_ca
120 - description: Certification authority that the client uses when verifying the server's certificates.
121 - default_value: ""
157 + group: Request
158 + - name: force_http2
159 + description: Force HTTP/2 (including h2c over TCP).
160 + default_value: no
161 required: false
123 - - name: tls_cert
124 - description: Client TLS certificate.
125 - default_value: ""
126 - required: false
127 - - name: tls_key
128 - description: Client TLS key.
162 + group: Request
163 +
164 + - name: vnode
165 + 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).
166 default_value: ""
167 required: false
168 + group: Virtual Node
169 examples:
170 folding:
171 title: Config
src/go/plugin/go.d/collector/rspamd/metadata.yaml
+66 -28
@@ -59,73 +59,111 @@ modules:
59 enabled: true
60 list:
61 - name: update_every
62 - description: Data collection frequency.
62 + description: Data collection interval (seconds).
63 default_value: 1
64 required: false
65 + group: Collection
66 - name: autodetection_retry
66 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
67 + description: Autodetection retry interval (seconds). Set 0 to disable.
68 default_value: 0
69 required: false
70 + group: Collection
71 +
72 - name: url
70 - description: Server URL.
73 + description: Target endpoint URL.
74 default_value: http://127.0.0.1:11334
75 required: true
76 + group: Target
77 - name: timeout
74 - description: HTTP request timeout.
78 + description: HTTP request timeout (seconds).
79 default_value: 1
80 required: false
81 + group: Target
82 +
83 - name: username
78 - description: Username for basic HTTP authentication.
84 + description: Username for Basic HTTP authentication.
85 default_value: ""
86 required: false
87 + group: HTTP Auth
88 - name: password
82 - description: Password for basic HTTP authentication.
89 + description: Password for Basic HTTP authentication.
90 default_value: ""
91 required: false
92 + group: HTTP Auth
93 + - name: bearer_token_file
94 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
95 + default_value: ""
96 + required: false
97 + group: HTTP Auth
98 +
99 + - name: tls_skip_verify
100 + description: Skip TLS certificate and hostname verification (insecure).
101 + default_value: no
102 + required: false
103 + group: TLS
104 + - name: tls_ca
105 + description: Path to CA bundle used to validate the server certificate.
106 + default_value: ""
107 + required: false
108 + group: TLS
109 + - name: tls_cert
110 + description: Path to client TLS certificate (for mTLS).
111 + default_value: ""
112 + required: false
113 + group: TLS
114 + - name: tls_key
115 + description: Path to client TLS private key (for mTLS).
116 + default_value: ""
117 + required: false
118 + group: TLS
119 +
120 - name: proxy_url
86 - description: Proxy URL.
121 + description: HTTP proxy URL.
122 default_value: ""
123 required: false
124 + group: Proxy
125 - name: proxy_username
90 - description: Username for proxy basic HTTP authentication.
126 + description: Username for proxy Basic HTTP authentication.
127 default_value: ""
128 required: false
129 + group: Proxy
130 - name: proxy_password
94 - description: Password for proxy basic HTTP authentication.
131 + description: Password for proxy Basic HTTP authentication.
132 default_value: ""
133 required: false
134 + group: Proxy
135 +
136 - name: method
98 - description: HTTP request method.
99 - default_value: GET
137 + description: HTTP method to use.
138 + default_value: "GET"
139 required: false
140 + group: Request
141 - name: body
102 - description: HTTP request body.
142 + description: Request body (e.g., for POST/PUT).
143 default_value: ""
144 required: false
145 + group: Request
146 - name: headers
106 - description: HTTP request headers.
147 + description: "Additional HTTP headers (one per line as key: value)."
148 default_value: ""
149 required: false
150 + group: Request
151 - name: not_follow_redirects
110 - description: Redirect handling policy. Controls whether the client follows redirects.
111 - default_value: false
112 - required: false
113 - - name: tls_skip_verify
114 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
115 - default_value: false
116 - required: false
117 - - name: tls_ca
118 - description: Certification authority that the client uses when verifying the server's certificates.
119 - default_value: ""
152 + description: Do not follow HTTP redirects.
153 + default_value: no
154 required: false
121 - - name: tls_cert
122 - description: Client TLS certificate.
123 - default_value: ""
155 + group: Request
156 + - name: force_http2
157 + description: Force HTTP/2 (including h2c over TCP).
158 + default_value: no
159 required: false
125 - - name: tls_key
126 - description: Client TLS key.
160 + group: Request
161 +
162 + - name: vnode
163 + 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).
164 default_value: ""
165 required: false
166 + group: Virtual Node
167 examples:
168 folding:
169 title: Config
src/go/plugin/go.d/collector/scaleio/metadata.yaml
+70 -32
@@ -56,73 +56,111 @@ modules:
56 enabled: true
57 list:
58 - name: update_every
59 - description: Data collection frequency.
60 - default_value: 5
59 + description: Data collection interval (seconds).
60 + default_value: 1
61 required: false
62 + group: Collection
63 - name: autodetection_retry
63 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
64 + description: Autodetection retry interval (seconds). Set 0 to disable.
65 default_value: 0
66 required: false
67 + group: Collection
68 +
69 - name: url
67 - description: Server URL.
68 - default_value: https://127.0.0.1:80
70 + description: Target endpoint URL.
71 + default_value: https://127.0.0.1
72 required: true
73 + group: Target
74 - name: timeout
71 - description: HTTP request timeout.
75 + description: HTTP request timeout (seconds).
76 default_value: 1
77 required: false
78 + group: Target
79 +
80 - name: username
75 - description: Username for basic HTTP authentication.
81 + description: Username for Basic HTTP authentication.
82 default_value: ""
77 - required: true
83 + required: false
84 + group: HTTP Auth
85 - name: password
79 - description: Password for basic HTTP authentication.
86 + description: Password for Basic HTTP authentication.
87 default_value: ""
81 - required: true
88 + required: false
89 + group: HTTP Auth
90 + - name: bearer_token_file
91 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
92 + default_value: ""
93 + required: false
94 + group: HTTP Auth
95 +
96 + - name: tls_skip_verify
97 + description: Skip TLS certificate and hostname verification (insecure).
98 + default_value: no
99 + required: false
100 + group: TLS
101 + - name: tls_ca
102 + description: Path to CA bundle used to validate the server certificate.
103 + default_value: ""
104 + required: false
105 + group: TLS
106 + - name: tls_cert
107 + description: Path to client TLS certificate (for mTLS).
108 + default_value: ""
109 + required: false
110 + group: TLS
111 + - name: tls_key
112 + description: Path to client TLS private key (for mTLS).
113 + default_value: ""
114 + required: false
115 + group: TLS
116 +
117 - name: proxy_url
83 - description: Proxy URL.
118 + description: HTTP proxy URL.
119 default_value: ""
120 required: false
121 + group: Proxy
122 - name: proxy_username
87 - description: Username for proxy basic HTTP authentication.
123 + description: Username for proxy Basic HTTP authentication.
124 default_value: ""
125 required: false
126 + group: Proxy
127 - name: proxy_password
91 - description: Password for proxy basic HTTP authentication.
128 + description: Password for proxy Basic HTTP authentication.
129 default_value: ""
130 required: false
131 + group: Proxy
132 +
133 - name: method
95 - description: HTTP request method.
96 - default_value: GET
134 + description: HTTP method to use.
135 + default_value: "GET"
136 required: false
137 + group: Request
138 - name: body
99 - description: HTTP request body.
139 + description: Request body (e.g., for POST/PUT).
140 default_value: ""
141 required: false
142 + group: Request
143 - name: headers
103 - description: HTTP request headers.
144 + description: "Additional HTTP headers (one per line as key: value)."
145 default_value: ""
146 required: false
147 + group: Request
148 - name: not_follow_redirects
107 - description: Redirect handling policy. Controls whether the client follows redirects.
108 - default_value: false
149 + description: Do not follow HTTP redirects.
150 + default_value: no
151 required: false
110 - - name: tls_skip_verify
111 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
112 - default_value: false
152 + group: Request
153 + - name: force_http2
154 + description: Force HTTP/2 (including h2c over TCP).
155 + default_value: no
156 required: false
114 - - name: tls_ca
115 - description: Certification authority that the client uses when verifying the server's certificates.
116 - default_value: ""
117 - required: false
118 - - name: tls_cert
119 - description: Client TLS certificate.
120 - default_value: ""
121 - required: false
122 - - name: tls_key
123 - description: Client TLS key.
157 + group: Request
158 +
159 + - name: vnode
160 + 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).
161 default_value: ""
162 required: false
163 + group: Virtual Node
164 examples:
165 folding:
166 title: Config
src/go/plugin/go.d/collector/smartctl/metadata.yaml
+25 -15
@@ -95,46 +95,56 @@ modules:
95 enabled: true
96 list:
97 - name: update_every
98 - description: interval for updating Netdata charts, measured in seconds. Collector might use cached data if less than **Devices poll interval**.
98 + description: Netdata chart update interval (seconds). Collector may use cached data if this is less than **poll_devices_every**.
99 default_value: 10
100 required: false
101 + group: Collection
102 - name: timeout
102 - description: smartctl binary execution timeout.
103 + description: "`smartctl` binary execution timeout (seconds)."
104 default_value: 5
105 required: false
106 + group: Collection
107 - name: scan_every
106 - description: interval for discovering new devices using `smartctl --scan`, measured in seconds. Set to 0 to scan devices only once on startup.
108 + description: Device discovery interval using `smartctl --scan` (seconds). Set 0 to scan only once at startup.
109 default_value: 900
110 required: false
111 + group: Collection
112 - name: poll_devices_every
110 - description: interval for gathering data for every device, measured in seconds. Data is cached for this interval.
113 + description: Device polling interval (seconds). Data is cached for this interval.
114 default_value: 300
115 required: false
116 + group: Collection
117 +
118 - name: device_selector
114 - description: "Specifies a pattern to match the 'info name' of devices as reported by `smartctl --scan --json`."
119 + description: "Pattern to match the 'info name' of devices as reported by `smartctl --scan --json`."
120 default_value: "*"
121 required: false
117 - - name: concurrent_scans
118 - description: "Number of devices to scan concurrently. Set to 0 for sequential scanning (default behavior). Improves performance when monitoring many devices."
119 - default_value: 0
120 - required: false
122 + group: Target
123 - name: extra_devices
122 - description: "Allows manual specification of devices not automatically detected by `smartctl --scan`. Each device entry must include both a name and a type. See \"Configuration Examples\" for details."
124 + description: "Manually specify devices not auto-detected by `smartctl --scan`. Each entry must include both a name and a type."
125 default_value: "[]"
126 required: false
127 + group: Target
128 +
129 + - name: concurrent_scans
130 + description: "Number of devices to scan concurrently. Set 0 for sequential scanning (default). Helps performance when monitoring many devices."
131 + default_value: 0
132 + required: false
133 + group: Performance
134 - name: no_check_power_mode
126 - description: "Skip data collection when the device is in a low-power mode. Prevents unnecessary disk spin-up."
135 + description: "Skip data collection when device is in low-power mode (avoids unnecessary spin-up)."
136 default_value: standby
137 required: false
138 + group: Performance
139 detailed_description: |
130 - The valid arguments to this option are:
140 + Valid arguments:
141
142 | Mode | Description |
143 |---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
144 | never | Check the device always. |
135 - | sleep | Check the device unless it is in SLEEP mode. |
136 - | standby | Check the device unless it is in SLEEP or STANDBY mode. In these modes most disks are not spinning, so if you want to prevent a disk from spinning up, this is probably what you want. |
137 - | idle | Check the device unless it is in SLEEP, STANDBY or IDLE mode. In the IDLE state, most disks are still spinning, so this is probably not what you want. |
145 + | sleep | Skip check if device is in SLEEP mode. |
146 + | standby | Skip check if device is in SLEEP or STANDBY mode (prevents spin-up). |
147 + | idle | Skip check if device is in SLEEP, STANDBY, or IDLE mode (not recommended since disks may still be spinning). |
148 examples:
149 folding:
150 title: Config
src/go/plugin/go.d/collector/snmp/metadata.yaml
+4 -3
@@ -83,17 +83,18 @@ modules:
83 enabled: true
84 list:
85 - name: update_every
86 - group: Base
86 + group: Collection
87 description: Data collection frequency.
88 default_value: 10
89 required: false
90 - name: autodetection_retry
91 - group: Base
91 + group: Collection
92 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
93 default_value: 0
94 required: false
95 +
96 - name: hostname
96 - group: Base
97 + group: Target
98 description: Target host (IP or DNS name, IPv4/IPv6).
99 default_value: ""
100 required: true
src/go/plugin/go.d/collector/spigotmc/metadata.yaml
+21 -4
@@ -57,21 +57,38 @@ modules:
57 enabled: true
58 list:
59 - name: update_every
60 - description: Data collection frequency.
60 + description: Data collection frequency (seconds).
61 default_value: 1
62 required: false
63 + group: Collection
64 - name: autodetection_retry
64 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
65 + description: Autodetection retry interval (seconds). Set 0 to disable.
66 default_value: 0
67 required: false
68 + group: Collection
69 +
70 - name: address
68 - description: The IP address and port where the SpigotMC server listens for RCON connections.
71 + description: SpigotMC server RCON address (IP:PORT).
72 default_value: 127.0.0.1:25575
73 required: true
74 + group: Target
75 - name: timeout
72 - description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
76 + description: Connection, read, and write timeout duration (seconds). Includes name resolution.
77 default_value: 1
78 required: false
79 + group: Target
80 +
81 + - name: password
82 + description: RCON password for authentication.
83 + default_value: ""
84 + required: true
85 + group: Auth
86 +
87 + - name: vnode
88 + 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).
89 + default_value: ""
90 + required: false
91 + group: Virtual Node
92 examples:
93 folding:
94 enabled: true
src/go/plugin/go.d/collector/squid/metadata.yaml
+66 -28
@@ -56,73 +56,111 @@ modules:
56 enabled: true
57 list:
58 - name: update_every
59 - description: Data collection frequency.
59 + description: Data collection interval (seconds).
60 default_value: 1
61 required: false
62 + group: Collection
63 - name: autodetection_retry
63 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
64 + description: Autodetection retry interval (seconds). Set 0 to disable.
65 default_value: 0
66 required: false
67 + group: Collection
68 +
69 - name: url
67 - description: Server URL.
70 + description: Target endpoint URL.
71 default_value: http://127.0.0.1:3128
72 required: true
73 + group: Target
74 - name: timeout
71 - description: HTTP request timeout.
75 + description: HTTP request timeout (seconds).
76 default_value: 1
77 required: false
78 + group: Target
79 +
80 - name: username
75 - description: Username for basic HTTP authentication.
81 + description: Username for Basic HTTP authentication.
82 default_value: ""
83 required: false
84 + group: HTTP Auth
85 - name: password
79 - description: Password for basic HTTP authentication.
86 + description: Password for Basic HTTP authentication.
87 + default_value: ""
88 + required: false
89 + group: HTTP Auth
90 + - name: bearer_token_file
91 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
92 + default_value: ""
93 + required: false
94 + group: HTTP Auth
95 +
96 + - name: tls_skip_verify
97 + description: Skip TLS certificate and hostname verification (insecure).
98 + default_value: no
99 + required: false
100 + group: TLS
101 + - name: tls_ca
102 + description: Path to CA bundle used to validate the server certificate.
103 default_value: ""
104 required: false
105 + group: TLS
106 + - name: tls_cert
107 + description: Path to client TLS certificate (for mTLS).
108 + default_value: ""
109 + required: false
110 + group: TLS
111 + - name: tls_key
112 + description: Path to client TLS private key (for mTLS).
113 + default_value: ""
114 + required: false
115 + group: TLS
116 +
117 - name: proxy_url
83 - description: Proxy URL.
118 + description: HTTP proxy URL.
119 default_value: ""
120 required: false
121 + group: Proxy
122 - name: proxy_username
87 - description: Username for proxy basic HTTP authentication.
123 + description: Username for proxy Basic HTTP authentication.
124 default_value: ""
125 required: false
126 + group: Proxy
127 - name: proxy_password
91 - description: Password for proxy basic HTTP authentication.
128 + description: Password for proxy Basic HTTP authentication.
129 default_value: ""
130 required: false
131 + group: Proxy
132 +
133 - name: method
95 - description: HTTP request method.
96 - default_value: POST
134 + description: HTTP method to use.
135 + default_value: "GET"
136 required: false
137 + group: Request
138 - name: body
99 - description: HTTP request body.
139 + description: Request body (e.g., for POST/PUT).
140 default_value: ""
141 required: false
142 + group: Request
143 - name: headers
103 - description: HTTP request headers.
144 + description: "Additional HTTP headers (one per line as key: value)."
145 default_value: ""
146 required: false
147 + group: Request
148 - name: not_follow_redirects
107 - description: Redirect handling policy. Controls whether the client follows redirects.
108 - default_value: false
149 + description: Do not follow HTTP redirects.
150 + default_value: no
151 required: false
110 - - name: tls_skip_verify
111 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
112 - default_value: false
152 + group: Request
153 + - name: force_http2
154 + description: Force HTTP/2 (including h2c over TCP).
155 + default_value: no
156 required: false
114 - - name: tls_ca
115 - description: Certification authority that the client uses when verifying the server's certificates.
116 - default_value: ""
117 - required: false
118 - - name: tls_cert
119 - description: Client TLS certificate.
120 - default_value: ""
121 - required: false
122 - - name: tls_key
123 - description: Client TLS key.
157 + group: Request
158 +
159 + - name: vnode
160 + 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).
161 default_value: ""
162 required: false
163 + group: Virtual Node
164 examples:
165 folding:
166 enabled: true
src/go/plugin/go.d/collector/squidlog/metadata.yaml
+29 -52
@@ -75,107 +75,84 @@ modules:
75 enabled: true
76 list:
77 - name: update_every
78 - description: Data collection frequency.
78 + description: Data collection frequency (seconds).
79 default_value: 1
80 required: false
81 + group: Collection
82 - name: autodetection_retry
82 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
83 + description: Autodetection retry interval (seconds). Set 0 to disable.
84 default_value: 0
85 required: false
86 + group: Collection
87 +
88 - name: path
89 description: Path to the Squid access log file.
90 default_value: /var/log/squid/access.log
91 required: true
92 + group: Target
93 - name: exclude_path
90 - description: Path to exclude.
94 + description: File path patterns to exclude.
95 default_value: "*.gz"
96 required: false
97 + group: Target
98 +
99 - name: parser
94 - description: Log parser configuration.
100 + description: Log parser configuration block.
101 default_value: ""
102 required: false
103 + group: Parser
104 - name: parser.log_type
98 - description: Log parser type.
105 + description: Log parser type (`csv`, `ltsv`, `regexp`, or `auto`).
106 default_value: auto
107 required: false
101 - detailed_description: |
102 - Weblog supports 3 different log parsers:
103 -
104 - | Parser type | Description |
105 - |-------------|-------------------------------------------|
106 - | csv | A comma-separated values |
107 - | ltsv | [LTSV](http://ltsv.org/) |
108 - | regexp | Regular expression with named groups |
109 -
110 - Syntax:
111 -
112 - ```yaml
113 - parser:
114 - log_type: csv
115 - ```
108 + group: Parser
109 - name: parser.csv_config
117 - description: CSV log parser config.
110 + description: CSV log parser configuration block.
111 default_value: ""
112 required: false
113 + group: Parser
114 - name: parser.csv_config.delimiter
115 description: CSV field delimiter.
116 default_value: space
117 required: false
118 + group: Parser
119 - name: parser.csv_config.format
125 - description: CSV log format.
120 + description: CSV log format string.
121 default_value: "- $resp_time $client_address $result_code $resp_size $req_method - - $hierarchy $mime_type"
122 required: true
128 - detailed_description: ""
123 + group: Parser
124 +
125 - name: parser.ltsv_config
130 - description: LTSV log parser config.
126 + description: LTSV log parser configuration block.
127 default_value: ""
128 required: false
129 + group: Parser
130 - name: parser.ltsv_config.field_delimiter
131 description: LTSV field delimiter.
132 default_value: "\\t"
133 required: false
134 + group: Parser
135 - name: parser.ltsv_config.value_delimiter
136 description: LTSV value delimiter.
137 default_value: ":"
138 required: false
139 + group: Parser
140 - name: parser.ltsv_config.mapping
142 - description: LTSV fields mapping to **known fields**.
141 + description: LTSV fields mapping to known fields.
142 default_value: ""
143 required: true
145 - detailed_description: |
146 - The mapping is a dictionary where the key is a field, as in logs, and the value is the corresponding **known field**.
147 -
148 - > **Note**: don't use `$` and `%` prefixes for mapped field names.
144 + group: Parser
145
150 - ```yaml
151 - parser:
152 - log_type: ltsv
153 - ltsv_config:
154 - mapping:
155 - label1: field1
156 - label2: field2
157 - ```
146 - name: parser.regexp_config
159 - description: RegExp log parser config.
147 + description: RegExp log parser configuration block.
148 default_value: ""
149 required: false
150 + group: Parser
151 - name: parser.regexp_config.pattern
163 - description: RegExp pattern with named groups.
152 + description: RegExp pattern with named groups mapped to known fields.
153 default_value: ""
154 required: true
166 - detailed_description: |
167 - Use pattern with subexpressions names. These names should be **known fields**.
168 -
169 - > **Note**: don't use `$` and `%` prefixes for mapped field names.
170 -
171 - Syntax:
172 -
173 - ```yaml
174 - parser:
175 - log_type: regexp
176 - regexp_config:
177 - pattern: PATTERN
178 - ```
155 + group: Parser
156 examples:
157 folding:
158 title: Config
src/go/plugin/go.d/collector/supervisord/metadata.yaml
+15 -4
@@ -59,21 +59,32 @@ modules:
59 enabled: true
60 list:
61 - name: update_every
62 - description: Data collection frequency.
62 + description: Data collection interval (seconds).
63 default_value: 1
64 required: false
65 + group: Collection
66 - name: autodetection_retry
66 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
67 + description: Autodetection retry interval (seconds). Set 0 to disable.
68 default_value: 0
69 required: false
70 + group: Collection
71 +
72 - name: url
70 - description: Server URL.
73 + description: Supervisord XML-RPC endpoint URL.
74 default_value: http://127.0.0.1:9001/RPC2
75 required: true
76 + group: Target
77 - name: timeout
74 - description: System bus requests timeout.
78 + description: Request timeout (seconds).
79 default_value: 1
80 required: false
81 + group: Target
82 +
83 + - name: vnode
84 + 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).
85 + default_value: ""
86 + required: false
87 + group: Virtual Node
88 examples:
89 folding:
90 title: Config
src/go/plugin/go.d/collector/systemdunits/metadata.yaml
+10
@@ -53,18 +53,23 @@ modules:
53 description: Data collection frequency.
54 default_value: 1
55 required: false
56 + group: Collection
57 - name: autodetection_retry
58 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 default_value: 0
60 required: false
61 + group: Collection
62 - name: timeout
63 description: System bus requests timeout.
64 default_value: 1
65 required: false
66 + group: Collection
67 +
68 - name: include
69 description: Systemd units selector.
70 default_value: "*.service"
71 required: false
72 + group: Units
73 detailed_description: |
74 Systemd units matching the selector will be monitored.
75
@@ -81,18 +86,23 @@ modules:
86 description: If set, skip data collection for systemd transient units.
87 default_value: "false"
88 required: false
89 + group: Units
90 +
91 - name: collect_unit_files
92 description: If set to true, collect the state of installed unit files. Enabling this may increase system overhead.
93 default_value: "false"
94 required: false
95 + group: Unit Files
96 - name: collect_unit_files_every
97 description: Interval for querying systemd about unit files and their enablement state, measured in seconds. Data is cached for this interval to reduce system overhead.
98 default_value: 300
99 required: false
100 + group: Unit Files
101 - name: include_unit_files
102 description: Systemd unit files selector.
103 default_value: "*.service"
104 required: false
105 + group: Unit Files
106 detailed_description: |
107 Systemd unit files matching the selector will be monitored.
108
src/go/plugin/go.d/collector/tengine/metadata.yaml
+66 -28
@@ -56,73 +56,111 @@ modules:
56 enabled: true
57 list:
58 - name: update_every
59 - description: Data collection frequency.
59 + description: Data collection interval (seconds).
60 default_value: 1
61 required: false
62 + group: Collection
63 - name: autodetection_retry
63 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
64 + description: Autodetection retry interval (seconds). Set 0 to disable.
65 default_value: 0
66 required: false
67 + group: Collection
68 +
69 - name: url
67 - description: Server URL.
70 + description: Target endpoint URL.
71 default_value: http://127.0.0.1/us
72 required: true
73 + group: Target
74 - name: timeout
71 - description: HTTP request timeout.
75 + description: HTTP request timeout (seconds).
76 default_value: 2
77 required: false
78 + group: Target
79 +
80 - name: username
75 - description: Username for basic HTTP authentication.
81 + description: Username for Basic HTTP authentication.
82 default_value: ""
83 required: false
84 + group: HTTP Auth
85 - name: password
79 - description: Password for basic HTTP authentication.
86 + description: Password for Basic HTTP authentication.
87 default_value: ""
88 required: false
89 + group: HTTP Auth
90 + - name: bearer_token_file
91 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
92 + default_value: ""
93 + required: false
94 + group: HTTP Auth
95 +
96 + - name: tls_skip_verify
97 + description: Skip TLS certificate and hostname verification (insecure).
98 + default_value: no
99 + required: false
100 + group: TLS
101 + - name: tls_ca
102 + description: Path to CA bundle used to validate the server certificate.
103 + default_value: ""
104 + required: false
105 + group: TLS
106 + - name: tls_cert
107 + description: Path to client TLS certificate (for mTLS).
108 + default_value: ""
109 + required: false
110 + group: TLS
111 + - name: tls_key
112 + description: Path to client TLS private key (for mTLS).
113 + default_value: ""
114 + required: false
115 + group: TLS
116 +
117 - name: proxy_url
83 - description: Proxy URL.
118 + description: HTTP proxy URL.
119 default_value: ""
120 required: false
121 + group: Proxy
122 - name: proxy_username
87 - description: Username for proxy basic HTTP authentication.
123 + description: Username for proxy Basic HTTP authentication.
124 default_value: ""
125 required: false
126 + group: Proxy
127 - name: proxy_password
91 - description: Password for proxy basic HTTP authentication.
128 + description: Password for proxy Basic HTTP authentication.
129 default_value: ""
130 required: false
131 + group: Proxy
132 +
133 - name: method
95 - description: HTTP request method.
96 - default_value: GET
134 + description: HTTP method to use.
135 + default_value: "GET"
136 required: false
137 + group: Request
138 - name: body
99 - description: HTTP request body.
139 + description: Request body (e.g., for POST/PUT).
140 default_value: ""
141 required: false
142 + group: Request
143 - name: headers
103 - description: HTTP request headers.
144 + description: "Additional HTTP headers (one per line as key: value)."
145 default_value: ""
146 required: false
147 + group: Request
148 - name: not_follow_redirects
107 - description: Redirect handling policy. Controls whether the client follows redirects.
108 - default_value: false
109 - required: false
110 - - name: tls_skip_verify
111 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
112 - default_value: false
113 - required: false
114 - - name: tls_ca
115 - description: Certification authority that the client uses when verifying the server's certificates.
116 - default_value: ""
149 + description: Do not follow HTTP redirects.
150 + default_value: no
151 required: false
118 - - name: tls_cert
119 - description: Client TLS certificate.
120 - default_value: ""
152 + group: Request
153 + - name: force_http2
154 + description: Force HTTP/2 (including h2c over TCP).
155 + default_value: no
156 required: false
122 - - name: tls_key
123 - description: Client TLS key.
157 + group: Request
158 +
159 + - name: vnode
160 + 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).
161 default_value: ""
162 required: false
163 + group: Virtual Node
164 examples:
165 folding:
166 title: Config
src/go/plugin/go.d/collector/tomcat/metadata.yaml
+66 -28
@@ -65,73 +65,111 @@ modules:
65 enabled: true
66 list:
67 - name: update_every
68 - description: Data collection frequency.
68 + description: Data collection interval (seconds).
69 default_value: 1
70 required: false
71 + group: Collection
72 - name: autodetection_retry
72 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
73 + description: Autodetection retry interval (seconds). Set 0 to disable.
74 default_value: 0
75 required: false
76 + group: Collection
77 +
78 - name: url
76 - description: Server URL.
79 + description: Target endpoint URL.
80 default_value: http://127.0.0.1:8080
81 required: true
82 + group: Target
83 - name: timeout
80 - description: HTTP request timeout.
84 + description: HTTP request timeout (seconds).
85 default_value: 1
86 required: false
87 + group: Target
88 +
89 - name: username
84 - description: Username for basic HTTP authentication.
90 + description: Username for Basic HTTP authentication.
91 default_value: ""
92 required: false
93 + group: HTTP Auth
94 - name: password
88 - description: Password for basic HTTP authentication.
95 + description: Password for Basic HTTP authentication.
96 + default_value: ""
97 + required: false
98 + group: HTTP Auth
99 + - name: bearer_token_file
100 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
101 + default_value: ""
102 + required: false
103 + group: HTTP Auth
104 +
105 + - name: tls_skip_verify
106 + description: Skip TLS certificate and hostname verification (insecure).
107 + default_value: no
108 + required: false
109 + group: TLS
110 + - name: tls_ca
111 + description: Path to CA bundle used to validate the server certificate.
112 default_value: ""
113 required: false
114 + group: TLS
115 + - name: tls_cert
116 + description: Path to client TLS certificate (for mTLS).
117 + default_value: ""
118 + required: false
119 + group: TLS
120 + - name: tls_key
121 + description: Path to client TLS private key (for mTLS).
122 + default_value: ""
123 + required: false
124 + group: TLS
125 +
126 - name: proxy_url
92 - description: Proxy URL.
127 + description: HTTP proxy URL.
128 default_value: ""
129 required: false
130 + group: Proxy
131 - name: proxy_username
96 - description: Username for proxy basic HTTP authentication.
132 + description: Username for proxy Basic HTTP authentication.
133 default_value: ""
134 required: false
135 + group: Proxy
136 - name: proxy_password
100 - description: Password for proxy basic HTTP authentication.
137 + description: Password for proxy Basic HTTP authentication.
138 default_value: ""
139 required: false
140 + group: Proxy
141 +
142 - name: method
104 - description: HTTP request method.
105 - default_value: POST
143 + description: HTTP method to use.
144 + default_value: "GET"
145 required: false
146 + group: Request
147 - name: body
108 - description: HTTP request body.
148 + description: Request body (e.g., for POST/PUT).
149 default_value: ""
150 required: false
151 + group: Request
152 - name: headers
112 - description: HTTP request headers.
153 + description: "Additional HTTP headers (one per line as key: value)."
154 default_value: ""
155 required: false
156 + group: Request
157 - name: not_follow_redirects
116 - description: Redirect handling policy. Controls whether the client follows redirects.
117 - default_value: false
158 + description: Do not follow HTTP redirects.
159 + default_value: no
160 required: false
119 - - name: tls_skip_verify
120 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
121 - default_value: false
161 + group: Request
162 + - name: force_http2
163 + description: Force HTTP/2 (including h2c over TCP).
164 + default_value: no
165 required: false
123 - - name: tls_ca
124 - description: Certification authority that the client uses when verifying the server's certificates.
125 - default_value: ""
126 - required: false
127 - - name: tls_cert
128 - description: Client TLS certificate.
129 - default_value: ""
130 - required: false
131 - - name: tls_key
132 - description: Client TLS key.
166 + group: Request
167 +
168 + - name: vnode
169 + 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).
170 default_value: ""
171 required: false
172 + group: Virtual Node
173 examples:
174 folding:
175 enabled: true
src/go/plugin/go.d/collector/tor/metadata.yaml
+8 -1
@@ -63,22 +63,29 @@ modules:
63 description: Data collection frequency.
64 default_value: 1
65 required: false
66 + group: Collection
67 - name: autodetection_retry
68 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
69 default_value: 0
70 required: false
71 + group: Collection
72 +
73 - name: address
71 - description: The IP address and port where the Tor's Control Port listens for connections.
74 + description: The IP address and port where the Tor Control Port listens for connections.
75 default_value: 127.0.0.1:9051
76 required: true
77 + group: Target
78 - name: timeout
79 description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
80 default_value: 1
81 required: false
82 + group: Target
83 +
84 - name: password
85 description: Password for authentication.
86 default_value: ""
87 required: false
88 + group: Auth
89 examples:
90 folding:
91 title: Config
src/go/plugin/go.d/collector/traefik/metadata.yaml
+68 -30
@@ -55,73 +55,111 @@ modules:
55 enabled: true
56 list:
57 - name: update_every
58 - description: Data collection frequency.
58 + description: Data collection interval (seconds).
59 default_value: 1
60 required: false
61 + group: Collection
62 - name: autodetection_retry
62 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
63 + description: Autodetection retry interval (seconds). Set 0 to disable.
64 default_value: 0
65 required: false
66 + group: Collection
67 +
68 - name: url
66 - description: Server URL.
69 + description: Target endpoint URL.
70 default_value: http://127.0.0.1:8082/metrics
71 required: true
72 + group: Target
73 - name: timeout
70 - description: HTTP request timeout.
74 + description: HTTP request timeout (seconds).
75 default_value: 1
76 required: false
77 + group: Target
78 +
79 - name: username
74 - description: Username for basic HTTP authentication.
80 + description: Username for Basic HTTP authentication.
81 default_value: ""
82 required: false
83 + group: HTTP Auth
84 - name: password
78 - description: Password for basic HTTP authentication.
85 + description: Password for Basic HTTP authentication.
86 default_value: ""
87 required: false
88 + group: HTTP Auth
89 + - name: bearer_token_file
90 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
91 + default_value: ""
92 + required: false
93 + group: HTTP Auth
94 +
95 + - name: tls_skip_verify
96 + description: Skip TLS certificate and hostname verification (insecure).
97 + default_value: no
98 + required: false
99 + group: TLS
100 + - name: tls_ca
101 + description: Path to CA bundle used to validate the server certificate.
102 + default_value: ""
103 + required: false
104 + group: TLS
105 + - name: tls_cert
106 + description: Path to client TLS certificate (for mTLS).
107 + default_value: ""
108 + required: false
109 + group: TLS
110 + - name: tls_key
111 + description: Path to client TLS private key (for mTLS).
112 + default_value: ""
113 + required: false
114 + group: TLS
115 +
116 - name: proxy_url
82 - description: Proxy URL.
117 + description: HTTP proxy URL.
118 default_value: ""
119 required: false
120 + group: Proxy
121 - name: proxy_username
86 - description: Username for proxy basic HTTP authentication.
122 + description: Username for proxy Basic HTTP authentication.
123 default_value: ""
124 required: false
125 + group: Proxy
126 - name: proxy_password
90 - description: Password for proxy basic HTTP authentication.
127 + description: Password for proxy Basic HTTP authentication.
128 default_value: ""
129 required: false
130 + group: Proxy
131 +
132 - name: method
94 - description: HTTP request method.
95 - default_value: GET
133 + description: HTTP method to use.
134 + default_value: "GET"
135 required: false
136 + group: Request
137 - name: body
98 - description: HTTP request body.
138 + description: Request body (e.g., for POST/PUT).
139 default_value: ""
140 required: false
141 + group: Request
142 - name: headers
102 - description: HTTP request headers.
143 + description: "Additional HTTP headers (one per line as key: value)."
144 default_value: ""
145 required: false
146 + group: Request
147 - name: not_follow_redirects
106 - description: Redirect handling policy. Controls whether the client follows redirects.
107 - default_value: false
108 - required: false
109 - - name: tls_skip_verify
110 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
111 - default_value: false
112 - required: false
113 - - name: tls_ca
114 - description: Certification authority that the client uses when verifying the server's certificates.
115 - default_value: ""
116 - required: false
117 - - name: tls_cert
118 - description: Client TLS certificate.
119 - default_value: ""
120 - required: false
121 - - name: tls_key
122 - description: Client TLS key.
148 + description: Do not follow HTTP redirects.
149 + default_value: no
150 + required: false
151 + group: Request
152 + - name: force_http2
153 + description: Force HTTP/2 (including h2c over TCP).
154 + default_value: no
155 + required: false
156 + group: Request
157 +
158 + - name: vnode
159 + 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).
160 default_value: ""
161 required: false
162 + group: Virtual Node
163 examples:
164 folding:
165 title: Config
src/go/plugin/go.d/collector/typesense/metadata.yaml
+68 -29
@@ -68,77 +68,116 @@ modules:
68 enabled: true
69 list:
70 - name: update_every
71 - description: Data collection frequency.
71 + description: Data collection interval (seconds).
72 default_value: 1
73 required: false
74 + group: Collection
75 - name: autodetection_retry
75 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
76 + description: Autodetection retry interval (seconds). Set 0 to disable.
77 default_value: 0
78 required: false
79 + group: Collection
80 +
81 - name: url
79 - description: Server URL.
82 + description: Target endpoint URL.
83 default_value: http://127.0.0.1:8108
84 required: true
85 + group: Target
86 - name: timeout
83 - description: HTTP request timeout.
87 + description: HTTP request timeout (seconds).
88 default_value: 1
89 required: false
90 + group: Target
91 +
92 - name: api_key
87 - description: "The Typesense [API Key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) (`X-TYPESENSE-API-KEY`)."
93 + description: "Typesense API key (`X-TYPESENSE-API-KEY`). See [API Keys](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys)."
94 default_value: ""
95 required: false
96 + group: HTTP Auth
97 - name: username
91 - description: Username for basic HTTP authentication.
98 + description: Username for Basic HTTP authentication.
99 default_value: ""
100 required: false
101 + group: HTTP Auth
102 - name: password
95 - description: Password for basic HTTP authentication.
103 + description: Password for Basic HTTP authentication.
104 + default_value: ""
105 + required: false
106 + group: HTTP Auth
107 + - name: bearer_token_file
108 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
109 + default_value: ""
110 + required: false
111 + group: HTTP Auth
112 +
113 + - name: tls_skip_verify
114 + description: Skip TLS certificate and hostname verification (insecure).
115 + default_value: no
116 + required: false
117 + group: TLS
118 + - name: tls_ca
119 + description: Path to CA bundle used to validate the server certificate.
120 default_value: ""
121 required: false
122 + group: TLS
123 + - name: tls_cert
124 + description: Path to client TLS certificate (for mTLS).
125 + default_value: ""
126 + required: false
127 + group: TLS
128 + - name: tls_key
129 + description: Path to client TLS private key (for mTLS).
130 + default_value: ""
131 + required: false
132 + group: TLS
133 +
134 - name: proxy_url
99 - description: Proxy URL.
135 + description: HTTP proxy URL.
136 default_value: ""
137 required: false
138 + group: Proxy
139 - name: proxy_username
103 - description: Username for proxy basic HTTP authentication.
140 + description: Username for proxy Basic HTTP authentication.
141 default_value: ""
142 required: false
143 + group: Proxy
144 - name: proxy_password
107 - description: Password for proxy basic HTTP authentication.
145 + description: Password for proxy Basic HTTP authentication.
146 default_value: ""
147 required: false
148 + group: Proxy
149 +
150 - name: method
111 - description: HTTP request method.
112 - default_value: GET
151 + description: HTTP method to use.
152 + default_value: "GET"
153 required: false
154 + group: Request
155 - name: body
115 - description: HTTP request body.
156 + description: Request body (e.g., for POST/PUT).
157 default_value: ""
158 required: false
159 + group: Request
160 - name: headers
119 - description: HTTP request headers.
161 + description: "Additional HTTP headers (one per line as key: value)."
162 default_value: ""
163 required: false
164 + group: Request
165 - name: not_follow_redirects
123 - description: Redirect handling policy. Controls whether the client follows redirects.
124 - default_value: false
166 + description: Do not follow HTTP redirects.
167 + default_value: no
168 required: false
126 - - name: tls_skip_verify
127 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
128 - default_value: false
169 + group: Request
170 + - name: force_http2
171 + description: Force HTTP/2 (including h2c over TCP).
172 + default_value: no
173 required: false
130 - - name: tls_ca
131 - description: Certification authority that the client uses when verifying the server's certificates.
132 - default_value: ""
133 - required: false
134 - - name: tls_cert
135 - description: Client TLS certificate.
136 - default_value: ""
137 - required: false
138 - - name: tls_key
139 - description: Client TLS key.
174 + group: Request
175 +
176 + - name: vnode
177 + 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).
178 default_value: ""
179 required: false
180 + group: Virtual Node
181 examples:
182 folding:
183 title: Config
src/go/plugin/go.d/collector/unbound/metadata.yaml
+20 -6
@@ -76,46 +76,60 @@ modules:
76 description: Data collection frequency.
77 default_value: 5
78 required: false
79 + group: Collection
80 - name: autodetection_retry
81 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
82 default_value: 0
83 required: false
84 + group: Collection
85 +
86 - name: address
87 description: Server address in IP:PORT format.
88 default_value: 127.0.0.1:8953
89 required: true
90 + group: Target
91 - name: timeout
88 - description: Connection/read/write/ssl handshake timeout.
92 + description: Connection/read/write/SSL handshake timeout.
93 default_value: 1
94 required: false
95 + group: Target
96 - name: conf_path
92 - description: Absolute path to the unbound configuration file.
97 + description: Absolute path to the Unbound configuration file. Used to adjust behavior based on the `remote-control` section.
98 default_value: /etc/unbound/unbound.conf
99 required: false
100 + group: Target
101 +
102 - name: cumulative_stats
96 - description: Statistics collection mode. Should have the same value as the `statistics-cumulative` parameter in the unbound configuration file.
103 + description: Statistics collection mode. Should match the `statistics-cumulative` parameter in the Unbound configuration file.
104 default_value: false
105 required: false
106 + group: Customization
107 +
108 - name: use_tls
109 description: Whether to use TLS or not.
110 default_value: true
111 required: false
112 + group: TLS
113 - name: tls_skip_verify
114 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
115 default_value: true
116 required: false
117 + group: TLS
118 - name: tls_ca
108 - description: Certificate authority that client use when verifying server certificates.
119 + description: Certificate authority that the client uses when verifying server certificates.
120 default_value: ""
121 required: false
122 + group: TLS
123 - name: tls_cert
112 - description: Client tls certificate.
124 + description: Client TLS certificate.
125 default_value: /etc/unbound/unbound_control.pem
126 required: false
127 + group: TLS
128 - name: tls_key
116 - description: Client tls key.
129 + description: Client TLS key.
130 default_value: /etc/unbound/unbound_control.key
131 required: false
132 + group: TLS
133 examples:
134 folding:
135 title: Config
src/go/plugin/go.d/collector/upsd/metadata.yaml
+22
@@ -54,18 +54,40 @@ modules:
54 description: Data collection frequency.
55 default_value: 1
56 required: false
57 + group: Collection
58 - name: autodetection_retry
59 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: address
65 description: UPS daemon address in IP:PORT format.
66 default_value: 127.0.0.1:3493
67 required: true
68 + group: Target
69 - name: timeout
70 description: Connection/read/write timeout in seconds. The timeout includes name resolution, if required.
71 default_value: 2
72 required: false
73 + group: Target
74 +
75 + - name: username
76 + description: Username for authentication.
77 + default_value: ""
78 + required: false
79 + group: Auth
80 + - name: password
81 + description: Password for authentication.
82 + default_value: ""
83 + required: false
84 + group: Auth
85 +
86 + - name: vnode
87 + 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).
88 + default_value: ""
89 + required: false
90 + group: Virtual Node
91 examples:
92 folding:
93 title: Config
src/go/plugin/go.d/collector/uwsgi/metadata.yaml
+11
@@ -62,18 +62,29 @@ modules:
62 description: Data collection frequency.
63 default_value: 1
64 required: false
65 + group: Collection
66 - name: autodetection_retry
67 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
68 default_value: 0
69 required: false
70 + group: Collection
71 +
72 - name: address
73 description: "The IP address and port where the UWSGI [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) listens for connections."
74 default_value: 127.0.0.1:1717
75 required: true
76 + group: Target
77 - name: timeout
78 description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
79 default_value: 1
80 required: false
81 + group: Target
82 +
83 + - name: vnode
84 + 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).
85 + default_value: ""
86 + required: false
87 + group: Virtual Node
88 examples:
89 folding:
90 title: Config
src/go/plugin/go.d/collector/varnish/metadata.yaml
+5
@@ -64,18 +64,23 @@ modules:
64 description: Data collection frequency.
65 default_value: 10
66 required: false
67 + group: Collection
68 - name: timeout
69 description: Timeout for executing the binary, specified in seconds.
70 default_value: 2
71 required: false
72 + group: Collection
73 +
74 - name: instance_name
75 description: "Specifies the name of the Varnish instance to collect metrics from. This corresponds to the `-n` argument used with the [varnishstat](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) command."
76 default_value: ""
77 required: false
78 + group: Target
79 - name: docker_container
80 description: "Specifies the name of the Docker container where the Varnish instance is running. If set, the `varnishstat` command will be executed within this container."
81 default_value: ""
82 required: false
83 + group: Target
84 examples:
85 folding:
86 title: ""
src/go/plugin/go.d/collector/vcsa/metadata.yaml
+68 -30
@@ -50,73 +50,111 @@ modules:
50 enabled: true
51 list:
52 - name: update_every
53 - description: Data collection frequency.
54 - default_value: "5"
53 + description: Data collection interval (seconds).
54 + default_value: 5
55 required: false
56 + group: Collection
57 - name: autodetection_retry
57 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
58 - default_value: "0"
58 + description: Autodetection retry interval (seconds). Set 0 to disable.
59 + default_value: 0
60 required: false
61 + group: Collection
62 +
63 - name: url
61 - description: Server URL.
64 + description: Target endpoint URL.
65 default_value: ""
66 required: true
67 + group: Target
68 - name: timeout
65 - description: HTTP request timeout.
66 - default_value: "1"
69 + description: HTTP request timeout (seconds).
70 + default_value: 5
71 required: false
72 + group: Target
73 +
74 - name: username
69 - description: Username for basic HTTP authentication.
75 + description: Username for Basic HTTP authentication.
76 default_value: ""
77 required: true
78 + group: HTTP Auth
79 - name: password
73 - description: Password for basic HTTP authentication.
80 + description: Password for Basic HTTP authentication.
81 default_value: ""
82 required: true
83 + group: HTTP Auth
84 + - name: bearer_token_file
85 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
86 + default_value: ""
87 + required: false
88 + group: HTTP Auth
89 +
90 + - name: tls_skip_verify
91 + description: Skip TLS certificate and hostname verification (insecure).
92 + default_value: no
93 + required: false
94 + group: TLS
95 + - name: tls_ca
96 + description: Path to CA bundle used to validate the server certificate.
97 + default_value: ""
98 + required: false
99 + group: TLS
100 + - name: tls_cert
101 + description: Path to client TLS certificate (for mTLS).
102 + default_value: ""
103 + required: false
104 + group: TLS
105 + - name: tls_key
106 + description: Path to client TLS private key (for mTLS).
107 + default_value: ""
108 + required: false
109 + group: TLS
110 +
111 - name: proxy_url
77 - description: Proxy URL.
112 + description: HTTP proxy URL.
113 default_value: ""
114 required: false
115 + group: Proxy
116 - name: proxy_username
81 - description: Username for proxy basic HTTP authentication.
117 + description: Username for proxy Basic HTTP authentication.
118 default_value: ""
119 required: false
120 + group: Proxy
121 - name: proxy_password
85 - description: Password for proxy basic HTTP authentication.
122 + description: Password for proxy Basic HTTP authentication.
123 default_value: ""
124 required: false
125 + group: Proxy
126 +
127 - name: method
89 - description: HTTP request method.
128 + description: HTTP method to use.
129 default_value: "GET"
130 required: false
131 + group: Request
132 - name: body
93 - description: HTTP request body.
133 + description: Request body (e.g., for POST/PUT).
134 default_value: ""
135 required: false
136 + group: Request
137 - name: headers
97 - description: HTTP request headers.
138 + description: "Additional HTTP headers (one per line as key: value)."
139 default_value: ""
140 required: false
141 + group: Request
142 - name: not_follow_redirects
101 - description: Redirect handling policy. Controls whether the client follows redirects.
102 - default_value: "false"
103 - required: false
104 - - name: tls_skip_verify
105 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
106 - default_value: "false"
107 - required: false
108 - - name: tls_ca
109 - description: Certification authority that the client uses when verifying the server's certificates.
110 - default_value: ""
143 + description: Do not follow HTTP redirects.
144 + default_value: no
145 required: false
112 - - name: tls_cert
113 - description: Client TLS certificate.
114 - default_value: ""
146 + group: Request
147 + - name: force_http2
148 + description: Force HTTP/2 (including h2c over TCP).
149 + default_value: no
150 required: false
116 - - name: tls_key
117 - description: Client TLS key.
151 + group: Request
152 +
153 + - name: vnode
154 + 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).
155 default_value: ""
156 required: false
157 + group: Virtual Node
158 examples:
159 folding:
160 title: Config
src/go/plugin/go.d/collector/vernemq/metadata.yaml
+66 -28
@@ -51,73 +51,111 @@ modules:
51 enabled: true
52 list:
53 - name: update_every
54 - description: Data collection frequency.
54 + description: Data collection interval (seconds).
55 default_value: 1
56 required: false
57 + group: Collection
58 - name: autodetection_retry
58 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 + description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: url
62 - description: Server URL.
65 + description: Target endpoint URL.
66 default_value: http://127.0.0.1:8888/metrics
67 required: true
68 + group: Target
69 - name: timeout
66 - description: HTTP request timeout.
70 + description: HTTP request timeout (seconds).
71 default_value: 1
72 required: false
73 + group: Target
74 +
75 - name: username
70 - description: Username for basic HTTP authentication.
76 + description: Username for Basic HTTP authentication.
77 default_value: ""
78 required: false
79 + group: HTTP Auth
80 - name: password
74 - description: Password for basic HTTP authentication.
81 + description: Password for Basic HTTP authentication.
82 default_value: ""
83 required: false
84 + group: HTTP Auth
85 + - name: bearer_token_file
86 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
87 + default_value: ""
88 + required: false
89 + group: HTTP Auth
90 +
91 + - name: tls_skip_verify
92 + description: Skip TLS certificate and hostname verification (insecure).
93 + default_value: no
94 + required: false
95 + group: TLS
96 + - name: tls_ca
97 + description: Path to CA bundle used to validate the server certificate.
98 + default_value: ""
99 + required: false
100 + group: TLS
101 + - name: tls_cert
102 + description: Path to client TLS certificate (for mTLS).
103 + default_value: ""
104 + required: false
105 + group: TLS
106 + - name: tls_key
107 + description: Path to client TLS private key (for mTLS).
108 + default_value: ""
109 + required: false
110 + group: TLS
111 +
112 - name: proxy_url
78 - description: Proxy URL.
113 + description: HTTP proxy URL.
114 default_value: ""
115 required: false
116 + group: Proxy
117 - name: proxy_username
82 - description: Username for proxy basic HTTP authentication.
118 + description: Username for proxy Basic HTTP authentication.
119 default_value: ""
120 required: false
121 + group: Proxy
122 - name: proxy_password
86 - description: Password for proxy basic HTTP authentication.
123 + description: Password for proxy Basic HTTP authentication.
124 default_value: ""
125 required: false
126 + group: Proxy
127 +
128 - name: method
90 - description: HTTP request method.
91 - default_value: GET
129 + description: HTTP method to use.
130 + default_value: "GET"
131 required: false
132 + group: Request
133 - name: body
94 - description: HTTP request body.
134 + description: Request body (e.g., for POST/PUT).
135 default_value: ""
136 required: false
137 + group: Request
138 - name: headers
98 - description: HTTP request headers.
139 + description: "Additional HTTP headers (one per line as key: value)."
140 default_value: ""
141 required: false
142 + group: Request
143 - name: not_follow_redirects
102 - description: Redirect handling policy. Controls whether the client follows redirects.
103 - default_value: false
104 - required: false
105 - - name: tls_skip_verify
106 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
107 - default_value: false
108 - required: false
109 - - name: tls_ca
110 - description: Certification authority that the client uses when verifying the server's certificates.
111 - default_value: ""
144 + description: Do not follow HTTP redirects.
145 + default_value: no
146 required: false
113 - - name: tls_cert
114 - description: Client TLS certificate.
115 - default_value: ""
147 + group: Request
148 + - name: force_http2
149 + description: Force HTTP/2 (including h2c over TCP).
150 + default_value: no
151 required: false
117 - - name: tls_key
118 - description: Client TLS key.
152 + group: Request
153 +
154 + - name: vnode
155 + 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).
156 default_value: ""
157 required: false
158 + group: Virtual Node
159 examples:
160 folding:
161 title: Config
src/go/plugin/go.d/collector/vsphere/metadata.yaml
+96 -40
@@ -96,21 +96,39 @@ modules:
96 enabled: true
97 list:
98 - name: update_every
99 - description: Data collection frequency.
100 - default_value: 20
99 + description: Data collection interval (seconds).
100 + default_value: 1
101 required: false
102 + group: Collection
103 +
104 - name: autodetection_retry
103 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
105 + description: Autodetection retry interval (seconds). Set 0 to disable.
106 default_value: 0
107 required: false
108 + group: Collection
109 +
110 - name: url
107 - description: vCenter server URL.
108 - default_value: ""
111 + description: Target endpoint URL.
112 + default_value: http://127.0.0.1/server-status?auto
113 required: true
114 + group: Target
115 + - name: timeout
116 + description: HTTP request timeout (seconds).
117 + default_value: 1
118 + required: false
119 + group: Target
120 +
121 + - name: discovery_interval
122 + description: Hosts and VMs discovery interval (seconds).
123 + default_value: 300
124 + required: false
125 + group: Discovery
126 +
127 - name: host_include
128 description: Hosts selector (filter).
112 - default_value: ""
129 + default_value: "/*"
130 required: false
131 + group: Filters
132 detailed_description: |
133 Metrics of hosts matching the selector will be collected.
134
@@ -120,14 +138,15 @@ modules:
138
139 ```yaml
140 host_include:
123 - - '/DC1/*' # select all hosts from datacenter DC1
124 - - '/DC2/*/!Host2 *' # select all hosts from datacenter DC2 except HOST2
125 - - '/DC3/Cluster3/*' # select all hosts from datacenter DC3 cluster Cluster3
141 + - '/DC1/*' # all hosts from datacenter DC1
142 + - '/DC2/*/!Host2 *' # all hosts from datacenter DC2 except HOST2
143 + - '/DC3/Cluster3/*' # all hosts from DC3, cluster Cluster3
144 ```
145 - name: vm_include
128 - description: Virtual machines selector (filter).
129 - default_value: ""
146 + description: VM selector (filter).
147 + default_value: "/*"
148 required: false
149 + group: Filters
150 detailed_description: |
151 Metrics of VMs matching the selector will be collected.
152
@@ -137,58 +156,95 @@ modules:
156
157 ```yaml
158 vm_include:
140 - - '/DC1/*' # select all VMs from datacenter DC
141 - - '/DC2/*/*/!VM2 *' # select all VMs from datacenter DC2 except VM2
142 - - '/DC3/Cluster3/*' # select all VMs from datacenter DC3 cluster Cluster3
159 + - '/DC1/*' # all VMs from datacenter DC1
160 + - '/DC2/*/*/!VM2 *' # all VMs from DC2 except VM2
161 + - '/DC3/Cluster3/*' # all VMs from DC3, cluster Cluster3
162 ```
144 - - name: discovery_interval
145 - description: Hosts and VMs discovery interval.
146 - default_value: 300
163 +
164 + - name: username
165 + description: Username for Basic HTTP authentication.
166 + default_value: ""
167 + required: true
168 + group: HTTP Auth
169 + - name: password
170 + description: Password for Basic HTTP authentication.
171 + default_value: ""
172 + required: true
173 + group: HTTP Auth
174 + - name: bearer_token_file
175 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
176 + default_value: ""
177 required: false
148 - - name: timeout
149 - description: HTTP request timeout.
150 - default_value: 20
178 + group: HTTP Auth
179 +
180 + - name: tls_skip_verify
181 + description: Skip TLS certificate and hostname verification (insecure).
182 + default_value: no
183 required: false
152 - - name: username
153 - description: Username for basic HTTP authentication.
184 + group: TLS
185 + - name: tls_ca
186 + description: Path to CA bundle used to validate the server certificate.
187 default_value: ""
188 required: false
156 - - name: password
157 - description: Password for basic HTTP authentication.
189 + group: TLS
190 + - name: tls_cert
191 + description: Path to client TLS certificate (for mTLS).
192 + default_value: ""
193 + required: false
194 + group: TLS
195 + - name: tls_key
196 + description: Path to client TLS private key (for mTLS).
197 default_value: ""
198 required: false
199 + group: TLS
200 +
201 - name: proxy_url
161 - description: Proxy URL.
202 + description: HTTP proxy URL.
203 default_value: ""
204 required: false
205 + group: Proxy
206 - name: proxy_username
165 - description: Username for proxy basic HTTP authentication.
207 + description: Username for proxy Basic HTTP authentication.
208 default_value: ""
209 required: false
210 + group: Proxy
211 - name: proxy_password
169 - description: Password for proxy basic HTTP authentication.
212 + description: Password for proxy Basic HTTP authentication.
213 default_value: ""
214 required: false
172 - - name: not_follow_redirects
173 - description: Redirect handling policy. Controls whether the client follows redirects.
174 - default_value: no
175 - required: false
176 - - name: tls_skip_verify
177 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
178 - default_value: no
215 + group: Proxy
216 +
217 + - name: method
218 + description: HTTP method to use.
219 + default_value: "GET"
220 required: false
180 - - name: tls_ca
181 - description: Certification authority that the client uses when verifying the server's certificates.
221 + group: Request
222 + - name: body
223 + description: Request body (e.g., for POST/PUT).
224 default_value: ""
225 required: false
184 - - name: tls_cert
185 - description: Client TLS certificate.
226 + group: Request
227 + - name: headers
228 + description: "Additional HTTP headers (one per line as key: value)."
229 default_value: ""
230 required: false
188 - - name: tls_key
189 - description: Client TLS key.
231 + group: Request
232 + - name: not_follow_redirects
233 + description: Do not follow HTTP redirects.
234 + default_value: no
235 + required: false
236 + group: Request
237 + - name: force_http2
238 + description: Force HTTP/2 (including h2c over TCP).
239 + default_value: no
240 + required: false
241 + group: Request
242 +
243 + - name: vnode
244 + 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).
245 default_value: ""
246 required: false
247 + group: Virtual Node
248 examples:
249 folding:
250 title: Config
src/go/plugin/go.d/collector/weblog/metadata.yaml
+26 -5
@@ -91,22 +91,29 @@ modules:
91 description: Data collection frequency.
92 default_value: 1
93 required: false
94 + group: Collection
95 - name: autodetection_retry
96 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
97 default_value: 0
98 required: false
99 + group: Collection
100 +
101 - name: path
102 description: Path to the web server log file.
103 default_value: ""
104 required: true
105 + group: Target
106 - name: exclude_path
107 description: Path to exclude.
108 default_value: "*.gz"
109 required: false
110 + group: Target
111 +
112 - name: url_patterns
113 description: List of URL patterns.
114 default_value: "[]"
115 required: false
116 + group: Customization
117 detailed_description: |
118 "URL pattern" scope metrics will be collected for each URL pattern.
119
@@ -123,14 +130,18 @@ modules:
130 description: Used as a dimension name.
131 default_value: ""
132 required: true
133 + group: Customization
134 - name: url_patterns.pattern
135 description: Used to match against full original request URI. Pattern syntax in [matcher](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#supported-format).
136 default_value: ""
137 required: true
138 + group: Customization
139 +
140 - name: log_type
141 description: Log parser type.
142 default_value: auto
143 required: false
144 + group: Parser
145 detailed_description: |
146 Weblog supports 5 different log parsers:
147
@@ -141,7 +152,7 @@ modules:
152 | json | [JSON](https://www.json.org/json-en.html) |
153 | ltsv | [LTSV](http://ltsv.org/) |
154 | regexp | Regular expression with named groups |
144 -
155 +
156 Syntax:
157
158 ```yaml
@@ -149,11 +160,11 @@ modules:
160 ```
161
162 If `log_type` parameter set to `auto` (which is default), weblog will try to auto-detect appropriate log parser and log format using the last line of the log file.
152 -
163 +
164 - checks if format is `CSV` (using regexp).
165 - checks if format is `JSON` (using regexp).
166 - assumes format is `CSV` and tries to find appropriate `CSV` log format using predefined list of formats. It tries to parse the line using each of them in the following order (the first one matches is used later):
156 -
167 +
168 ```sh
169 $host:$server_port $remote_addr - - [$time_local] "$request" $status $body_bytes_sent - - $request_length $request_time $upstream_response_time
170 $host:$server_port $remote_addr - - [$time_local] "$request" $status $body_bytes_sent - - $request_length $request_time
@@ -166,37 +177,43 @@ modules:
177 $remote_addr - - [$time_local] "$request" $status $body_bytes_sent $request_length $request_time
178 $remote_addr - - [$time_local] "$request" $status $body_bytes_sent
179 ```
169 -
180 +
181 If you're using the default Apache/NGINX log format, auto-detect will work for you. If it doesn't work you need to set the format manually.
182 - name: csv_config
183 description: CSV log parser config.
184 default_value: ""
185 required: false
186 + group: Parser
187 - name: csv_config.delimiter
188 description: CSV field delimiter.
189 default_value: ","
190 required: false
191 + group: Parser
192 - name: csv_config.format
193 description: CSV log format.
194 default_value: ""
195 required: false
183 - detailed_description: ""
196 + group: Parser
197 - name: ltsv_config
198 description: LTSV log parser config.
199 default_value: ""
200 required: false
201 + group: Parser
202 - name: ltsv_config.field_delimiter
203 description: LTSV field delimiter.
204 default_value: "\\t"
205 required: false
206 + group: Parser
207 - name: ltsv_config.value_delimiter
208 description: LTSV value delimiter.
209 default_value: ":"
210 required: false
211 + group: Parser
212 - name: ltsv_config.mapping
213 description: LTSV fields mapping to **known fields**.
214 default_value: ""
215 required: true
216 + group: Parser
217 detailed_description: |
218 The mapping is a dictionary where the key is a field, as in logs, and the value is the corresponding **known field**.
219
@@ -213,10 +230,12 @@ modules:
230 description: JSON log parser config.
231 default_value: ""
232 required: false
233 + group: Parser
234 - name: json_config.mapping
235 description: JSON fields mapping to **known fields**.
236 default_value: ""
237 required: true
238 + group: Parser
239 detailed_description: |
240 The mapping is a dictionary where the key is a field, as in logs, and the value is the corresponding **known field**.
241
@@ -233,10 +252,12 @@ modules:
252 description: RegExp log parser config.
253 default_value: ""
254 required: false
255 + group: Parser
256 - name: regexp_config.pattern
257 description: RegExp pattern with named groups.
258 default_value: ""
259 required: true
260 + group: Parser
261 detailed_description: |
262 Use pattern with subexpressions names. These names should be **known fields**.
263
src/go/plugin/go.d/collector/whoisquery/metadata.yaml
+17 -3
@@ -53,26 +53,40 @@ modules:
53 description: Data collection frequency.
54 default_value: 60
55 required: false
56 + group: Collection
57 - name: autodetection_retry
58 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 default_value: 0
60 required: false
61 + group: Collection
62 +
63 - name: source
64 description: Domain address.
65 default_value: ""
66 required: true
67 + group: Target
68 + - name: timeout
69 + description: The query timeout in seconds.
70 + default_value: 5
71 + required: false
72 + group: Target
73 +
74 - name: days_until_expiration_warning
75 description: Number of days before the alarm status is warning.
76 default_value: 30
77 required: false
78 + group: Customization
79 - name: days_until_expiration_critical
80 description: Number of days before the alarm status is critical.
81 default_value: 15
82 required: false
72 - - name: timeout
73 - description: The query timeout in seconds.
74 - default_value: 5
83 + group: Customization
84 +
85 + - name: vnode
86 + 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).
87 + default_value: ""
88 required: false
89 + group: Virtual Node
90 examples:
91 folding:
92 title: Config
src/go/plugin/go.d/collector/x509check/metadata.yaml
+34 -15
@@ -51,45 +51,64 @@ modules:
51 enabled: true
52 list:
53 - name: update_every
54 - description: Data collection frequency.
54 + description: Data collection interval (seconds).
55 default_value: 1
56 required: false
57 + group: Collection
58 - name: autodetection_retry
58 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
59 + description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 + group: Collection
63 +
64 - name: source
65 description: "Certificate source. Allowed schemes: https, tcp, tcp4, tcp6, udp, udp4, udp6, file, smtp."
66 default_value: ""
67 required: false
68 + group: Target
69 + - name: timeout
70 + description: SSL connection timeout (seconds).
71 + default_value: 2
72 + required: false
73 + group: Target
74 +
75 - name: check_full_chain
66 - description: Monitor expiration time for all certificates in the SSL/TLS chain, including intermediate and root certificates.
67 - default_value: false
76 + description: Monitor expiration time for all certificates in the chain (including intermediates and root).
77 + default_value: no
78 required: false
79 + group: Validation
80 - name: check_revocation_status
70 - description: Whether to check the revocation status of the certificate.
71 - default_value: false
72 - required: false
73 - - name: timeout
74 - description: SSL connection timeout.
75 - default_value: 2
81 + description: Check the revocation status of the certificate.
82 + default_value: no
83 required: false
84 + group: Validation
85 +
86 - name: tls_skip_verify
78 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
79 - default_value: false
87 + description: Skip TLS certificate and hostname verification (insecure).
88 + default_value: no
89 required: false
90 + group: TLS
91 - name: tls_ca
82 - description: Certification authority that the client uses when verifying the server's certificates.
92 + description: Path to CA bundle used to validate the server certificate.
93 default_value: ""
94 required: false
95 + group: TLS
96 - name: tls_cert
86 - description: Client TLS certificate.
97 + description: Path to client TLS certificate (for mTLS).
98 default_value: ""
99 required: false
100 + group: TLS
101 - name: tls_key
90 - description: Client TLS key.
102 + description: Path to client TLS private key (for mTLS).
103 + default_value: ""
104 + required: false
105 + group: TLS
106 +
107 + - name: vnode
108 + 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).
109 default_value: ""
110 required: false
111 + group: Virtual Node
112 examples:
113 folding:
114 title: Config
src/go/plugin/go.d/collector/yugabytedb/metadata.yaml
+66 -28
@@ -62,73 +62,111 @@ modules:
62 enabled: true
63 list:
64 - name: update_every
65 - description: Data collection frequency.
65 + description: Data collection interval (seconds).
66 default_value: 5
67 required: false
68 + group: Collection
69 - name: autodetection_retry
69 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
70 + description: Autodetection retry interval (seconds). Set 0 to disable.
71 default_value: 0
72 required: false
73 + group: Collection
74 +
75 - name: url
73 - description: Server URL.
76 + description: Target endpoint URL.
77 default_value: http://127.0.0.1:7000/prometheus-metrics
78 required: true
79 + group: Target
80 - name: timeout
77 - description: HTTP request timeout.
81 + description: HTTP request timeout (seconds).
82 default_value: 1
83 required: false
84 + group: Target
85 +
86 - name: username
81 - description: Username for basic HTTP authentication.
87 + description: Username for Basic HTTP authentication.
88 default_value: ""
89 required: false
90 + group: HTTP Auth
91 - name: password
85 - description: Password for basic HTTP authentication.
92 + description: Password for Basic HTTP authentication.
93 default_value: ""
94 required: false
95 + group: HTTP Auth
96 + - name: bearer_token_file
97 + description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
98 + default_value: ""
99 + required: false
100 + group: HTTP Auth
101 +
102 + - name: tls_skip_verify
103 + description: Skip TLS certificate and hostname verification (insecure).
104 + default_value: no
105 + required: false
106 + group: TLS
107 + - name: tls_ca
108 + description: Path to CA bundle used to validate the server certificate.
109 + default_value: ""
110 + required: false
111 + group: TLS
112 + - name: tls_cert
113 + description: Path to client TLS certificate (for mTLS).
114 + default_value: ""
115 + required: false
116 + group: TLS
117 + - name: tls_key
118 + description: Path to client TLS private key (for mTLS).
119 + default_value: ""
120 + required: false
121 + group: TLS
122 +
123 - name: proxy_url
89 - description: Proxy URL.
124 + description: HTTP proxy URL.
125 default_value: ""
126 required: false
127 + group: Proxy
128 - name: proxy_username
93 - description: Username for proxy basic HTTP authentication.
129 + description: Username for proxy Basic HTTP authentication.
130 default_value: ""
131 required: false
132 + group: Proxy
133 - name: proxy_password
97 - description: Password for proxy basic HTTP authentication.
134 + description: Password for proxy Basic HTTP authentication.
135 default_value: ""
136 required: false
137 + group: Proxy
138 +
139 - name: method
101 - description: HTTP request method.
102 - default_value: GET
140 + description: HTTP method to use.
141 + default_value: "GET"
142 required: false
143 + group: Request
144 - name: body
105 - description: HTTP request body.
145 + description: Request body (e.g., for POST/PUT).
146 default_value: ""
147 required: false
148 + group: Request
149 - name: headers
109 - description: HTTP request headers.
150 + description: "Additional HTTP headers (one per line as key: value)."
151 default_value: ""
152 required: false
153 + group: Request
154 - name: not_follow_redirects
113 - description: Redirect handling policy. Controls whether the client follows redirects.
114 - default_value: false
115 - required: false
116 - - name: tls_skip_verify
117 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
118 - default_value: false
119 - required: false
120 - - name: tls_ca
121 - description: Certification authority that the client uses when verifying the server's certificates.
122 - default_value: ""
155 + description: Do not follow HTTP redirects.
156 + default_value: no
157 required: false
124 - - name: tls_cert
125 - description: Client TLS certificate.
126 - default_value: ""
158 + group: Request
159 + - name: force_http2
160 + description: Force HTTP/2 (including h2c over TCP).
161 + default_value: no
162 required: false
128 - - name: tls_key
129 - description: Client TLS key.
163 + group: Request
164 +
165 + - name: vnode
166 + 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).
167 default_value: ""
168 required: false
169 + group: Virtual Node
170 examples:
171 folding:
172 title: Config
src/go/plugin/go.d/collector/zookeeper/metadata.yaml
+28 -11
@@ -61,41 +61,58 @@ modules:
61 enabled: true
62 list:
63 - name: update_every
64 - description: Data collection frequency.
64 + description: Data collection interval (seconds).
65 default_value: 1
66 required: false
67 + group: Collection
68 - name: autodetection_retry
68 - description: Recheck interval in seconds. Zero means no recheck will be scheduled.
69 + description: Autodetection retry interval (seconds). Set 0 to disable.
70 default_value: 0
71 required: false
72 + group: Collection
73 +
74 - name: address
72 - description: Server address. The format is IP:PORT.
75 + description: Zookeeper server address (`IP:PORT`).
76 default_value: 127.0.0.1:2181
77 required: true
78 + group: Target
79 - name: timeout
76 - description: Connection/read/write/ssl handshake timeout.
80 + description: Connection, read, write, and TLS handshake timeout (seconds).
81 default_value: 1
82 required: false
83 + group: Target
84 +
85 - name: use_tls
80 - description: Whether to use TLS or not.
81 - default_value: false
86 + description: Enable TLS for the connection.
87 + default_value: no
88 required: false
89 + group: TLS
90 - name: tls_skip_verify
84 - description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
85 - default_value: false
91 + description: Skip TLS certificate and hostname verification (insecure).
92 + default_value: no
93 required: false
94 + group: TLS
95 - name: tls_ca
88 - description: Certification authority that the client uses when verifying the server's certificates.
96 + description: Path to CA bundle used to validate the server certificate.
97 default_value: ""
98 required: false
99 + group: TLS
100 - name: tls_cert
92 - description: Client TLS certificate.
101 + description: Path to client TLS certificate (for mTLS).
102 default_value: ""
103 required: false
104 + group: TLS
105 - name: tls_key
96 - description: Client TLS key.
106 + description: Path to client TLS private key (for mTLS).
107 default_value: ""
108 required: false
109 + group: TLS
110 +
111 + - name: vnode
112 + 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).
113 + default_value: ""
114 + required: false
115 + group: Virtual Node
116 examples:
117 folding:
118 title: Config