@cryptotaxi247 / netdata-1 / commits / 3a29352c8

Regenerate integrations docs (#21307)

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

Netdata bot committed Nov 17, 2025 at 13:28 UTC 3a29352c8dbb9ef400a131adc6a396bac5d37064

2 files changed -377

src/collectors/COLLECTORS.md

-1

@@ -215,7 +215,6 @@ 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 -| [SQL Database agnostic](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/sql_database_agnostic.md) | Query SQL databases for efficient database performance monitoring. |

218 | [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**. |

219 | [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. |

220 | [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/sql_database_agnostic.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/sql_database_agnostic.md"

3 -meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/prometheus/metadata.yaml"

4 -sidebar_label: "SQL Database agnostic"

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 -# SQL Database agnostic

12 -

13 -

14 -<img src="https://netdata.cloud/img/sql.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 -Query SQL databases for efficient database performance monitoring.

25 -

26 -

27 -Metrics are gathered by periodically sending HTTP requests to [SQL Exporter](https://github.com/free/sql_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 -

55 -|---------------------------|-------------------------------------------|----------------------|-------------|

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 [SQL Exporter](https://github.com/free/sql_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 -

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 |

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 |

125 -| | label_prefix | Optional prefix added to all labels of all charts. Labels will be formatted as `prefix_name`. | | 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 |

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 |

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/plugin/go.d/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-a-configuration-file-using-edit-config) script from the

212 -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-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 -