@cryptotaxi247 / netdata-1 / commits / 00baa6388

Regenerate integrations docs (#21309)

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

Netdata bot committed Nov 17, 2025 at 13:47 UTC 00baa63885c5c2855ebc8ce937628f4e586b1b23
2 files changed +373
src/collectors/COLLECTORS.md
+1
@@ -215,6 +215,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
215 | [Redis](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/redis/integrations/redis.md) | This collector monitors the health and performance of Redis servers and collects general statistics, CPU and memory consumption, replication information, command statistics, and more. |
216 | [RethinkDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/rethinkdb/integrations/rethinkdb.md) | It collects cluster-wide metrics such as server status, client connections, active clients, query rate, and document read/write rates. |
217 | [Riak KV](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/riakkv/integrations/riak_kv.md) | This collector monitors RiakKV metrics about throughput, latency, resources and more. |
218 +| [ScyllaDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/scylladb.md) | Track ScyllaDB NoSQL database metrics for efficient database management and performance with Netdata's Prometheus integration. |
219 | [SQL databases (generic)](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/sql/integrations/sql_databases_generic.md) | Metrics and charts for this collector are **entirely defined by your SQL configuration**. |
220 | [Vertica](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/vertica.md) | Monitor Vertica analytics database platform metrics for efficient database performance and management. |
221 | [Warp10](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/warp10.md) | Monitor Warp 10 time-series database metrics for efficient time-series data management and performance. |
src/go/plugin/go.d/collector/prometheus/integrations/scylladb.md new
+372
@@ -0,0 +1,372 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/integrations/scylladb.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"
4 +sidebar_label: "ScyllaDB"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Databases"
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 +# ScyllaDB
12 +
13 +
14 +<img src="https://netdata.cloud/img/scylladb.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 ScyllaDB NoSQL database metrics for efficient database management and performance with Netdata's Prometheus integration.
25 +
26 +
27 +Metrics are gathered by periodically sending HTTP requests to the ScyllaDB built-in Prometheus 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 +No action required.
99 +
100 +### Configuration
101 +
102 +#### Options
103 +
104 +The following options can be defined globally: update_every, autodetection_retry.
105 +
106 +
107 +<details open><summary>Config options</summary>
108 +
109 +
110 +
111 +| Group | Option | Description | Default | Required |
112 +|:------|:-----|:------------|:--------|:---------:|
113 +| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
114 +| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
115 +| **Target** | url | Target endpoint URL. | | yes |
116 +| | timeout | HTTP request timeout (seconds). | 10 | no |
117 +| **Filters** | selector | Time series selector (filter). | | no |
118 +| **Limits** | max_time_series | Global time series limit. If an endpoint returns more time series than this, the data is not processed. | 2000 | no |
119 +| | max_time_series_per_metric | Per-metric time series limit. Metrics with more time series than this are skipped. | 200 | no |
120 +| **Customization** | fallback_type | Fallback type rules for untyped metrics. | | no |
121 +| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | no |
122 +| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
123 +| | password | Password for Basic HTTP authentication. | | no |
124 +| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
125 +| **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no |
126 +| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
127 +| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
128 +| | tls_key | Path to client TLS private key (for mTLS). | | no |
129 +| **Proxy** | proxy_url | HTTP proxy URL. | | no |
130 +| | proxy_username | Username for proxy Basic HTTP authentication. | | no |
131 +| | proxy_password | Password for proxy Basic HTTP authentication. | | no |
132 +| **Request** | method | HTTP method to use. | GET | no |
133 +| | body | Request body (e.g., for POST/PUT). | | no |
134 +| | headers | Additional HTTP headers (one per line as key: value). | | no |
135 +| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
136 +| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
137 +| **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 |
138 +
139 +##### selector
140 +
141 +This option allows you to filter out unwanted time series. Only metrics matching the selector will be collected.
142 +
143 +- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
144 +- Pattern syntax: [selector](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/pkg/prometheus/selector/README.md).
145 +- Option syntax:
146 +
147 +```yaml
148 +selector:
149 + allow:
150 + - pattern1
151 + - pattern2
152 + deny:
153 + - pattern3
154 + - pattern4
155 +```
156 +
157 +
158 +##### fallback_type
159 +
160 +This option allows you to process Untyped metrics as Counter or Gauge instead of ignoring them.
161 +
162 +- Metric name pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match).
163 +- Option syntax:
164 +
165 +```yaml
166 +fallback_type:
167 + counter:
168 + - metric_name_pattern1
169 + - metric_name_pattern2
170 + gauge:
171 + - metric_name_pattern3
172 + - metric_name_pattern4
173 +```
174 +
175 +
176 +
177 +</details>
178 +
179 +
180 +#### via UI
181 +
182 +Configure the **prometheus** collector from the Netdata web interface:
183 +
184 +1. Go to **Nodes**.
185 +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.
186 +3. The **Collectors → Jobs** view opens by default.
187 +4. In the Search box, type _prometheus_ (or scroll the list) to locate the **prometheus** collector.
188 +5. Click the **+** next to the **prometheus** collector to add a new job.
189 +6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save.
190 + - **Test** runs the job with the provided settings and shows whether data can be collected.
191 + - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
192 +
193 +
194 +#### via File
195 +
196 +The configuration file name for this integration is `go.d/prometheus.conf`.
197 +
198 +The file format is YAML. Generally, the structure is:
199 +
200 +```yaml
201 +update_every: 1
202 +autodetection_retry: 0
203 +jobs:
204 + - name: some_name1
205 + - name: some_name2
206 +```
207 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
208 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
209 +
210 +```bash
211 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
212 +sudo ./edit-config go.d/prometheus.conf
213 +```
214 +
215 +##### Examples
216 +
217 +###### Basic
218 +
219 +> **Note**: Change the port of the monitored application on which it provides metrics.
220 +
221 +A basic example configuration.
222 +
223 +
224 +```yaml
225 +jobs:
226 + - name: local
227 + url: http://127.0.0.1:9090/metrics
228 +
229 +```
230 +###### Read metrics from a file
231 +
232 +An example configuration to read metrics from a file.
233 +
234 +<details open><summary>Config</summary>
235 +
236 +```yaml
237 +# use "file://" scheme
238 +jobs:
239 + - name: myapp
240 + url: file:///opt/metrics/myapp/metrics.txt
241 +
242 +```
243 +</details>
244 +
245 +###### HTTP authentication
246 +
247 +> **Note**: Change the port of the monitored application on which it provides metrics.
248 +
249 +Basic HTTP authentication.
250 +
251 +
252 +<details open><summary>Config</summary>
253 +
254 +```yaml
255 +jobs:
256 + - name: local
257 + url: http://127.0.0.1:9090/metrics
258 + username: username
259 + password: password
260 +
261 +```
262 +</details>
263 +
264 +###### HTTPS with self-signed certificate
265 +
266 +> **Note**: Change the port of the monitored application on which it provides metrics.
267 +
268 +Do not validate server certificate chain and hostname.
269 +
270 +
271 +<details open><summary>Config</summary>
272 +
273 +```yaml
274 +jobs:
275 + - name: local
276 + url: https://127.0.0.1:9090/metrics
277 + tls_skip_verify: yes
278 +
279 +```
280 +</details>
281 +
282 +###### Multi-instance
283 +
284 +> **Note**: When you define multiple jobs, their names must be unique.
285 +> **Note**: Change the port of the monitored application on which it provides metrics.
286 +
287 +Collecting metrics from local and remote instances.
288 +
289 +
290 +<details open><summary>Config</summary>
291 +
292 +```yaml
293 +jobs:
294 + - name: local
295 + url: http://127.0.0.1:9090/metrics
296 +
297 + - name: remote
298 + url: http://192.0.2.1:9090/metrics
299 +
300 +```
301 +</details>
302 +
303 +
304 +
305 +## Troubleshooting
306 +
307 +### Debug Mode
308 +
309 +**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
310 +
311 +To troubleshoot issues with the `prometheus` collector, run the `go.d.plugin` with the debug option enabled. The output
312 +should give you clues as to why the collector isn't working.
313 +
314 +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
315 + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
316 +
317 + ```bash
318 + cd /usr/libexec/netdata/plugins.d/
319 + ```
320 +
321 +- Switch to the `netdata` user.
322 +
323 + ```bash
324 + sudo -u netdata -s
325 + ```
326 +
327 +- Run the `go.d.plugin` to debug the collector:
328 +
329 + ```bash
330 + ./go.d.plugin -d -m prometheus
331 + ```
332 +
333 + To debug a specific job:
334 +
335 + ```bash
336 + ./go.d.plugin -d -m prometheus -j jobName
337 + ```
338 +
339 +### Getting Logs
340 +
341 +If you're encountering problems with the `prometheus` collector, follow these steps to retrieve logs and identify potential issues:
342 +
343 +- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
344 +- **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.
345 +
346 +#### System with systemd
347 +
348 +Use the following command to view logs generated since the last Netdata service restart:
349 +
350 +```bash
351 +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep prometheus
352 +```
353 +
354 +#### System without systemd
355 +
356 +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
357 +
358 +```bash
359 +grep prometheus /var/log/netdata/collector.log
360 +```
361 +
362 +**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
363 +
364 +#### Docker Container
365 +
366 +If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
367 +
368 +```bash
369 +docker logs netdata 2>&1 | grep prometheus
370 +```
371 +
372 +