Regenerate integrations docs (#21444)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Dec 11, 2025 at 10:13 UTC
73403c00c5418a113f65462287195cc6404cdbea
11 files changed
+37
-3418
src/collectors/COLLECTORS.md
+1
-10
@@ -441,37 +441,28 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
441
| Integration | Description |
442
|-------------|-------------|
443
| [8430FT modem](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/8430ft_modem.md) | Keep track of vital metrics from the MTS 8430FT modem for streamlined network performance and diagnostics. |
444
-| [A10 ACOS network devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/a10_acos_network_devices.md) | Monitor A10 Networks device metrics for comprehensive management and analysis. |
444
| [Andrews & Arnold line status](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/andrews_&_arnold_line_status.md) | Track Andrews & Arnold Ltd (AAISP) metrics for improved network performance and diagnostics. |
445
| [Aruba devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/aruba_devices.md) | Monitor Aruba Networks devices performance metrics for comprehensive network management and analysis. |
446
| [Bird Routing Daemon](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/bird_routing_daemon.md) | Keep an eye on Bird Routing Daemon metrics for optimized network routing and management. |
447
| [Checkpoint device](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/checkpoint_device.md) | Track Check Point firewall and security metrics for enhanced network protection and management. |
449
-| [Cisco ACI](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/cisco_aci.md) | Monitor Cisco ACI infrastructure metrics for optimized network performance and resource management. |
448
| [Citrix NetScaler](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/citrix_netscaler.md) | Keep tabs on NetScaler performance metrics for efficient application delivery and load balancing. |
449
| [DDWRT Routers](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ddwrt_routers.md) | Keep tabs on DD-WRT router metrics for efficient network management and performance. |
452
-| [Fortigate firewall](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/fortigate_firewall.md) | Keep tabs on Fortigate firewall metrics for enhanced network protection and management. |
450
| [Freifunk network](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/freifunk_network.md) | Keep tabs on Freifunk community network metrics for optimized network performance and management. |
454
-| [Fritzbox network devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/fritzbox_network_devices.md) | Track AVM Fritzbox router metrics for efficient home network management and performance. |
451
| [FRRouting](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/frrouting.md) | Monitor Free Range Routing (FRR) metrics for optimized network routing and management. |
452
| [Hitron CGN series CPE](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hitron_cgn_series_cpe.md) | Monitor Hitron CGNV4 gateway metrics for efficient network management and performance. |
453
| [Hitron CODA Cable Modem](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/hitron_coda_cable_modem.md) | Track Hitron CODA cable modem metrics for optimized internet connectivity and performance. |
454
| [Huawei devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/huawei_devices.md) | Keep tabs on Huawei HiLink device metrics for optimized connectivity and performance. |
455
| [Keepalived](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/keepalived.md) | Track Keepalived metrics for efficient high-availability and load balancing management. |
460
-| [Meraki dashboard](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/meraki_dashboard.md) | Keep tabs on Cisco Meraki cloud-managed networking device metrics for efficient network management and performance. |
461
-| [MikroTik devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mikrotik_devices.md) | Keep tabs on MikroTik RouterOS metrics for efficient network device management and performance. |
462
-| [Mikrotik RouterOS devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mikrotik_routeros_devices.md) | Track MikroTik RouterOS metrics for efficient network device management and performance. |
456
| [NetFlow](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/netflow.md) | Track NetFlow network traffic metrics for efficient network monitoring and performance. |
457
| [NetMeter](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/netmeter.md) | Monitor NetMeter network traffic metrics for efficient network management and performance. |
458
| [Open vSwitch](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/open_vswitch.md) | Keep an eye on Open vSwitch software-defined networking metrics for efficient network virtualization and performance. |
459
| [OpenROADM devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/openroadm_devices.md) | Monitor OpenROADM optical transport network metrics using the NETCONF protocol for efficient network management and performance. |
460
| [Optical modules](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/ethtool/integrations/optical_modules.md) | This collector monitors optical transceiver modules' diagnostic parameters (temperature, voltage, laser bias current, transmit/receive power levels) from network interfaces equipped with modules that support Digital Diagnostic Monitoring (DDM). |
461
| [RIPE Atlas](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ripe_atlas.md) | Keep tabs on RIPE Atlas Internet measurement platform metrics for efficient network monitoring and performance. |
469
-| [SmartRG 808AC Cable Modem](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/smartrg_808ac_cable_modem.md) | Monitor SmartRG SR808ac router metrics for efficient network device management and performance. |
462
| [SONiC NOS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sonic_nos.md) | Keep tabs on Software for Open Networking in the Cloud (SONiC) metrics for efficient network switch management and performance. |
463
| [Starlink (SpaceX)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/starlink_spacex.md) | Monitor SpaceX Starlink satellite internet metrics for efficient internet service management and performance. |
464
| [Traceroute](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/traceroute.md) | Export traceroute metrics for efficient network path analysis and performance monitoring. |
465
| [Ubiquiti UFiber OLT](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/ubiquiti_ufiber_olt.md) | Track Ubiquiti UFiber GPON (Gigabit Passive Optical Network) device metrics for efficient fiber-optic network management and performance. |
474
-| [Zyxel GS1200-8](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/zyxel_gs1200-8.md) | Track Zyxel GS1200 network switch metrics for efficient network device management and performance. |
466
467
### Synthetic Checks
468
@@ -761,7 +752,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
752
| [Pandas](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/integrations/pandas.md) | [Pandas](https://pandas.pydata.org/) is a de-facto standard in reading and processing most types of structured data in Python. |
753
| [Prometheus endpoint](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/prometheus_endpoint.md) | This generic Prometheus collector gathers metrics from any [`Prometheus`](https://prometheus.io/) endpoints. |
754
| [Shell command](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/shell_command.md) | Track custom command output metrics for tailored monitoring and management. |
764
-| [SNMP devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md) | This SNMP collector discovers and monitors SNMP-enabled devices using **profiles**. |
755
+| [SNMP devices](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md) | This collector discovers and monitors any SNMP-enabled network device. |
756
| [Tankerkoenig API](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/tankerkoenig_api.md) | Track Tankerknig API fuel price metrics for efficient fuel price monitoring and management. |
757
| [TwinCAT ADS Web Service](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/twincat_ads_web_service.md) | Monitor TwinCAT ADS (Automation Device Specification) Web Service metrics for efficient industrial automation and control. |
758
src/go/plugin/go.d/collector/prometheus/integrations/a10_acos_network_devices.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/a10_acos_network_devices.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "A10 ACOS network devices"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-keywords: ['network monitoring', 'network performance', 'traffic analysis']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# A10 ACOS network devices
13
-
14
-
15
-<img src="https://netdata.cloud/img/a10-networks.png" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor A10 Networks device metrics for comprehensive management and analysis.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [A10-Networks Prometheus Exporter](https://github.com/a10networks/PrometheusExporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
41
-
42
-
43
-#### Limits
44
-
45
-The default configuration for this integration does not impose any limits on data collection.
46
-
47
-#### Performance Impact
48
-
49
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
50
-
51
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**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. |
88
-| [**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. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [A10-Networks Prometheus Exporter](https://github.com/a10networks/PrometheusExporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **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 |
143
-
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
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-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.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-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
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **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.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/cisco_aci.md
deleted
-377
@@ -1,377 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/cisco_aci.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Cisco ACI"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-keywords: ['network monitoring', 'network performance', 'cisco devices']
9
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
-endmeta-->
11
-
12
-# Cisco ACI
13
-
14
-
15
-<img src="https://netdata.cloud/img/cisco.svg" width="150"/>
16
-
17
-
18
-Plugin: go.d.plugin
19
-Module: prometheus
20
-
21
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
22
-
23
-## Overview
24
-
25
-Monitor Cisco ACI infrastructure metrics for optimized network performance and resource management.
26
-
27
-
28
-Metrics are gathered by periodically sending HTTP requests to [Cisco ACI Exporter](https://github.com/RavuAlHemio/prometheus_aci_exporter).
29
-
30
-
31
-This collector is supported on all platforms.
32
-
33
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34
-
35
-
36
-### Default Behavior
37
-
38
-#### Auto-Detection
39
-
40
-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).
41
-
42
-
43
-#### Limits
44
-
45
-The default configuration for this integration does not impose any limits on data collection.
46
-
47
-#### Performance Impact
48
-
49
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
50
-
51
-## Metrics
52
-
53
-This collector has built-in grouping logic based on the [type of metrics](https://prometheus.io/docs/concepts/metric_types/).
54
-
55
-| Metric | Chart | Dimension(s) | Algorithm |
56
-|---------------------------|-------------------------------------------|----------------------|-------------|
57
-| Gauge | for each label set | one, the metric name | absolute |
58
-| Counter | for each label set | one, the metric name | incremental |
59
-| Summary (quantiles) | for each label set (excluding 'quantile') | for each quantile | absolute |
60
-| Summary (sum and count) | for each label set | the metric name | incremental |
61
-| Histogram (buckets) | for each label set (excluding 'le') | for each bucket | incremental |
62
-| Histogram (sum and count) | for each label set | the metric name | incremental |
63
-
64
-Untyped metrics (have no '# TYPE') processing:
65
-
66
-- As Counter or Gauge depending on pattern match when 'fallback_type' is used.
67
-- As Counter if it has suffix '_total'.
68
-- As Summary if it has 'quantile' label.
69
-- As Histogram if it has 'le' label.
70
-
71
-**The rest are ignored**.
72
-
73
-
74
-
75
-## Alerts
76
-
77
-There are no alerts configured by default for this integration.
78
-
79
-
80
-## Setup
81
-
82
-
83
-You can configure the **prometheus** collector in two ways:
84
-
85
-| Method | Best for | How to |
86
-|-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
87
-| [**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. |
88
-| [**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. |
89
-
90
-:::important
91
-
92
-UI configuration requires paid Netdata Cloud plan.
93
-
94
-:::
95
-
96
-
97
-### Prerequisites
98
-
99
-#### Install Exporter
100
-
101
-Install [Cisco ACI Exporter](https://github.com/RavuAlHemio/prometheus_aci_exporter) by following the instructions mentioned in the exporter README.
102
-
103
-
104
-
105
-### Configuration
106
-
107
-#### Options
108
-
109
-The following options can be defined globally: update_every, autodetection_retry.
110
-
111
-
112
-<details open><summary>Config options</summary>
113
-
114
-
115
-
116
-| Group | Option | Description | Default | Required |
117
-|:------|:-----|:------------|:--------|:---------:|
118
-| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
119
-| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
120
-| **Target** | url | Target endpoint URL. | | yes |
121
-| | timeout | HTTP request timeout (seconds). | 10 | no |
122
-| **Filters** | selector | Time series selector (filter). | | no |
123
-| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
124
-| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
125
-| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
126
-| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
127
-| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
128
-| | password | Password for Basic HTTP authentication. | | no |
129
-| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
130
-| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
131
-| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
132
-| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
133
-| | tls_key | Path to client TLS private key (for mTLS). | | no |
134
-| **Proxy** | proxy_url | HTTP proxy URL. | | no |
135
-| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
136
-| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
137
-| **Request** | method | HTTP method to use. | GET | no |
138
-| | body | Request body (e.g., for POST/PUT). | | no |
139
-| | headers | Additional HTTP headers (one per line as key: value). | | no |
140
-| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
141
-| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
142
-| **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 |
143
-
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
-##### fallback_type
164
-
165
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
166
-
167
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
168
-- Option syntax:
169
-
170
-```yaml
171
-fallback_type:
172
- counter:
173
- - metric_name_pattern1
174
- - metric_name_pattern2
175
- gauge:
176
- - metric_name_pattern3
177
- - metric_name_pattern4
178
-```
179
-
180
-
181
-
182
-</details>
183
-
184
-
185
-#### via UI
186
-
187
-Configure the **prometheus** collector from the Netdata web interface:
188
-
189
-1. Go to **Nodes**.
190
-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.
191
-3. The **Collectors → Jobs** view opens by default.
192
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
193
-5. Click the **+** next to the **prometheus** collector to add a new job.
194
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
195
- - **Test** runs the job with the provided settings and shows whether data can be collected.
196
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
197
-
198
-
199
-#### via File
200
-
201
-The configuration file name for this integration is `go.d/prometheus.conf`.
202
-
203
-The file format is YAML. Generally, the structure is:
204
-
205
-```yaml
206
-update_every: 1
207
-autodetection_retry: 0
208
-jobs:
209
- - name: some_name1
210
- - name: some_name2
211
-```
212
-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
213
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
214
-
215
-```bash
216
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
217
-sudo ./edit-config go.d/prometheus.conf
218
-```
219
-
220
-##### Examples
221
-
222
-###### Basic
223
-
224
-> **Note**: Change the port of the monitored application on which it provides metrics.
225
-
226
-A basic example configuration.
227
-
228
-
229
-```yaml
230
-jobs:
231
- - name: local
232
- url: http://127.0.0.1:9090/metrics
233
-
234
-```
235
-###### Read metrics from a file
236
-
237
-An example configuration to read metrics from a file.
238
-
239
-<details open><summary>Config</summary>
240
-
241
-```yaml
242
-# use "file://" scheme
243
-jobs:
244
- - name: myapp
245
- url: file:///opt/metrics/myapp/metrics.txt
246
-
247
-```
248
-</details>
249
-
250
-###### HTTP authentication
251
-
252
-> **Note**: Change the port of the monitored application on which it provides metrics.
253
-
254
-Basic HTTP authentication.
255
-
256
-
257
-<details open><summary>Config</summary>
258
-
259
-```yaml
260
-jobs:
261
- - name: local
262
- url: http://127.0.0.1:9090/metrics
263
- username: username
264
- password: password
265
-
266
-```
267
-</details>
268
-
269
-###### HTTPS with self-signed certificate
270
-
271
-> **Note**: Change the port of the monitored application on which it provides metrics.
272
-
273
-Do not validate server certificate chain and hostname.
274
-
275
-
276
-<details open><summary>Config</summary>
277
-
278
-```yaml
279
-jobs:
280
- - name: local
281
- url: https://127.0.0.1:9090/metrics
282
- tls_skip_verify: yes
283
-
284
-```
285
-</details>
286
-
287
-###### Multi-instance
288
-
289
-> **Note**: When you define multiple jobs, their names must be unique.
290
-> **Note**: Change the port of the monitored application on which it provides metrics.
291
-
292
-Collecting metrics from local and remote instances.
293
-
294
-
295
-<details open><summary>Config</summary>
296
-
297
-```yaml
298
-jobs:
299
- - name: local
300
- url: http://127.0.0.1:9090/metrics
301
-
302
- - name: remote
303
- url: http://192.0.2.1:9090/metrics
304
-
305
-```
306
-</details>
307
-
308
-
309
-
310
-## Troubleshooting
311
-
312
-### Debug Mode
313
-
314
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
315
-
316
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
317
-should give you clues as to why the collector isn't working.
318
-
319
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
320
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
321
-
322
- ```bash
323
- cd /usr/libexec/netdata/plugins.d/
324
- ```
325
-
326
-- Switch to the `netdata` user.
327
-
328
- ```bash
329
- sudo -u netdata -s
330
- ```
331
-
332
-- Run the `go.d.plugin` to debug the collector:
333
-
334
- ```bash
335
- ./go.d.plugin -d -m prometheus
336
- ```
337
-
338
- To debug a specific job:
339
-
340
- ```bash
341
- ./go.d.plugin -d -m prometheus -j jobName
342
- ```
343
-
344
-### Getting Logs
345
-
346
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
347
-
348
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
349
-- **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.
350
-
351
-#### System with systemd
352
-
353
-Use the following command to view logs generated since the last Netdata service restart:
354
-
355
-```bash
356
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
357
-```
358
-
359
-#### System without systemd
360
-
361
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
362
-
363
-```bash
364
-grep prometheus /var/log/netdata/collector.log
365
-```
366
-
367
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
368
-
369
-#### Docker Container
370
-
371
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
372
-
373
-```bash
374
-docker logs netdata 2>&1 | grep prometheus
375
-```
376
-
377
-
src/go/plugin/go.d/collector/prometheus/integrations/fortigate_firewall.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/fortigate_firewall.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Fortigate firewall"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# Fortigate firewall
12
-
13
-
14
-<img src="https://netdata.cloud/img/fortinet.svg" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: prometheus
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21
-
22
-## Overview
23
-
24
-Keep tabs on Fortigate firewall metrics for enhanced network protection and management.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [fortigate_exporter](https://github.com/bluecmd/fortigate_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 [fortigate_exporter](https://github.com/bluecmd/fortigate_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 | 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 | 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
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-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.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-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
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **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.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/fritzbox_network_devices.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/fritzbox_network_devices.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Fritzbox network devices"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# Fritzbox network devices
12
-
13
-
14
-<img src="https://netdata.cloud/img/avm.png" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: prometheus
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21
-
22
-## Overview
23
-
24
-Track AVM Fritzbox router metrics for efficient home network management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Fritzbox exporter](https://github.com/pdreker/fritz_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 [Fritzbox exporter](https://github.com/pdreker/fritz_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 | 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 | 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
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-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.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-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
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **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.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/meraki_dashboard.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/meraki_dashboard.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Meraki dashboard"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# Meraki dashboard
12
-
13
-
14
-<img src="https://netdata.cloud/img/meraki.png" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: prometheus
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21
-
22
-## Overview
23
-
24
-Keep tabs on Cisco Meraki cloud-managed networking device metrics for efficient network management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Meraki dashboard data exporter using API](https://github.com/TheHolm/meraki-dashboard-promethus-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 [Meraki dashboard data exporter using API](https://github.com/TheHolm/meraki-dashboard-promethus-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 | 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 | 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
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-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.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-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
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **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.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/mikrotik_devices.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/mikrotik_devices.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "MikroTik devices"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# MikroTik devices
12
-
13
-
14
-<img src="https://netdata.cloud/img/mikrotik.png" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: prometheus
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21
-
22
-## Overview
23
-
24
-Keep tabs on MikroTik RouterOS metrics for efficient network device management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [mikrotik-exporter](https://github.com/swoga/mikrotik-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 [nshttpd/mikrotik-exporter, swoga/m](https://github.com/swoga/mikrotik-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 | 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 | 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
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-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.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-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
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **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.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/mikrotik_routeros_devices.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/mikrotik_routeros_devices.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Mikrotik RouterOS devices"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# Mikrotik RouterOS devices
12
-
13
-
14
-<img src="https://netdata.cloud/img/routeros.png" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: prometheus
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21
-
22
-## Overview
23
-
24
-Track MikroTik RouterOS metrics for efficient network device management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [RouterOS exporter](https://github.com/welbymcroberts/routeros_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 [RouterOS exporter](https://github.com/welbymcroberts/routeros_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 | 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 | 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
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-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.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-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
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **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.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/smartrg_808ac_cable_modem.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/smartrg_808ac_cable_modem.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "SmartRG 808AC Cable Modem"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# SmartRG 808AC Cable Modem
12
-
13
-
14
-<img src="https://netdata.cloud/img/smartr.jpeg" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: prometheus
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21
-
22
-## Overview
23
-
24
-Monitor SmartRG SR808ac router metrics for efficient network device management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [smartrg808ac_exporter](https://github.com/AdamIsrael/smartrg808ac_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 [smartrg808ac_exporter](https://github.com/AdamIsrael/smartrg808ac_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 | 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 | 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
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-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.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-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
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **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.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/prometheus/integrations/zyxel_gs1200-8.md
deleted
-376
@@ -1,376 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/zyxel_gs1200-8.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4
-sidebar_label: "Zyxel GS1200-8"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Networking Stack and Network Interfaces"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# Zyxel GS1200-8
12
-
13
-
14
-<img src="https://netdata.cloud/img/zyxel.png" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: prometheus
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Community-blue" />
21
-
22
-## Overview
23
-
24
-Track Zyxel GS1200 network switch metrics for efficient network device management and performance.
25
-
26
-
27
-Metrics are gathered by periodically sending HTTP requests to [Zyxel GS1200 Exporter](https://github.com/robinelfrink/gs1200-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 [Zyxel GS1200 Exporter](https://github.com/robinelfrink/gs1200-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 | 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 | 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
-##### selector
144
-
145
-This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
146
-
147
-- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
148
-- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/pkg/prometheus/selector/README.md).
149
-- Option syntax:
150
-
151
-```yaml
152
-selector:
153
- allow:
154
- - pattern1
155
- - pattern2
156
- deny:
157
- - pattern3
158
- - pattern4
159
-```
160
-
161
-
162
-##### fallback_type
163
-
164
-This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
165
-
166
-- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
167
-- Option syntax:
168
-
169
-```yaml
170
-fallback_type:
171
- counter:
172
- - metric_name_pattern1
173
- - metric_name_pattern2
174
- gauge:
175
- - metric_name_pattern3
176
- - metric_name_pattern4
177
-```
178
-
179
-
180
-
181
-</details>
182
-
183
-
184
-#### via UI
185
-
186
-Configure the **prometheus** collector from the Netdata web interface:
187
-
188
-1. Go to **Nodes**.
189
-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.
190
-3. The **Collectors → Jobs** view opens by default.
191
-4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
192
-5. Click the **+** next to the **prometheus** collector to add a new job.
193
-6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
194
- - **Test** runs the job with the provided settings and shows whether data can be collected.
195
- - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
196
-
197
-
198
-#### via File
199
-
200
-The configuration file name for this integration is `go.d/prometheus.conf`.
201
-
202
-The file format is YAML. Generally, the structure is:
203
-
204
-```yaml
205
-update_every: 1
206
-autodetection_retry: 0
207
-jobs:
208
- - name: some_name1
209
- - name: some_name2
210
-```
211
-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
212
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
213
-
214
-```bash
215
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
216
-sudo ./edit-config go.d/prometheus.conf
217
-```
218
-
219
-##### Examples
220
-
221
-###### Basic
222
-
223
-> **Note**: Change the port of the monitored application on which it provides metrics.
224
-
225
-A basic example configuration.
226
-
227
-
228
-```yaml
229
-jobs:
230
- - name: local
231
- url: http://127.0.0.1:9090/metrics
232
-
233
-```
234
-###### Read metrics from a file
235
-
236
-An example configuration to read metrics from a file.
237
-
238
-<details open><summary>Config</summary>
239
-
240
-```yaml
241
-# use "file://" scheme
242
-jobs:
243
- - name: myapp
244
- url: file:///opt/metrics/myapp/metrics.txt
245
-
246
-```
247
-</details>
248
-
249
-###### HTTP authentication
250
-
251
-> **Note**: Change the port of the monitored application on which it provides metrics.
252
-
253
-Basic HTTP authentication.
254
-
255
-
256
-<details open><summary>Config</summary>
257
-
258
-```yaml
259
-jobs:
260
- - name: local
261
- url: http://127.0.0.1:9090/metrics
262
- username: username
263
- password: password
264
-
265
-```
266
-</details>
267
-
268
-###### HTTPS with self-signed certificate
269
-
270
-> **Note**: Change the port of the monitored application on which it provides metrics.
271
-
272
-Do not validate server certificate chain and hostname.
273
-
274
-
275
-<details open><summary>Config</summary>
276
-
277
-```yaml
278
-jobs:
279
- - name: local
280
- url: https://127.0.0.1:9090/metrics
281
- tls_skip_verify: yes
282
-
283
-```
284
-</details>
285
-
286
-###### Multi-instance
287
-
288
-> **Note**: When you define multiple jobs, their names must be unique.
289
-> **Note**: Change the port of the monitored application on which it provides metrics.
290
-
291
-Collecting metrics from local and remote instances.
292
-
293
-
294
-<details open><summary>Config</summary>
295
-
296
-```yaml
297
-jobs:
298
- - name: local
299
- url: http://127.0.0.1:9090/metrics
300
-
301
- - name: remote
302
- url: http://192.0.2.1:9090/metrics
303
-
304
-```
305
-</details>
306
-
307
-
308
-
309
-## Troubleshooting
310
-
311
-### Debug Mode
312
-
313
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
314
-
315
-To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
316
-should give you clues as to why the collector isn't working.
317
-
318
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
319
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
320
-
321
- ```bash
322
- cd /usr/libexec/netdata/plugins.d/
323
- ```
324
-
325
-- Switch to the `netdata` user.
326
-
327
- ```bash
328
- sudo -u netdata -s
329
- ```
330
-
331
-- Run the `go.d.plugin` to debug the collector:
332
-
333
- ```bash
334
- ./go.d.plugin -d -m prometheus
335
- ```
336
-
337
- To debug a specific job:
338
-
339
- ```bash
340
- ./go.d.plugin -d -m prometheus -j jobName
341
- ```
342
-
343
-### Getting Logs
344
-
345
-If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
346
-
347
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
348
-- **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.
349
-
350
-#### System with systemd
351
-
352
-Use the following command to view logs generated since the last Netdata service restart:
353
-
354
-```bash
355
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
356
-```
357
-
358
-#### System without systemd
359
-
360
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
361
-
362
-```bash
363
-grep prometheus /var/log/netdata/collector.log
364
-```
365
-
366
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
367
-
368
-#### Docker Container
369
-
370
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
371
-
372
-```bash
373
-docker logs netdata 2>&1 | grep prometheus
374
-```
375
-
376
-
src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md
+36
-22
@@ -5,7 +5,7 @@ sidebar_label: "SNMP devices"
5
learn_status: "Published"
6
learn_rel_path: "Collecting Metrics/Generic Collecting Metrics"
7
most_popular: True
8
-keywords: ['snmp']
8
+keywords: ['snmp', 'mib', 'oid', 'network', 'router', 'switch', 'firewall', 'ap', 'access point', 'wireless controller', 'wlc', 'wifi', 'vpn', 'pdu', 'ups', 'nas', 'san', 'printer', 'bgp', 'ospf', 'ucd', '3com', 'a10', 'alcatel', 'lucent', 'nokia', 'anue', 'apc', 'netbotz', 'arista', 'aruba', 'audiocodes', 'avaya', 'avocent', 'avtech', 'roomalert', 'barracuda', 'bluecat', 'brocade', 'brother', 'chatsworth', 'checkpoint', 'chrysalis', 'cisco', 'cisco asa', 'cisco asr', 'cisco catalyst', 'cisco nexus', 'cisco ironport', 'cisco ics', 'cisco wlc', 'cisco ucs', 'meraki', 'citrix', 'netscaler', 'cradlepoint', 'cyberpower', 'dell', 'dell emc', 'poweredge', 'sonicwall', 'dialogic', 'dlink', 'd-link', 'eaton', 'exagrid', 'extreme', 'f5', 'big-ip', 'fireeye', 'fortinet', 'fortigate', 'fortiswitch', 'gigamon', 'hp', 'hewlett packard', 'hp ilo', 'ilo', 'ilo4', 'hp h3c', 'hp icf', 'hpe', 'proliant', 'huawei', '3com huawei', 'ibm', 'datapower', 'lenovo', 'idrac', 'dell idrac', 'infinera', 'coriant', 'infoblox', 'isilon', 'ixsystems', 'truenas', 'juniper', 'junos', 'kyocera', 'linksys', 'mcafee', 'mikrotik', 'nasuni', 'nec', 'net-snmp', 'netsnmp', 'netapp', 'netgear', 'readynas', 'omron', 'opengear', 'palo alto', 'cloudgenix', 'peplink', 'raritan', 'riverbed', 'ruckus', 'serveriron', 'server-iron', 'servertech', 'silverpeak', 'silver peak', 'edgeconnect', 'sinetica', 'sophos', 'synology', 'diskstation', 'tp-link', 'tplink', 'tripplite', 'tripp lite', 'ubiquiti', 'unifi', 'velocloud', 'vertiv', 'liebert', 'watchguard', 'western digital', 'wd', 'mycloud', 'zebra', 'zyxel']
9
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
10
endmeta-->
11
@@ -22,41 +22,55 @@ Module: snmp
22
23
## Overview
24
25
-This SNMP collector discovers and monitors SNMP-enabled devices using **profiles**.
25
+This collector discovers and monitors any SNMP-enabled network device.
26
27
-:::tip
27
+- **Built-in vendor profiles**: Netdata ships with a [large library of profiles](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/config/go.d/snmp.profiles/default) for major vendors, enabling automatic, out-of-the-box monitoring—**no manual OID configuration needed** for common hardware.
28
+- **Custom profiles supported**: Users can extend or override stock profiles to add new devices, modify charts, or collect additional OIDs.
29
+- **Automatic vendor/model detection**: Devices are matched to the right profile using selectors such as `sysObjectID` and `sysDescr`.
30
+- **ICMP ping**: Optional round-trip latency monitoring alongside SNMP, with a `ping_only` mode available.
31
+- **SNMP v1, v2c, and v3 support**: Fully implemented via the [gosnmp](https://github.com/gosnmp/gosnmp) library.
32
29
-See: [SNMP Profile Format](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/profile-format.md) to learn how to write profiles and define their fields.
33
31
-**Profile locations**
34
+**Built-in profiles for major vendors:**
35
33
-| Type | Default path | Notes |
34
-|------|---------------|--------|
35
-| **Stock profiles** | `/usr/lib/netdata/conf.d/go.d/snmp.profiles/default/` | Provided with Netdata. |
36
-| **User profiles** | `/etc/netdata/go.d/snmp.profiles/` | Place your custom or modified profiles here. |
36
+| Category | Vendors |
37
+|----------|---------|
38
+| Switches & Routers | Cisco (Catalyst, Nexus, ASR, ISR), Arista, Juniper, HP/HPE, Dell, Extreme |
39
+| Firewalls | Palo Alto, Fortinet FortiGate, Cisco ASA, Checkpoint, SonicWall |
40
+| Wireless | Aruba, Cisco WLC, Ubiquiti, Alcatel-Lucent |
41
+| Load Balancers | F5 BIG-IP, Citrix NetScaler, A10 Thunder |
42
+| Infrastructure | APC UPS/PDU, Dell servers, plus standard MIBs (BGP, OSPF, TCP/UDP) |
43
+
44
+> This list highlights major vendors—any SNMP-enabled device can be monitored using stock or custom profiles.
45
38
-Depending on your installation method, both paths may include the `/opt/netdata` prefix.
46
+
47
+::: info
48
+
49
+See: [SNMP Profile Format](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/profile-format.md) to learn how to write your own or extend stock ones.
50
51
:::
52
42
-A *profile* declares:
43
-- device selectors (e.g. `sysObjectID`, `sysDescr`) for auto-matching,
44
-- which OIDs to collect (scalars and tables),
45
-- how to label rows (metric tags), and
46
-- chart/metric metadata (units, families, types), including optional **virtual metrics**.
53
+**Profile locations**
54
48
-At runtime, the collector:
49
-1) identifies the device by reading standard system OIDs (e.g. `sysObjectID`, `sysDescr`),
50
-2) picks the best-matching profile(s), and
51
-3) collects exactly the metrics defined by those profiles.
55
+| Type | Default path | Notes |
56
+|------|--------------|-------|
57
+| **Stock profiles** | `/usr/lib/netdata/conf.d/go.d/snmp.profiles/default/` | Shipped with Netdata |
58
+| **User profiles** | `/etc/netdata/go.d/snmp.profiles/` | Place custom or modified profiles here |
59
53
-Because profiles vary per vendor/model/OS, there is **no fixed list of metrics** in this page. Netdata renders the charts that each matched profile defines (interfaces, optics, CPU/mem, environment, VLANs, etc., depending on the device).
60
+> Depending on installation, paths may be prefixed with `/opt/netdata`.
61
55
-The collector optionally runs **ICMP round-trip (ping)** alongside SNMP for availability and latency. A `ping_only` mode is available to skip periodic SNMP polling.
62
+A **profile** defines:
63
57
-SNMP versions v1, v2c, and v3 are supported, implemented via the [gosnmp](https://github.com/gosnmp/gosnmp) library.
64
+- Device selectors for auto-matching (e.g. `sysObjectID`, `sysDescr`)
65
+- The exact OIDs to collect (scalars and tables)
66
+- How to label table rows (metric tags)
67
+- Chart/metric metadata (units, families, types), including optional **virtual metrics**
68
69
+**At runtime, the collector**:
70
71
+1. Reads standard system OIDs (e.g. `sysObjectID`, `sysDescr`) to identify the device
72
+2. Picks the best matching vendor/model profile(s)
73
+3. Collects exactly the metrics those profiles define
74
75
76
This collector is supported on all platforms.