Regenerate integrations docs (#21923)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Mar 9, 2026 at 19:46 UTC
551cc100e7f77fdc892e5fe36a0d00b9544332d2
3 files changed
+64
-56
src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md
+20
-17
@@ -586,14 +586,14 @@ The following options can be defined globally: update_every, autodetection_retry
586
|:------|:-----|:------------|:--------|:---------:|
587
| **Collection** | update_every | Data collection interval (seconds). | 10 | no |
588
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
589
-| **Target** | dsn | SQL Server DSN (Data Source Name). See [DSN syntax](https://github.com/microsoft/go-mssqldb#connection-parameters-and-dsn). When `azure_ad.enabled` is true, use URL format with `sqlserver://` scheme. | sqlserver://localhost:1433 | yes |
590
-| | azure_ad.enabled | Enable Microsoft Entra (Azure AD) authentication for Azure SQL. | no | no |
591
-| | azure_ad.mode | Azure AD credential mode (`service_principal`, `managed_identity`, or `default`). | default | no |
592
-| | azure_ad.tenant_id | Azure tenant ID. Required for `service_principal` mode. | | no |
593
-| | azure_ad.client_id | Azure client ID. Required for `service_principal`; optional for user-assigned managed identity. | | no |
594
-| | azure_ad.client_secret | Azure client secret for `service_principal` mode. | | no |
595
-| | azure_ad.managed_identity_client_id | Optional client ID of a user-assigned managed identity (`managed_identity` mode). | | no |
596
-| | timeout | Query timeout (seconds). | 5 | no |
589
+| **Target** | dsn | SQL Server DSN (Data Source Name). See [DSN syntax](https://github.com/microsoft/go-mssqldb#connection-parameters-and-dsn). When `cloud_auth.provider` is `azure_ad`, use URL format with `sqlserver://` scheme. | sqlserver://localhost:1433 | yes |
590
+| **Cloud Auth** | cloud_auth.provider | Cloud auth provider (`none` or `azure_ad`). | none | no |
591
+| **Cloud Auth/Azure** | cloud_auth.azure_ad.mode | Azure AD credential mode (`service_principal`, `managed_identity`, or `default`). | default | no |
592
+| | cloud_auth.azure_ad.tenant_id | Azure tenant ID. Required for `service_principal` mode. | | no |
593
+| | cloud_auth.azure_ad.client_id | Azure client ID. Required for `service_principal`; optional for user-assigned managed identity. | | no |
594
+| | cloud_auth.azure_ad.client_secret | Azure client secret for `service_principal` mode. | | no |
595
+| | cloud_auth.azure_ad.managed_identity_client_id | Optional client ID of a user-assigned managed identity (`managed_identity` mode). | | no |
596
+| **Target** | timeout | Query timeout (seconds). | 5 | no |
597
| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
598
| | functions.top_queries.timeout | Query timeout for top-queries function (seconds). Uses collector timeout if not set. | | no |
599
| | functions.top_queries.limit | Maximum number of queries to return in the top-queries response. | 500 | no |
@@ -714,12 +714,13 @@ Use Microsoft Entra service principal authentication for Azure SQL.
714
jobs:
715
- name: azure_sql_sp
716
dsn: "sqlserver://my-server.database.windows.net:1433?database=mydb"
717
- azure_ad:
718
- enabled: true
719
- mode: service_principal
720
- tenant_id: "00000000-0000-0000-0000-000000000000"
721
- client_id: "11111111-1111-1111-1111-111111111111"
722
- client_secret: "super-secret-value"
717
+ cloud_auth:
718
+ provider: azure_ad
719
+ azure_ad:
720
+ mode: service_principal
721
+ tenant_id: "00000000-0000-0000-0000-000000000000"
722
+ client_id: "11111111-1111-1111-1111-111111111111"
723
+ client_secret: "super-secret-value"
724
725
```
726
</details>
@@ -734,9 +735,10 @@ Use managed identity authentication (system-assigned by default).
735
jobs:
736
- name: azure_sql_mi
737
dsn: "sqlserver://my-server.database.windows.net:1433?database=mydb"
737
- azure_ad:
738
- enabled: true
739
- mode: managed_identity
738
+ cloud_auth:
739
+ provider: azure_ad
740
+ azure_ad:
741
+ mode: managed_identity
742
743
```
744
</details>
@@ -874,3 +876,4 @@ The monitoring user needs VIEW SERVER STATE permission.
876
Grant it with: `GRANT VIEW SERVER STATE TO netdata_user;`
877
878
879
+
src/go/plugin/go.d/collector/postgres/integrations/postgresql.md
+18
-16
@@ -529,13 +529,13 @@ The following options can be defined globally: update_every, autodetection_retry
529
| **Collection** | update_every | Data collection interval (seconds). | 1 | no |
530
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
531
| **Target** | dsn | Postgres connection string (DSN). See [DSN syntax](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING). | postgres://postgres:postgres@127.0.0.1:5432/postgres | yes |
532
-| | azure_ad.enabled | Enable Microsoft Entra (Azure AD) token authentication for Azure Database for PostgreSQL. | no | no |
533
-| | azure_ad.mode | Azure AD credential mode (`service_principal`, `managed_identity`, or `default`). | default | no |
534
-| | azure_ad.tenant_id | Azure tenant ID. Required for `service_principal` mode. | | no |
535
-| | azure_ad.client_id | Azure client ID. Required for `service_principal`; optional for user-assigned managed identity. | | no |
536
-| | azure_ad.client_secret | Azure client secret for `service_principal` mode. | | no |
537
-| | azure_ad.managed_identity_client_id | Optional client ID of a user-assigned managed identity (`managed_identity` mode). | | no |
538
-| | timeout | Query timeout (seconds). | 2 | no |
532
+| **Cloud Auth** | cloud_auth.provider | Cloud auth provider (`none` or `azure_ad`). | none | no |
533
+| **Cloud Auth/Azure** | cloud_auth.azure_ad.mode | Azure AD credential mode (`service_principal`, `managed_identity`, or `default`). | default | no |
534
+| | cloud_auth.azure_ad.tenant_id | Azure tenant ID. Required for `service_principal` mode. | | no |
535
+| | cloud_auth.azure_ad.client_id | Azure client ID. Required for `service_principal`; optional for user-assigned managed identity. | | no |
536
+| | cloud_auth.azure_ad.client_secret | Azure client secret for `service_principal` mode. | | no |
537
+| | cloud_auth.azure_ad.managed_identity_client_id | Optional client ID of a user-assigned managed identity (`managed_identity` mode). | | no |
538
+| **Target** | timeout | Query timeout (seconds). | 2 | no |
539
| **Filters** | collect_databases_matching | Database selector. Controls which databases are included. Uses [simple patterns](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#simple-patterns-matcher). | | no |
540
| **Limits** | max_db_tables | Maximum number of tables per database to collect metrics for (0 = no limit). | 50 | no |
541
| | max_db_indexes | Maximum number of indexes per database to collect metrics for (0 = no limit). | 250 | no |
@@ -633,12 +633,13 @@ Use Microsoft Entra service principal authentication.
633
jobs:
634
- name: azure_postgres_sp
635
dsn: 'postgresql://netdata@myserver.postgres.database.azure.com:5432/postgres?sslmode=require'
636
- azure_ad:
637
- enabled: true
638
- mode: service_principal
639
- tenant_id: "00000000-0000-0000-0000-000000000000"
640
- client_id: "11111111-1111-1111-1111-111111111111"
641
- client_secret: "super-secret-value"
636
+ cloud_auth:
637
+ provider: azure_ad
638
+ azure_ad:
639
+ mode: service_principal
640
+ tenant_id: "00000000-0000-0000-0000-000000000000"
641
+ client_id: "11111111-1111-1111-1111-111111111111"
642
+ client_secret: "super-secret-value"
643
644
```
645
</details>
@@ -653,9 +654,10 @@ Use managed identity authentication (system-assigned by default).
654
jobs:
655
- name: azure_postgres_mi
656
dsn: 'postgresql://netdata@myserver.postgres.database.azure.com:5432/postgres?sslmode=require'
656
- azure_ad:
657
- enabled: true
658
- mode: managed_identity
657
+ cloud_auth:
658
+ provider: azure_ad
659
+ azure_ad:
660
+ mode: managed_identity
661
662
```
663
</details>
src/go/plugin/go.d/collector/sql/integrations/sql_databases_generic.md
+26
-23
@@ -197,13 +197,14 @@ dsn: "<connection string>" # REQUIRED. Driver-specific DSN/URL
197
198
# Optional connection settings
199
timeout: <seconds> # OPTIONAL. Query timeout.
200
-azure_ad: # OPTIONAL. Azure AD auth for pgx/sqlserver/azuresql.
201
- enabled: <true|false>
202
- mode: <service_principal|managed_identity|default>
203
- tenant_id: "<tenant-id>" # REQUIRED for service_principal
204
- client_id: "<client-id>" # REQUIRED for service_principal
205
- client_secret: "<client-secret>" # REQUIRED for service_principal
206
- managed_identity_client_id: "<client-id>" # Optional for user-assigned MI
200
+cloud_auth: # OPTIONAL. Cloud auth for pgx/sqlserver/azuresql.
201
+ provider: <none|azure_ad> # OPTIONAL. Default: none.
202
+ azure_ad:
203
+ mode: <service_principal|managed_identity|default>
204
+ tenant_id: "<tenant-id>" # REQUIRED for service_principal
205
+ client_id: "<client-id>" # REQUIRED for service_principal
206
+ client_secret: "<client-secret>" # REQUIRED for service_principal
207
+ managed_identity_client_id: "<client-id>" # Optional for user-assigned MI
208
209
# Optional static labels applied to all charts
210
static_labels:
@@ -310,13 +311,13 @@ functions:
311
| | autodetection_retry | Autodetection retry interval (seconds). Not used for this collector. Set 0 to disable. | 0 | no |
312
| **Target** | driver | SQL driver to use. Supported values: `mysql`, `pgx`, `oracle`, `sqlserver`, `azuresql`. | mysql | yes |
313
| | dsn | Database connection string (DSN). The format depends on the selected driver ( [MySQL](https://github.com/go-sql-driver/mysql#dsn-data-source-name), [PostgreSQL](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS), [MS SQL Server](https://github.com/microsoft/go-mssqldb#connection-parameters-and-dsn)). | | yes |
313
-| **Connection** | azure_ad.enabled | Enable Microsoft Entra (Azure AD) authentication. Supported for `pgx`, `sqlserver`, and `azuresql`. | no | no |
314
-| | azure_ad.mode | Azure AD credential mode (`service_principal`, `managed_identity`, or `default`). | default | no |
315
-| | azure_ad.tenant_id | Azure tenant ID. Required for `service_principal` mode. | | no |
316
-| | azure_ad.client_id | Azure client ID. Required for `service_principal`; optional for user-assigned managed identity. | | no |
317
-| | azure_ad.client_secret | Azure client secret for `service_principal` mode. | | no |
318
-| | azure_ad.managed_identity_client_id | Optional client ID of a user-assigned managed identity (`managed_identity` mode). | | no |
319
-| | timeout | Query and connection check timeout (seconds). | 5 | no |
314
+| **Cloud Auth** | cloud_auth.provider | Cloud auth provider (`none` or `azure_ad`). Supported for `pgx`, `sqlserver`, and `azuresql`. | none | no |
315
+| **Cloud Auth/Azure** | cloud_auth.azure_ad.mode | Azure AD credential mode (`service_principal`, `managed_identity`, or `default`). | default | no |
316
+| | cloud_auth.azure_ad.tenant_id | Azure tenant ID. Required for `service_principal` mode. | | no |
317
+| | cloud_auth.azure_ad.client_id | Azure client ID. Required for `service_principal`; optional for user-assigned managed identity. | | no |
318
+| | cloud_auth.azure_ad.client_secret | Azure client secret for `service_principal` mode. | | no |
319
+| | cloud_auth.azure_ad.managed_identity_client_id | Optional client ID of a user-assigned managed identity (`managed_identity` mode). | | no |
320
+| **Connection** | timeout | Query and connection check timeout (seconds). | 5 | no |
321
| **Labels** | static_labels | A map of static labels added to every chart created by this job. Useful for tagging charts with environment, region, or role. | {} | no |
322
| **Queries & Metrics** | queries | A list of reusable queries. Metric blocks can reference these via `query_ref` to avoid repeating SQL. See [Configuration Structure](#configuration) for details. | [] | no |
323
| | metrics | A list of metric blocks. Each block defines how a query is executed and how its result is transformed into one or more charts. See [Configuration Structure](#configuration) for details. | [] | no |
@@ -387,12 +388,13 @@ jobs:
388
driver: azuresql
389
dsn: "sqlserver://my-server.database.windows.net:1433?database=master"
390
timeout: 5
390
- azure_ad:
391
- enabled: true
392
- mode: service_principal
393
- tenant_id: "00000000-0000-0000-0000-000000000000"
394
- client_id: "11111111-1111-1111-1111-111111111111"
395
- client_secret: "super-secret-value"
391
+ cloud_auth:
392
+ provider: azure_ad
393
+ azure_ad:
394
+ mode: service_principal
395
+ tenant_id: "00000000-0000-0000-0000-000000000000"
396
+ client_id: "11111111-1111-1111-1111-111111111111"
397
+ client_secret: "super-secret-value"
398
metrics:
399
- id: user_connections
400
mode: columns
@@ -425,9 +427,10 @@ jobs:
427
driver: pgx
428
dsn: 'postgresql://netdata@myserver.postgres.database.azure.com:5432/postgres?sslmode=require'
429
timeout: 5
428
- azure_ad:
429
- enabled: true
430
- mode: default
430
+ cloud_auth:
431
+ provider: azure_ad
432
+ azure_ad:
433
+ mode: default
434
metrics:
435
- id: uptime
436
mode: columns