@cryptotaxi247 / netdata-1 / commits / 7e06cf9dd

Regenerate integrations docs (#22022)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>

Netdata bot committed Mar 23, 2026 at 21:03 UTC 7e06cf9dd66359d4c49a5853667e55e496b3342b
2 files changed -379
src/collectors/COLLECTORS.md
-1
@@ -482,7 +482,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
482 | [Minecraft](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/minecraft.md) | Track Minecraft server metrics for efficient game server management and performance. |
483 | [MS Exchange](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/ms_exchange.md) | This collector monitors Microsoft Exchange. |
484 | [mtail](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mtail.md) | Monitor log data metrics using mtail log data extractor and parser. |
485 -| [Nagios](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nagios.md) | Keep tabs on Nagios network monitoring metrics for efficient IT infrastructure management and performance. |
485 | [NET Framework](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/net_framework.md) | This collector monitors application built with .NET |
486 | [Nextcloud servers](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nextcloud_servers.md) | Keep an eye on Nextcloud cloud storage metrics for efficient file hosting and management. |
487 | [NRPE daemon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/nrpe_daemon.md) | Monitor Nagios Remote Plugin Executor (NRPE) metrics for efficient system and network monitoring. |
src/go/plugin/go.d/collector/prometheus/integrations/nagios.md deleted
-378
@@ -1,378 +0,0 @@
1 -<!--startmeta
2 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/nagios.md"
3 -meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4 -sidebar_label: "Nagios"
5 -learn_status: "Published"
6 -learn_rel_path: "Collecting Metrics/Applications"
7 -message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 -endmeta-->
9 -
10 -# Nagios
11 -
12 -
13 -<img src="https://netdata.cloud/img/nagios.png" width="150"/>
14 -
15 -
16 -Plugin: go.d.plugin
17 -Module: prometheus
18 -
19 -<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
20 -
21 -## Overview
22 -
23 -Keep tabs on Nagios network monitoring metrics for efficient
24 -IT infrastructure management and performance.
25 -
26 -
27 -Metrics are gathered by periodically sending HTTP requests to [Nagios exporter](https://github.com/wbollock/nagios_exporter).
28 -
29 -
30 -This collector is supported on all platforms.
31 -
32 -This collector supports collecting metrics from multiple instances of this integration, including remote instances.
33 -
34 -
35 -### Default Behavior
36 -
37 -#### Auto-Detection
38 -
39 -By default, it detects instances running on the local host by trying to connect to known ports that are [allocated to exporters](https://github.com/prometheus/prometheus/wiki/Default-port-allocations).
40 -
41 -
42 -#### Limits
43 -
44 -The default configuration for this integration does not impose any limits on data collection.
45 -
46 -#### Performance Impact
47 -
48 -The default configuration for this integration is not expected to impose a significant performance impact on the system.
49 -
50 -## Metrics
51 -
52 -This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
53 -
54 -| Metric | Chart | Dimension(s) | Algorithm |
55 -|---------------------------|-------------------------------------------|----------------------|-------------|
56 -| Gauge | for each label set | one, the metric name | absolute |
57 -| Counter | for each label set | one, the metric name | incremental |
58 -| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
59 -| Summary (sum and count) | for each label set | the metric name | incremental |
60 -| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
61 -| Histogram (sum and count) | for each label set | the metric name | incremental |
62 -
63 -Untyped metrics (have no '# TYPE') processing:
64 -
65 -- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
66 -- As Counter if it has suffix '_total'.
67 -- As Summary if it has 'quantile' label.
68 -- As Histogram if it has 'le' label.
69 -
70 -**The rest are ignored**.
71 -
72 -
73 -
74 -## Alerts
75 -
76 -There are no alerts configured by default for this integration.
77 -
78 -
79 -## Setup
80 -
81 -
82 -You can configure the **prometheus** collector in two ways:
83 -
84 -| Method | Best for | How to |
85 -|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
86 -| [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **prometheus**, then click **+** to add a job. |
87 -| [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `go.d/prometheus.conf` and add a job. |
88 -
89 -:::important
90 -
91 -UI configuration requires paid Netdata Cloud plan.
92 -
93 -:::
94 -
95 -
96 -### Prerequisites
97 -
98 -#### Install Exporter
99 -
100 -Install [Nagios exporter](https://github.com/wbollock/nagios_exporter) by following the instructions mentioned in the exporter README.
101 -
102 -
103 -
104 -### Configuration
105 -
106 -#### Options
107 -
108 -The following options can be defined globally: update_every, autodetection_retry.
109 -
110 -
111 -<details open><summary>Config options</summary>
112 -
113 -
114 -
115 -| Group | Option | Description | Default | Required |
116 -|:------|:-----|:------------|:--------|:---------:|
117 -| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
118 -| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
119 -| **Target** | url | Target endpoint URL. | | yes |
120 -| | timeout | HTTP request timeout (seconds). | 10 | no |
121 -| **Filters** | [selector](#option-filters-selector) | Time series selector (filter). | | no |
122 -| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
123 -| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
124 -| **Customization** | [fallback_type](#option-customization-fallback-type) | Fallback type rules for untyped metrics. | | no |
125 -| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
126 -| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
127 -| | password | Password for Basic HTTP authentication. | | no |
128 -| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
129 -| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
130 -| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
131 -| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
132 -| | tls_key | Path to client TLS private key (for mTLS). | | no |
133 -| **Proxy** | proxy_url | HTTP proxy URL. | | no |
134 -| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
135 -| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
136 -| **Request** | method | HTTP method to use. | GET | no |
137 -| | body | Request body (e.g., for POST/PUT). | | no |
138 -| | headers | Additional HTTP headers (one per line as key: value). | | no |
139 -| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
140 -| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
141 -| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
142 -
143 -<a id="option-filters-selector"></a>
144 -##### selector
145 -
146 -This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
147 -
148 -- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
149 -- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
150 -- Option syntax:
151 -
152 -```yaml
153 -selector:
154 - allow:
155 - - pattern1
156 - - pattern2
157 - deny:
158 - - pattern3
159 - - pattern4
160 -```
161 -
162 -
163 -<a id="option-customization-fallback-type"></a>
164 -##### fallback_type
165 -
166 -This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
167 -
168 -- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
169 -- Option syntax:
170 -
171 -```yaml
172 -fallback_type:
173 - counter:
174 - - metric_name_pattern1
175 - - metric_name_pattern2
176 - gauge:
177 - - metric_name_pattern3
178 - - metric_name_pattern4
179 -```
180 -
181 -
182 -
183 -</details>
184 -
185 -
186 -#### via UI
187 -
188 -Configure the **prometheus** collector from the Netdata web interface:
189 -
190 -1. Go to **Nodes**.
191 -2. Select the node **where you want the prometheus data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection.
192 -3. The **Collectors → Jobs** view opens by default.
193 -4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
194 -5. Click the **+** next to the **prometheus** collector to add a new job.
195 -6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
196 - - **Test** runs the job with the provided settings and shows whether data can be collected.
197 - - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
198 -
199 -
200 -#### via File
201 -
202 -The configuration file name for this integration is `go.d/prometheus.conf`.
203 -
204 -The file format is YAML. Generally, the structure is:
205 -
206 -```yaml
207 -update_every: 1
208 -autodetection_retry: 0
209 -jobs:
210 - - name: some_name1
211 - - name: some_name2
212 -```
213 -You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
214 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
215 -
216 -```bash
217 -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
218 -sudo ./edit-config go.d/prometheus.conf
219 -```
220 -
221 -##### Examples
222 -
223 -###### Basic
224 -
225 -> **Note**: Change the port of the monitored application on which it provides metrics.
226 -
227 -A basic example configuration.
228 -
229 -
230 -```yaml
231 -jobs:
232 - - name: local
233 - url: http://127.0.0.1:9090/metrics
234 -
235 -```
236 -###### Read metrics from a file
237 -
238 -An example configuration to read metrics from a file.
239 -
240 -<details open><summary>Config</summary>
241 -
242 -```yaml
243 -# use "file://" scheme
244 -jobs:
245 - - name: myapp
246 - url: file:///opt/metrics/myapp/metrics.txt
247 -
248 -```
249 -</details>
250 -
251 -###### HTTP authentication
252 -
253 -> **Note**: Change the port of the monitored application on which it provides metrics.
254 -
255 -Basic HTTP authentication.
256 -
257 -
258 -<details open><summary>Config</summary>
259 -
260 -```yaml
261 -jobs:
262 - - name: local
263 - url: http://127.0.0.1:9090/metrics
264 - username: username
265 - password: password
266 -
267 -```
268 -</details>
269 -
270 -###### HTTPS with self-signed certificate
271 -
272 -> **Note**: Change the port of the monitored application on which it provides metrics.
273 -
274 -Do not validate server certificate chain and hostname.
275 -
276 -
277 -<details open><summary>Config</summary>
278 -
279 -```yaml
280 -jobs:
281 - - name: local
282 - url: https://127.0.0.1:9090/metrics
283 - tls_skip_verify: yes
284 -
285 -```
286 -</details>
287 -
288 -###### Multi-instance
289 -
290 -> **Note**: When you define multiple jobs, their names must be unique.
291 -> **Note**: Change the port of the monitored application on which it provides metrics.
292 -
293 -Collecting metrics from local and remote instances.
294 -
295 -
296 -<details open><summary>Config</summary>
297 -
298 -```yaml
299 -jobs:
300 - - name: local
301 - url: http://127.0.0.1:9090/metrics
302 -
303 - - name: remote
304 - url: http://192.0.2.1:9090/metrics
305 -
306 -```
307 -</details>
308 -
309 -
310 -
311 -## Troubleshooting
312 -
313 -### Debug Mode
314 -
315 -**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
316 -
317 -To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
318 -should give you clues as to why the collector isn't working.
319 -
320 -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
321 - your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
322 -
323 - ```bash
324 - cd /usr/libexec/netdata/plugins.d/
325 - ```
326 -
327 -- Switch to the `netdata` user.
328 -
329 - ```bash
330 - sudo -u netdata -s
331 - ```
332 -
333 -- Run the `go.d.plugin` to debug the collector:
334 -
335 - ```bash
336 - ./go.d.plugin -d -m prometheus
337 - ```
338 -
339 - To debug a specific job:
340 -
341 - ```bash
342 - ./go.d.plugin -d -m prometheus -j jobName
343 - ```
344 -
345 -### Getting Logs
346 -
347 -If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
348 -
349 -- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
350 -- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
351 -
352 -#### System with systemd
353 -
354 -Use the following command to view logs generated since the last Netdata service restart:
355 -
356 -```bash
357 -journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
358 -```
359 -
360 -#### System without systemd
361 -
362 -Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
363 -
364 -```bash
365 -grep prometheus /var/log/netdata/collector.log
366 -```
367 -
368 -**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
369 -
370 -#### Docker Container
371 -
372 -If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
373 -
374 -```bash
375 -docker logs netdata 2>&1 | grep prometheus
376 -```
377 -
378 -