Regenerate integrations docs (#21623)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jan 23, 2026 at 11:16 UTC
3348493437c061355323eb2777a6dbff94f772aa
17 files changed
+750
-566
src/go/plugin/go.d/collector/clickhouse/integrations/clickhouse.md
+31
-21
@@ -178,16 +178,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
178
179
### Top Queries
180
181
+Top SQL queries from ClickHouse system.query_log.
182
+
183
+Queries system.query_log, aggregates by query, and returns the top entries sorted by the selected column.
184
+
185
+
186
| Aspect | Description |
187
|:-------|:------------|
188
| Name | `Clickhouse:top-queries` |
184
-| Summary | Top SQL queries from ClickHouse system.query_log. |
185
-| Behavior | Queries system.query_log, aggregates by query, and returns the top entries sorted by the selected column. |
189
| Performance | Uses system.query_log and can be expensive on busy systems. Use limits to control response size. |
190
| Security | Query text may include sensitive literals depending on server settings. |
188
-| Requirements | Requires access to system.query_log on the target ClickHouse instance. |
191
| Availability | Available when the collector can query system tables; returns 503 if system.query_log is not available. |
192
193
+#### Prerequisites
194
+
195
+##### Grant access to system.query_log
196
+
197
+Ensure the Netdata user can read system.query_log on the target ClickHouse instance.
198
+
199
+
200
+
201
#### Parameters
202
203
| Parameter | Type | Description | Required | Default | Options |
@@ -198,24 +208,24 @@ This collector exposes real-time functions for interactive troubleshooting in th
208
209
Aggregated query statistics from system.query_log.
210
201
-| Column | Type | Description |
202
-|:-------|:-----|:------------|
203
-| Query ID | string | |
204
-| Query | string | |
205
-| Database | string | |
206
-| User | string | |
207
-| Calls | integer | |
208
-| Total Time | duration | |
209
-| Avg Time | duration | |
210
-| Min Time | duration | |
211
-| Max Time | duration | |
212
-| Read Rows | integer | |
213
-| Read Bytes | integer | |
214
-| Written Rows | integer | |
215
-| Written Bytes | integer | |
216
-| Result Rows | integer | |
217
-| Result Bytes | integer | |
218
-| Max Memory | float | |
211
+| Column | Type | Unit | Visibility | Description |
212
+|:-------|:-----|:-----|:-----------|:------------|
213
+| Query ID | string | | hidden | |
214
+| Query | string | | | |
215
+| Database | string | | | |
216
+| User | string | | | |
217
+| Calls | integer | | | |
218
+| Total Time | duration | milliseconds | | |
219
+| Avg Time | duration | milliseconds | | |
220
+| Min Time | duration | milliseconds | hidden | |
221
+| Max Time | duration | milliseconds | hidden | |
222
+| Read Rows | integer | | | |
223
+| Read Bytes | integer | | | |
224
+| Written Rows | integer | | hidden | |
225
+| Written Bytes | integer | | hidden | |
226
+| Result Rows | integer | | | |
227
+| Result Bytes | integer | | hidden | |
228
+| Max Memory | float | | hidden | |
229
230
231
src/go/plugin/go.d/collector/cockroachdb/integrations/cockroachdb.md
+61
-41
@@ -142,16 +142,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
142
143
### Top Queries
144
145
+Top SQL statements from crdb_internal.cluster_statement_statistics.
146
+
147
+Queries crdb_internal.cluster_statement_statistics and returns the top entries sorted by the selected column.
148
+
149
+
150
| Aspect | Description |
151
|:-------|:------------|
152
| Name | `Cockroachdb:top-queries` |
148
-| Summary | Top SQL statements from crdb_internal.cluster_statement_statistics. |
149
-| Behavior | Queries crdb_internal.cluster_statement_statistics and returns the top entries sorted by the selected column. |
153
| Performance | Executes SQL queries against system tables and may be expensive on busy clusters. |
154
| Security | Query text may contain unmasked literals (potential PII). |
152
-| Requirements | Requires a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to crdb_internal.cluster_statement_statistics. |
155
| Availability | Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable. |
156
157
+#### Prerequisites
158
+
159
+##### Grant VIEWACTIVITY access to cluster statement stats
160
+
161
+Use a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to crdb_internal.cluster_statement_statistics.
162
+
163
+
164
+
165
#### Parameters
166
167
| Parameter | Type | Description | Required | Default | Options |
@@ -162,41 +172,51 @@ This collector exposes real-time functions for interactive troubleshooting in th
172
173
Aggregated SQL statement statistics.
174
165
-| Column | Type | Description |
166
-|:-------|:-----|:------------|
167
-| Fingerprint ID | string | |
168
-| Query | string | |
169
-| Database | string | |
170
-| Application | string | |
171
-| Statement Type | string | |
172
-| Distributed | string | |
173
-| Full Scan | string | |
174
-| Implicit Txn | string | |
175
-| Vectorized | string | |
176
-| Executions | integer | |
177
-| Total Time | duration | |
178
-| Mean Time | duration | |
179
-| Run Time | duration | |
180
-| Plan Time | duration | |
181
-| Parse Time | duration | |
182
-| Rows Read | integer | |
183
-| Rows Written | integer | |
184
-| Rows Returned | integer | |
185
-| Bytes Read | integer | |
186
-| Max Retries | integer | |
175
+| Column | Type | Unit | Visibility | Description |
176
+|:-------|:-----|:-----|:-----------|:------------|
177
+| Fingerprint ID | string | | hidden | |
178
+| Query | string | | | |
179
+| Database | string | | | |
180
+| Application | string | | | |
181
+| Statement Type | string | | hidden | |
182
+| Distributed | string | | hidden | |
183
+| Full Scan | string | | hidden | |
184
+| Implicit Txn | string | | hidden | |
185
+| Vectorized | string | | hidden | |
186
+| Executions | integer | | | |
187
+| Total Time | duration | milliseconds | | |
188
+| Mean Time | duration | milliseconds | | |
189
+| Run Time | duration | milliseconds | hidden | |
190
+| Plan Time | duration | milliseconds | hidden | |
191
+| Parse Time | duration | milliseconds | hidden | |
192
+| Rows Read | integer | | | |
193
+| Rows Written | integer | | | |
194
+| Rows Returned | integer | | | |
195
+| Bytes Read | integer | | hidden | |
196
+| Max Retries | integer | | hidden | |
197
198
### Running Queries
199
200
+Currently running SQL statements from SHOW CLUSTER STATEMENTS.
201
+
202
+Queries SHOW CLUSTER STATEMENTS and returns running statements sorted by the selected column.
203
+
204
+
205
| Aspect | Description |
206
|:-------|:------------|
207
| Name | `Cockroachdb:running-queries` |
193
-| Summary | Currently running SQL statements from SHOW CLUSTER STATEMENTS. |
194
-| Behavior | Queries SHOW CLUSTER STATEMENTS and returns running statements sorted by the selected column. |
208
| Performance | Executes SQL queries against system tables and may be expensive on busy clusters. |
209
| Security | Query text may contain unmasked literals (potential PII). |
197
-| Requirements | Requires a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to system tables. |
210
| Availability | Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable. |
211
212
+#### Prerequisites
213
+
214
+##### Grant VIEWACTIVITY access to system tables
215
+
216
+Use a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to system tables.
217
+
218
+
219
+
220
#### Parameters
221
222
| Parameter | Type | Description | Required | Default | Options |
@@ -207,19 +227,19 @@ Aggregated SQL statement statistics.
227
228
Snapshot of currently running SQL statements.
229
210
-| Column | Type | Description |
211
-|:-------|:-----|:------------|
212
-| Query ID | string | |
213
-| Query | string | |
214
-| User | string | |
215
-| Application | string | |
216
-| Client Address | string | |
217
-| Node ID | string | |
218
-| Session ID | string | |
219
-| Phase | string | |
220
-| Distributed | string | |
221
-| Start Time | string | |
222
-| Elapsed | duration | |
230
+| Column | Type | Unit | Visibility | Description |
231
+|:-------|:-----|:-----|:-----------|:------------|
232
+| Query ID | string | | hidden | |
233
+| Query | string | | | |
234
+| User | string | | | |
235
+| Application | string | | | |
236
+| Client Address | string | | hidden | |
237
+| Node ID | string | | hidden | |
238
+| Session ID | string | | hidden | |
239
+| Phase | string | | | |
240
+| Distributed | string | | hidden | |
241
+| Start Time | string | | hidden | |
242
+| Elapsed | duration | milliseconds | | |
243
244
245
src/go/plugin/go.d/collector/couchbase/integrations/couchbase.md
+26
-16
@@ -82,16 +82,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
82
83
### Top Queries
84
85
+Top N1QL requests from system:completed_requests.
86
+
87
+Queries the system:completed_requests keyspace and returns the top entries sorted by the selected column.
88
+
89
+
90
| Aspect | Description |
91
|:-------|:------------|
92
| Name | `Couchbase:top-queries` |
88
-| Summary | Top N1QL requests from system:completed_requests. |
89
-| Behavior | Queries the system:completed_requests keyspace and returns the top entries sorted by the selected column. |
93
| Performance | Runs N1QL queries against system keyspaces; use top_queries_limit to control response size. |
94
| Security | Query text may include sensitive literals depending on workload. |
92
-| Requirements | Requires access to the system:completed_requests keyspace and N1QL service. |
95
| Availability | Available when the collector can query system keyspaces; returns 503 until the collector is initialized. |
96
97
+#### Prerequisites
98
+
99
+##### Grant access to system:completed_requests
100
+
101
+Ensure the user can query system:completed_requests and the N1QL service is available.
102
+
103
+
104
+
105
#### Parameters
106
107
| Parameter | Type | Description | Required | Default | Options |
@@ -102,19 +112,19 @@ This collector exposes real-time functions for interactive troubleshooting in th
112
113
Completed N1QL request statistics.
114
105
-| Column | Type | Description |
106
-|:-------|:-----|:------------|
107
-| Request ID | string | |
108
-| Request Time | timestamp | |
109
-| Statement | string | |
110
-| Elapsed Time | duration | |
111
-| Service Time | duration | |
112
-| Result Count | integer | |
113
-| Result Size | integer | |
114
-| Error Count | integer | |
115
-| Warning Count | integer | |
116
-| User | string | |
117
-| Client Context ID | string | |
115
+| Column | Type | Unit | Visibility | Description |
116
+|:-------|:-----|:-----|:-----------|:------------|
117
+| Request ID | string | | hidden | |
118
+| Request Time | timestamp | | | |
119
+| Statement | string | | | |
120
+| Elapsed Time | duration | milliseconds | | |
121
+| Service Time | duration | milliseconds | | |
122
+| Result Count | integer | | | |
123
+| Result Size | integer | | hidden | |
124
+| Error Count | integer | | hidden | |
125
+| Warning Count | integer | | hidden | |
126
+| User | string | | | |
127
+| Client Context ID | string | | hidden | |
128
129
130
src/go/plugin/go.d/collector/elasticsearch/integrations/elasticsearch.md
+21
-15
@@ -173,16 +173,22 @@ This collector exposes real-time functions for interactive troubleshooting in th
173
174
### Top Queries
175
176
+Running queries from the Elasticsearch Tasks API.
177
+
178
+Calls the Tasks API and returns running task details sorted by the selected column.
179
+
180
+
181
| Aspect | Description |
182
|:-------|:------------|
183
| Name | `Elasticsearch:top-queries` |
179
-| Summary | Running queries from the Elasticsearch Tasks API. |
180
-| Behavior | Calls the Tasks API and returns running task details sorted by the selected column. |
184
| Performance | Queries the Tasks API; on large clusters this may return many rows. |
185
| Security | Task descriptions may include query details. |
183
-| Requirements | Requires access to the Tasks API on the target Elasticsearch node. |
186
| Availability | Available when the collector can query the Tasks API; returns 503 until the collector is initialized. |
187
188
+#### Prerequisites
189
+
190
+No additional configuration is required.
191
+
192
#### Parameters
193
194
| Parameter | Type | Description | Required | Default | Options |
@@ -193,18 +199,18 @@ This collector exposes real-time functions for interactive troubleshooting in th
199
200
Snapshot of running tasks from the Tasks API.
201
196
-| Column | Type | Description |
197
-|:-------|:-----|:------------|
198
-| Task ID | string | |
199
-| Node ID | string | |
200
-| Node Name | string | |
201
-| Action | string | |
202
-| Type | string | |
203
-| Description | string | |
204
-| Start Time | timestamp | |
205
-| Running Time | duration | |
206
-| Cancellable | boolean | |
207
-| Cancelled | boolean | |
202
+| Column | Type | Unit | Visibility | Description |
203
+|:-------|:-----|:-----|:-----------|:------------|
204
+| Task ID | string | | hidden | |
205
+| Node ID | string | | | |
206
+| Node Name | string | | | |
207
+| Action | string | | | |
208
+| Type | string | | hidden | |
209
+| Description | string | | | |
210
+| Start Time | timestamp | | | |
211
+| Running Time | duration | milliseconds | | |
212
+| Cancellable | boolean | | hidden | |
213
+| Cancelled | boolean | | hidden | |
214
215
216
src/go/plugin/go.d/collector/elasticsearch/integrations/opensearch.md
+21
-15
@@ -173,16 +173,22 @@ This collector exposes real-time functions for interactive troubleshooting in th
173
174
### Top Queries
175
176
+Running queries from the Elasticsearch Tasks API.
177
+
178
+Calls the Tasks API and returns running task details sorted by the selected column.
179
+
180
+
181
| Aspect | Description |
182
|:-------|:------------|
183
| Name | `Elasticsearch:top-queries` |
179
-| Summary | Running queries from the Elasticsearch Tasks API. |
180
-| Behavior | Calls the Tasks API and returns running task details sorted by the selected column. |
184
| Performance | Queries the Tasks API; on large clusters this may return many rows. |
185
| Security | Task descriptions may include query details. |
183
-| Requirements | Requires access to the Tasks API on the target Elasticsearch node. |
186
| Availability | Available when the collector can query the Tasks API; returns 503 until the collector is initialized. |
187
188
+#### Prerequisites
189
+
190
+No additional configuration is required.
191
+
192
#### Parameters
193
194
| Parameter | Type | Description | Required | Default | Options |
@@ -193,18 +199,18 @@ This collector exposes real-time functions for interactive troubleshooting in th
199
200
Snapshot of running tasks from the Tasks API.
201
196
-| Column | Type | Description |
197
-|:-------|:-----|:------------|
198
-| Task ID | string | |
199
-| Node ID | string | |
200
-| Node Name | string | |
201
-| Action | string | |
202
-| Type | string | |
203
-| Description | string | |
204
-| Start Time | timestamp | |
205
-| Running Time | duration | |
206
-| Cancellable | boolean | |
207
-| Cancelled | boolean | |
202
+| Column | Type | Unit | Visibility | Description |
203
+|:-------|:-----|:-----|:-----------|:------------|
204
+| Task ID | string | | hidden | |
205
+| Node ID | string | | | |
206
+| Node Name | string | | | |
207
+| Action | string | | | |
208
+| Type | string | | hidden | |
209
+| Description | string | | | |
210
+| Start Time | timestamp | | | |
211
+| Running Time | duration | milliseconds | | |
212
+| Cancellable | boolean | | hidden | |
213
+| Cancelled | boolean | | hidden | |
214
215
216
src/go/plugin/go.d/collector/mongodb/integrations/mongodb.md
+52
-42
@@ -59,9 +59,9 @@ Metrics grouped by *scope*.
59
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
60
61
- WireTiger metrics are available only if [WiredTiger](https://docs.mongodb.com/v6.0/core/wiredtiger/) is used as the
62
- storage engine.
62
+storage engine.
63
- Sharding metrics are available on shards only
64
- for [mongos](https://www.mongodb.com/docs/manual/reference/program/mongos/).
64
+for [mongos](https://www.mongodb.com/docs/manual/reference/program/mongos/).
65
66
67
### Per MongoDB instance
@@ -212,16 +212,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
212
213
### Top Queries
214
215
+Top queries from MongoDB Profiler (system.profile). WARNING: Query text may contain unmasked literals (potential PII).
216
+
217
+Reads from system.profile and returns the top profiled queries sorted by the selected column.
218
+
219
+
220
| Aspect | Description |
221
|:-------|:------------|
222
| Name | `Mongodb:top-queries` |
218
-| Summary | Top queries from MongoDB Profiler (system.profile). WARNING: Query text may contain unmasked literals (potential PII). |
219
-| Behavior | Reads from system.profile and returns the top profiled queries sorted by the selected column. |
223
| Performance | Requires profiling and reads from system.profile; may add load on busy systems. |
224
| Security | Query text may contain unmasked literals (potential PII). |
222
-| Requirements | Requires MongoDB profiling enabled on target databases and top_queries_function_enabled set to true. |
225
| Availability | Available when profiling is enabled and the collector is initialized; returns 403 if disabled in config. |
226
227
+#### Prerequisites
228
+
229
+##### Enable MongoDB profiling
230
+
231
+Enable profiling on the target databases and set top_queries_function_enabled to true.
232
+
233
+
234
+
235
#### Parameters
236
237
| Parameter | Type | Description | Required | Default | Options |
@@ -232,36 +242,36 @@ This collector exposes real-time functions for interactive troubleshooting in th
242
243
Profiled query statistics from system.profile.
244
235
-| Column | Type | Description |
236
-|:-------|:-----|:------------|
237
-| Timestamp | timestamp | |
238
-| Namespace | string | |
239
-| Operation | string | |
240
-| Query | string | |
241
-| Execution Time | duration | |
242
-| Docs Examined | integer | |
243
-| Keys Examined | integer | |
244
-| Docs Returned | integer | |
245
-| Plan Summary | string | |
246
-| Client | string | |
247
-| User | string | |
248
-| Docs Deleted | integer | |
249
-| Docs Inserted | integer | |
250
-| Docs Modified | integer | |
251
-| Response Length | integer | |
252
-| Num Yield | integer | |
253
-| App Name | string | |
254
-| Cursor Exhausted | string | |
255
-| Has Sort Stage | string | |
256
-| Uses Disk | string | |
257
-| From Multi Planner | string | |
258
-| Replanned | string | |
259
-| Query Hash | string | |
260
-| Plan Cache Key | string | |
261
-| Planning Time | duration | |
262
-| CPU Time | duration | |
263
-| Query Framework | string | |
264
-| Query Shape Hash | string | |
245
+| Column | Type | Unit | Visibility | Description |
246
+|:-------|:-----|:-----|:-----------|:------------|
247
+| Timestamp | timestamp | | | |
248
+| Namespace | string | | | |
249
+| Operation | string | | | |
250
+| Query | string | | | |
251
+| Execution Time | duration | seconds | | |
252
+| Docs Examined | integer | | | |
253
+| Keys Examined | integer | | | |
254
+| Docs Returned | integer | | | |
255
+| Plan Summary | string | | | |
256
+| Client | string | | | |
257
+| User | string | | | |
258
+| Docs Deleted | integer | | hidden | |
259
+| Docs Inserted | integer | | hidden | |
260
+| Docs Modified | integer | | hidden | |
261
+| Response Length | integer | | hidden | |
262
+| Num Yield | integer | | hidden | |
263
+| App Name | string | | | |
264
+| Cursor Exhausted | string | | hidden | |
265
+| Has Sort Stage | string | | hidden | |
266
+| Uses Disk | string | | hidden | |
267
+| From Multi Planner | string | | hidden | |
268
+| Replanned | string | | hidden | |
269
+| Query Hash | string | | hidden | |
270
+| Plan Cache Key | string | | hidden | |
271
+| Planning Time | duration | seconds | hidden | |
272
+| CPU Time | duration | seconds | hidden | |
273
+| Query Framework | string | | hidden | |
274
+| Query Shape Hash | string | | hidden | |
275
276
277
@@ -304,13 +314,13 @@ Create a read-only user for Netdata in the admin database.
314
315
```bash
316
db.createUser({
307
- "user":"netdata",
308
- "pwd": "<UNIQUE_PASSWORD>",
309
- "roles" : [
310
- {role: 'read', db: 'admin' },
311
- {role: 'clusterMonitor', db: 'admin'},
312
- {role: 'read', db: 'local' }
313
- ]
317
+ "user":"netdata",
318
+ "pwd": "<UNIQUE_PASSWORD>",
319
+ "roles" : [
320
+ {role: 'read', db: 'admin' },
321
+ {role: 'clusterMonitor', db: 'admin'},
322
+ {role: 'read', db: 'local' }
323
+ ]
324
})
325
```
326
src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md
+75
-65
@@ -241,16 +241,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
241
242
### Top Queries
243
244
+Top SQL queries from Query Store.
245
+
246
+Queries Query Store runtime statistics and returns the top entries sorted by the selected column.
247
+
248
+
249
| Aspect | Description |
250
|:-------|:------------|
251
| Name | `Mssql:top-queries` |
247
-| Summary | Top SQL queries from Query Store. |
248
-| Behavior | Queries Query Store runtime statistics and returns the top entries sorted by the selected column. |
252
| Performance | Uses Query Store and can be expensive on busy instances. |
253
| Security | Query Store may contain unmasked literals (potential PII). |
251
-| Requirements | Requires Query Store enabled and query_store_function_enabled set to true. |
254
| Availability | Available when Query Store is enabled and the collector is initialized; returns 403 if disabled in config. |
255
256
+#### Prerequisites
257
+
258
+##### Enable Query Store functions
259
+
260
+Enable Query Store and set query_store_function_enabled to true.
261
+
262
+
263
+
264
#### Parameters
265
266
| Parameter | Type | Description | Required | Default | Options |
@@ -261,68 +271,68 @@ This collector exposes real-time functions for interactive troubleshooting in th
271
272
Query Store statistics for top queries.
273
264
-| Column | Type | Description |
265
-|:-------|:-----|:------------|
266
-| Query Hash | string | |
267
-| Query | string | |
268
-| Database | string | |
269
-| Calls | integer | |
270
-| Total Time | duration | |
271
-| Avg Time | duration | |
272
-| Last Time | duration | |
273
-| Min Time | duration | |
274
-| Max Time | duration | |
275
-| StdDev Time | duration | |
276
-| Avg CPU | duration | |
277
-| Last CPU | duration | |
278
-| Min CPU | duration | |
279
-| Max CPU | duration | |
280
-| StdDev CPU | duration | |
281
-| Avg Logical Reads | float | |
282
-| Last Logical Reads | integer | |
283
-| Min Logical Reads | integer | |
284
-| Max Logical Reads | integer | |
285
-| StdDev Logical Reads | float | |
286
-| Avg Logical Writes | float | |
287
-| Last Logical Writes | integer | |
288
-| Min Logical Writes | integer | |
289
-| Max Logical Writes | integer | |
290
-| StdDev Logical Writes | float | |
291
-| Avg Physical Reads | float | |
292
-| Last Physical Reads | integer | |
293
-| Min Physical Reads | integer | |
294
-| Max Physical Reads | integer | |
295
-| StdDev Physical Reads | float | |
296
-| Avg CLR Time | duration | |
297
-| Last CLR Time | duration | |
298
-| Min CLR Time | duration | |
299
-| Max CLR Time | duration | |
300
-| StdDev CLR Time | duration | |
301
-| Avg DOP | float | |
302
-| Last DOP | integer | |
303
-| Min DOP | integer | |
304
-| Max DOP | integer | |
305
-| StdDev DOP | float | |
306
-| Avg Memory (8KB pages) | float | |
307
-| Last Memory (8KB pages) | integer | |
308
-| Min Memory (8KB pages) | integer | |
309
-| Max Memory (8KB pages) | integer | |
310
-| StdDev Memory | float | |
311
-| Avg Rows | float | |
312
-| Last Rows | integer | |
313
-| Min Rows | integer | |
314
-| Max Rows | integer | |
315
-| StdDev Rows | float | |
316
-| Avg Log Bytes | float | |
317
-| Last Log Bytes | integer | |
318
-| Min Log Bytes | integer | |
319
-| Max Log Bytes | integer | |
320
-| StdDev Log Bytes | float | |
321
-| Avg TempDB (8KB pages) | float | |
322
-| Last TempDB (8KB pages) | integer | |
323
-| Min TempDB (8KB pages) | integer | |
324
-| Max TempDB (8KB pages) | integer | |
325
-| StdDev TempDB | float | |
274
+| Column | Type | Unit | Visibility | Description |
275
+|:-------|:-----|:-----|:-----------|:------------|
276
+| Query Hash | string | | hidden | |
277
+| Query | string | | | |
278
+| Database | string | | | |
279
+| Calls | integer | | | |
280
+| Total Time | duration | milliseconds | | |
281
+| Avg Time | duration | milliseconds | | |
282
+| Last Time | duration | milliseconds | hidden | |
283
+| Min Time | duration | milliseconds | hidden | |
284
+| Max Time | duration | milliseconds | hidden | |
285
+| StdDev Time | duration | milliseconds | hidden | |
286
+| Avg CPU | duration | milliseconds | | |
287
+| Last CPU | duration | milliseconds | hidden | |
288
+| Min CPU | duration | milliseconds | hidden | |
289
+| Max CPU | duration | milliseconds | hidden | |
290
+| StdDev CPU | duration | milliseconds | hidden | |
291
+| Avg Logical Reads | float | | | |
292
+| Last Logical Reads | integer | | hidden | |
293
+| Min Logical Reads | integer | | hidden | |
294
+| Max Logical Reads | integer | | hidden | |
295
+| StdDev Logical Reads | float | | hidden | |
296
+| Avg Logical Writes | float | | | |
297
+| Last Logical Writes | integer | | hidden | |
298
+| Min Logical Writes | integer | | hidden | |
299
+| Max Logical Writes | integer | | hidden | |
300
+| StdDev Logical Writes | float | | hidden | |
301
+| Avg Physical Reads | float | | | |
302
+| Last Physical Reads | integer | | hidden | |
303
+| Min Physical Reads | integer | | hidden | |
304
+| Max Physical Reads | integer | | hidden | |
305
+| StdDev Physical Reads | float | | hidden | |
306
+| Avg CLR Time | duration | milliseconds | hidden | |
307
+| Last CLR Time | duration | milliseconds | hidden | |
308
+| Min CLR Time | duration | milliseconds | hidden | |
309
+| Max CLR Time | duration | milliseconds | hidden | |
310
+| StdDev CLR Time | duration | milliseconds | hidden | |
311
+| Avg DOP | float | | | |
312
+| Last DOP | integer | | hidden | |
313
+| Min DOP | integer | | hidden | |
314
+| Max DOP | integer | | hidden | |
315
+| StdDev DOP | float | | hidden | |
316
+| Avg Memory (8KB pages) | float | | | |
317
+| Last Memory (8KB pages) | integer | | hidden | |
318
+| Min Memory (8KB pages) | integer | | hidden | |
319
+| Max Memory (8KB pages) | integer | | hidden | |
320
+| StdDev Memory | float | | hidden | |
321
+| Avg Rows | float | | | |
322
+| Last Rows | integer | | hidden | |
323
+| Min Rows | integer | | hidden | |
324
+| Max Rows | integer | | hidden | |
325
+| StdDev Rows | float | | hidden | |
326
+| Avg Log Bytes | float | | | |
327
+| Last Log Bytes | integer | | hidden | |
328
+| Min Log Bytes | integer | | hidden | |
329
+| Max Log Bytes | integer | | hidden | |
330
+| StdDev Log Bytes | float | | hidden | |
331
+| Avg TempDB (8KB pages) | float | | | |
332
+| Last TempDB (8KB pages) | integer | | hidden | |
333
+| Min TempDB (8KB pages) | integer | | hidden | |
334
+| Max TempDB (8KB pages) | integer | | hidden | |
335
+| StdDev TempDB | float | | hidden | |
336
337
338
src/go/plugin/go.d/collector/mysql/integrations/mariadb.md
+64
-54
@@ -190,16 +190,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
190
191
### Top Queries
192
193
+Top SQL queries from performance_schema.
194
+
195
+Reads performance_schema statement digest tables and returns the top entries sorted by the selected column.
196
+
197
+
198
| Aspect | Description |
199
|:-------|:------------|
200
| Name | `Mysql:top-queries` |
196
-| Summary | Top SQL queries from performance_schema. |
197
-| Behavior | Reads performance_schema statement digest tables and returns the top entries sorted by the selected column. |
201
| Performance | Requires performance_schema and can be expensive on busy servers. |
202
| Security | Query text may contain unmasked literals (potential PII). |
200
-| Requirements | Requires performance_schema enabled and access to events_statements_summary_by_digest. |
203
| Availability | Available when performance_schema tables are accessible and the collector is initialized. |
204
205
+#### Prerequisites
206
+
207
+##### Enable performance_schema digest tables
208
+
209
+Enable performance_schema and grant access to events_statements_summary_by_digest.
210
+
211
+
212
+
213
#### Parameters
214
215
| Parameter | Type | Description | Required | Default | Options |
@@ -210,46 +220,46 @@ This collector exposes real-time functions for interactive troubleshooting in th
220
221
Aggregated statement statistics from performance_schema.
222
213
-| Column | Type | Description |
214
-|:-------|:-----|:------------|
215
-| Digest | string | |
216
-| Query | string | |
217
-| Schema | string | |
218
-| Calls | integer | |
219
-| Total Time | duration | |
220
-| Min Time | duration | |
221
-| Avg Time | duration | |
222
-| Max Time | duration | |
223
-| Lock Time | duration | |
224
-| Errors | integer | |
225
-| Warnings | integer | |
226
-| Rows Affected | integer | |
227
-| Rows Sent | integer | |
228
-| Rows Examined | integer | |
229
-| Temp Disk Tables | integer | |
230
-| Temp Tables | integer | |
231
-| Full Joins | integer | |
232
-| Full Range Joins | integer | |
233
-| Select Range | integer | |
234
-| Select Range Check | integer | |
235
-| Select Scan | integer | |
236
-| Sort Merge Passes | integer | |
237
-| Sort Range | integer | |
238
-| Sort Rows | integer | |
239
-| Sort Scan | integer | |
240
-| No Index Used | integer | |
241
-| No Good Index Used | integer | |
242
-| First Seen | string | |
243
-| Last Seen | string | |
244
-| P95 Time | duration | |
245
-| P99 Time | duration | |
246
-| P99.9 Time | duration | |
247
-| Sample Query | string | |
248
-| Sample Seen | string | |
249
-| Sample Time | duration | |
250
-| CPU Time | duration | |
251
-| Max Controlled Memory | integer | |
252
-| Max Total Memory | integer | |
223
+| Column | Type | Unit | Visibility | Description |
224
+|:-------|:-----|:-----|:-----------|:------------|
225
+| Digest | string | | hidden | |
226
+| Query | string | | | |
227
+| Schema | string | | | |
228
+| Calls | integer | | | |
229
+| Total Time | duration | milliseconds | | |
230
+| Min Time | duration | milliseconds | hidden | |
231
+| Avg Time | duration | milliseconds | | |
232
+| Max Time | duration | milliseconds | hidden | |
233
+| Lock Time | duration | milliseconds | | |
234
+| Errors | integer | | | |
235
+| Warnings | integer | | | |
236
+| Rows Affected | integer | | | |
237
+| Rows Sent | integer | | | |
238
+| Rows Examined | integer | | | |
239
+| Temp Disk Tables | integer | | | |
240
+| Temp Tables | integer | | | |
241
+| Full Joins | integer | | | |
242
+| Full Range Joins | integer | | hidden | |
243
+| Select Range | integer | | hidden | |
244
+| Select Range Check | integer | | hidden | |
245
+| Select Scan | integer | | | |
246
+| Sort Merge Passes | integer | | hidden | |
247
+| Sort Range | integer | | hidden | |
248
+| Sort Rows | integer | | | |
249
+| Sort Scan | integer | | hidden | |
250
+| No Index Used | integer | | | |
251
+| No Good Index Used | integer | | hidden | |
252
+| First Seen | string | | hidden | |
253
+| Last Seen | string | | hidden | |
254
+| P95 Time | duration | milliseconds | | |
255
+| P99 Time | duration | milliseconds | | |
256
+| P99.9 Time | duration | milliseconds | hidden | |
257
+| Sample Query | string | | hidden | |
258
+| Sample Seen | string | | hidden | |
259
+| Sample Time | duration | milliseconds | hidden | |
260
+| CPU Time | duration | milliseconds | | |
261
+| Max Controlled Memory | integer | | | |
262
+| Max Total Memory | integer | | | |
263
264
265
@@ -305,21 +315,21 @@ To create the `netdata` user with these permissions, execute the following in th
315
316
- **MySQL and MariaDB < 10.5.9**
317
308
- ```mysql
309
- CREATE USER 'netdata'@'localhost';
310
- GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
311
- FLUSH PRIVILEGES;
312
- ```
318
+ ```mysql
319
+ CREATE USER 'netdata'@'localhost';
320
+ GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
321
+ FLUSH PRIVILEGES;
322
+ ```
323
324
- **MariaDB >= 10.5.9**
325
316
- For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
326
+ For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
327
318
- ```mysql
319
- CREATE USER 'netdata'@'localhost';
320
- GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
321
- FLUSH PRIVILEGES;
322
- ```
328
+ ```mysql
329
+ CREATE USER 'netdata'@'localhost';
330
+ GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
331
+ FLUSH PRIVILEGES;
332
+ ```
333
334
The `netdata` user will have the ability to connect to the MySQL server on localhost without a password.
335
It will only be able to gather statistics without being able to alter or affect operations in any way.
src/go/plugin/go.d/collector/mysql/integrations/mysql.md
+64
-54
@@ -190,16 +190,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
190
191
### Top Queries
192
193
+Top SQL queries from performance_schema.
194
+
195
+Reads performance_schema statement digest tables and returns the top entries sorted by the selected column.
196
+
197
+
198
| Aspect | Description |
199
|:-------|:------------|
200
| Name | `Mysql:top-queries` |
196
-| Summary | Top SQL queries from performance_schema. |
197
-| Behavior | Reads performance_schema statement digest tables and returns the top entries sorted by the selected column. |
201
| Performance | Requires performance_schema and can be expensive on busy servers. |
202
| Security | Query text may contain unmasked literals (potential PII). |
200
-| Requirements | Requires performance_schema enabled and access to events_statements_summary_by_digest. |
203
| Availability | Available when performance_schema tables are accessible and the collector is initialized. |
204
205
+#### Prerequisites
206
+
207
+##### Enable performance_schema digest tables
208
+
209
+Enable performance_schema and grant access to events_statements_summary_by_digest.
210
+
211
+
212
+
213
#### Parameters
214
215
| Parameter | Type | Description | Required | Default | Options |
@@ -210,46 +220,46 @@ This collector exposes real-time functions for interactive troubleshooting in th
220
221
Aggregated statement statistics from performance_schema.
222
213
-| Column | Type | Description |
214
-|:-------|:-----|:------------|
215
-| Digest | string | |
216
-| Query | string | |
217
-| Schema | string | |
218
-| Calls | integer | |
219
-| Total Time | duration | |
220
-| Min Time | duration | |
221
-| Avg Time | duration | |
222
-| Max Time | duration | |
223
-| Lock Time | duration | |
224
-| Errors | integer | |
225
-| Warnings | integer | |
226
-| Rows Affected | integer | |
227
-| Rows Sent | integer | |
228
-| Rows Examined | integer | |
229
-| Temp Disk Tables | integer | |
230
-| Temp Tables | integer | |
231
-| Full Joins | integer | |
232
-| Full Range Joins | integer | |
233
-| Select Range | integer | |
234
-| Select Range Check | integer | |
235
-| Select Scan | integer | |
236
-| Sort Merge Passes | integer | |
237
-| Sort Range | integer | |
238
-| Sort Rows | integer | |
239
-| Sort Scan | integer | |
240
-| No Index Used | integer | |
241
-| No Good Index Used | integer | |
242
-| First Seen | string | |
243
-| Last Seen | string | |
244
-| P95 Time | duration | |
245
-| P99 Time | duration | |
246
-| P99.9 Time | duration | |
247
-| Sample Query | string | |
248
-| Sample Seen | string | |
249
-| Sample Time | duration | |
250
-| CPU Time | duration | |
251
-| Max Controlled Memory | integer | |
252
-| Max Total Memory | integer | |
223
+| Column | Type | Unit | Visibility | Description |
224
+|:-------|:-----|:-----|:-----------|:------------|
225
+| Digest | string | | hidden | |
226
+| Query | string | | | |
227
+| Schema | string | | | |
228
+| Calls | integer | | | |
229
+| Total Time | duration | milliseconds | | |
230
+| Min Time | duration | milliseconds | hidden | |
231
+| Avg Time | duration | milliseconds | | |
232
+| Max Time | duration | milliseconds | hidden | |
233
+| Lock Time | duration | milliseconds | | |
234
+| Errors | integer | | | |
235
+| Warnings | integer | | | |
236
+| Rows Affected | integer | | | |
237
+| Rows Sent | integer | | | |
238
+| Rows Examined | integer | | | |
239
+| Temp Disk Tables | integer | | | |
240
+| Temp Tables | integer | | | |
241
+| Full Joins | integer | | | |
242
+| Full Range Joins | integer | | hidden | |
243
+| Select Range | integer | | hidden | |
244
+| Select Range Check | integer | | hidden | |
245
+| Select Scan | integer | | | |
246
+| Sort Merge Passes | integer | | hidden | |
247
+| Sort Range | integer | | hidden | |
248
+| Sort Rows | integer | | | |
249
+| Sort Scan | integer | | hidden | |
250
+| No Index Used | integer | | | |
251
+| No Good Index Used | integer | | hidden | |
252
+| First Seen | string | | hidden | |
253
+| Last Seen | string | | hidden | |
254
+| P95 Time | duration | milliseconds | | |
255
+| P99 Time | duration | milliseconds | | |
256
+| P99.9 Time | duration | milliseconds | hidden | |
257
+| Sample Query | string | | hidden | |
258
+| Sample Seen | string | | hidden | |
259
+| Sample Time | duration | milliseconds | hidden | |
260
+| CPU Time | duration | milliseconds | | |
261
+| Max Controlled Memory | integer | | | |
262
+| Max Total Memory | integer | | | |
263
264
265
@@ -305,21 +315,21 @@ To create the `netdata` user with these permissions, execute the following in th
315
316
- **MySQL and MariaDB < 10.5.9**
317
308
- ```mysql
309
- CREATE USER 'netdata'@'localhost';
310
- GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
311
- FLUSH PRIVILEGES;
312
- ```
318
+ ```mysql
319
+ CREATE USER 'netdata'@'localhost';
320
+ GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
321
+ FLUSH PRIVILEGES;
322
+ ```
323
324
- **MariaDB >= 10.5.9**
325
316
- For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
326
+ For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
327
318
- ```mysql
319
- CREATE USER 'netdata'@'localhost';
320
- GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
321
- FLUSH PRIVILEGES;
322
- ```
328
+ ```mysql
329
+ CREATE USER 'netdata'@'localhost';
330
+ GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
331
+ FLUSH PRIVILEGES;
332
+ ```
333
334
The `netdata` user will have the ability to connect to the MySQL server on localhost without a password.
335
It will only be able to gather statistics without being able to alter or affect operations in any way.
src/go/plugin/go.d/collector/mysql/integrations/percona_mysql.md
+64
-54
@@ -190,16 +190,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
190
191
### Top Queries
192
193
+Top SQL queries from performance_schema.
194
+
195
+Reads performance_schema statement digest tables and returns the top entries sorted by the selected column.
196
+
197
+
198
| Aspect | Description |
199
|:-------|:------------|
200
| Name | `Mysql:top-queries` |
196
-| Summary | Top SQL queries from performance_schema. |
197
-| Behavior | Reads performance_schema statement digest tables and returns the top entries sorted by the selected column. |
201
| Performance | Requires performance_schema and can be expensive on busy servers. |
202
| Security | Query text may contain unmasked literals (potential PII). |
200
-| Requirements | Requires performance_schema enabled and access to events_statements_summary_by_digest. |
203
| Availability | Available when performance_schema tables are accessible and the collector is initialized. |
204
205
+#### Prerequisites
206
+
207
+##### Enable performance_schema digest tables
208
+
209
+Enable performance_schema and grant access to events_statements_summary_by_digest.
210
+
211
+
212
+
213
#### Parameters
214
215
| Parameter | Type | Description | Required | Default | Options |
@@ -210,46 +220,46 @@ This collector exposes real-time functions for interactive troubleshooting in th
220
221
Aggregated statement statistics from performance_schema.
222
213
-| Column | Type | Description |
214
-|:-------|:-----|:------------|
215
-| Digest | string | |
216
-| Query | string | |
217
-| Schema | string | |
218
-| Calls | integer | |
219
-| Total Time | duration | |
220
-| Min Time | duration | |
221
-| Avg Time | duration | |
222
-| Max Time | duration | |
223
-| Lock Time | duration | |
224
-| Errors | integer | |
225
-| Warnings | integer | |
226
-| Rows Affected | integer | |
227
-| Rows Sent | integer | |
228
-| Rows Examined | integer | |
229
-| Temp Disk Tables | integer | |
230
-| Temp Tables | integer | |
231
-| Full Joins | integer | |
232
-| Full Range Joins | integer | |
233
-| Select Range | integer | |
234
-| Select Range Check | integer | |
235
-| Select Scan | integer | |
236
-| Sort Merge Passes | integer | |
237
-| Sort Range | integer | |
238
-| Sort Rows | integer | |
239
-| Sort Scan | integer | |
240
-| No Index Used | integer | |
241
-| No Good Index Used | integer | |
242
-| First Seen | string | |
243
-| Last Seen | string | |
244
-| P95 Time | duration | |
245
-| P99 Time | duration | |
246
-| P99.9 Time | duration | |
247
-| Sample Query | string | |
248
-| Sample Seen | string | |
249
-| Sample Time | duration | |
250
-| CPU Time | duration | |
251
-| Max Controlled Memory | integer | |
252
-| Max Total Memory | integer | |
223
+| Column | Type | Unit | Visibility | Description |
224
+|:-------|:-----|:-----|:-----------|:------------|
225
+| Digest | string | | hidden | |
226
+| Query | string | | | |
227
+| Schema | string | | | |
228
+| Calls | integer | | | |
229
+| Total Time | duration | milliseconds | | |
230
+| Min Time | duration | milliseconds | hidden | |
231
+| Avg Time | duration | milliseconds | | |
232
+| Max Time | duration | milliseconds | hidden | |
233
+| Lock Time | duration | milliseconds | | |
234
+| Errors | integer | | | |
235
+| Warnings | integer | | | |
236
+| Rows Affected | integer | | | |
237
+| Rows Sent | integer | | | |
238
+| Rows Examined | integer | | | |
239
+| Temp Disk Tables | integer | | | |
240
+| Temp Tables | integer | | | |
241
+| Full Joins | integer | | | |
242
+| Full Range Joins | integer | | hidden | |
243
+| Select Range | integer | | hidden | |
244
+| Select Range Check | integer | | hidden | |
245
+| Select Scan | integer | | | |
246
+| Sort Merge Passes | integer | | hidden | |
247
+| Sort Range | integer | | hidden | |
248
+| Sort Rows | integer | | | |
249
+| Sort Scan | integer | | hidden | |
250
+| No Index Used | integer | | | |
251
+| No Good Index Used | integer | | hidden | |
252
+| First Seen | string | | hidden | |
253
+| Last Seen | string | | hidden | |
254
+| P95 Time | duration | milliseconds | | |
255
+| P99 Time | duration | milliseconds | | |
256
+| P99.9 Time | duration | milliseconds | hidden | |
257
+| Sample Query | string | | hidden | |
258
+| Sample Seen | string | | hidden | |
259
+| Sample Time | duration | milliseconds | hidden | |
260
+| CPU Time | duration | milliseconds | | |
261
+| Max Controlled Memory | integer | | | |
262
+| Max Total Memory | integer | | | |
263
264
265
@@ -305,21 +315,21 @@ To create the `netdata` user with these permissions, execute the following in th
315
316
- **MySQL and MariaDB < 10.5.9**
317
308
- ```mysql
309
- CREATE USER 'netdata'@'localhost';
310
- GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
311
- FLUSH PRIVILEGES;
312
- ```
318
+ ```mysql
319
+ CREATE USER 'netdata'@'localhost';
320
+ GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
321
+ FLUSH PRIVILEGES;
322
+ ```
323
324
- **MariaDB >= 10.5.9**
325
316
- For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
326
+ For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
327
318
- ```mysql
319
- CREATE USER 'netdata'@'localhost';
320
- GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
321
- FLUSH PRIVILEGES;
322
- ```
328
+ ```mysql
329
+ CREATE USER 'netdata'@'localhost';
330
+ GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
331
+ FLUSH PRIVILEGES;
332
+ ```
333
334
The `netdata` user will have the ability to connect to the MySQL server on localhost without a password.
335
It will only be able to gather statistics without being able to alter or affect operations in any way.
src/go/plugin/go.d/collector/oracledb/integrations/oracle_db.md
+56
-36
@@ -143,16 +143,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
143
144
### Top Queries
145
146
+Top SQL statements from V$SQLSTATS. WARNING: Query text may contain unmasked literals (potential PII).
147
+
148
+Queries V$SQLSTATS and returns the top entries sorted by the selected column.
149
+
150
+
151
| Aspect | Description |
152
|:-------|:------------|
153
| Name | `Oracledb:top-queries` |
149
-| Summary | Top SQL statements from V$SQLSTATS. WARNING: Query text may contain unmasked literals (potential PII). |
150
-| Behavior | Queries V$SQLSTATS and returns the top entries sorted by the selected column. |
154
| Performance | Queries system views and may be expensive on busy databases. |
155
| Security | Query text may contain unmasked literals (potential PII). |
153
-| Requirements | Requires access to V$SQLSTATS and a working SQL connection. |
156
| Availability | Available when the collector can query Oracle system views; returns errors if SQL is unavailable. |
157
158
+#### Prerequisites
159
+
160
+##### Grant access to V$SQLSTATS
161
+
162
+Use a SQL user with access to V$SQLSTATS and a working SQL connection.
163
+
164
+
165
+
166
#### Parameters
167
168
| Parameter | Type | Description | Required | Default | Options |
@@ -163,35 +173,45 @@ This collector exposes real-time functions for interactive troubleshooting in th
173
174
Aggregated SQL statistics from V$SQLSTATS.
175
166
-| Column | Type | Description |
167
-|:-------|:-----|:------------|
168
-| SQL ID | string | |
169
-| Query | string | |
170
-| Schema | string | |
171
-| Executions | integer | |
172
-| Total Time | duration | |
173
-| Avg Time | duration | |
174
-| CPU Time | duration | |
175
-| Buffer Gets | integer | |
176
-| Disk Reads | integer | |
177
-| Rows Processed | integer | |
178
-| Parse Calls | integer | |
179
-| Module | string | |
180
-| Action | string | |
181
-| Last Active | string | |
176
+| Column | Type | Unit | Visibility | Description |
177
+|:-------|:-----|:-----|:-----------|:------------|
178
+| SQL ID | string | | hidden | |
179
+| Query | string | | | |
180
+| Schema | string | | | |
181
+| Executions | integer | | | |
182
+| Total Time | duration | milliseconds | | |
183
+| Avg Time | duration | milliseconds | | |
184
+| CPU Time | duration | milliseconds | | |
185
+| Buffer Gets | integer | | | |
186
+| Disk Reads | integer | | | |
187
+| Rows Processed | integer | | | |
188
+| Parse Calls | integer | | hidden | |
189
+| Module | string | | hidden | |
190
+| Action | string | | hidden | |
191
+| Last Active | string | | hidden | |
192
193
### Running Queries
194
195
+Currently running SQL statements from V$SESSION. WARNING: Query text may contain unmasked literals (potential PII).
196
+
197
+Queries V$SESSION and returns running statements sorted by the selected column.
198
+
199
+
200
| Aspect | Description |
201
|:-------|:------------|
202
| Name | `Oracledb:running-queries` |
188
-| Summary | Currently running SQL statements from V$SESSION. WARNING: Query text may contain unmasked literals (potential PII). |
189
-| Behavior | Queries V$SESSION and returns running statements sorted by the selected column. |
203
| Performance | Queries system views and may be expensive on busy databases. |
204
| Security | Query text may contain unmasked literals (potential PII). |
192
-| Requirements | Requires access to V$SESSION and a working SQL connection. |
205
| Availability | Available when the collector can query Oracle system views; returns errors if SQL is unavailable. |
206
207
+#### Prerequisites
208
+
209
+##### Grant access to V$SESSION
210
+
211
+Use a SQL user with access to V$SESSION and a working SQL connection.
212
+
213
+
214
+
215
#### Parameters
216
217
| Parameter | Type | Description | Required | Default | Options |
@@ -202,20 +222,20 @@ Aggregated SQL statistics from V$SQLSTATS.
222
223
Snapshot of currently running SQL sessions.
224
205
-| Column | Type | Description |
206
-|:-------|:-----|:------------|
207
-| Session | string | |
208
-| User | string | |
209
-| Status | string | |
210
-| Type | string | |
211
-| SQL ID | string | |
212
-| Query | string | |
213
-| Elapsed | duration | |
214
-| SQL Exec Start | string | |
215
-| Module | string | |
216
-| Action | string | |
217
-| Program | string | |
218
-| Machine | string | |
225
+| Column | Type | Unit | Visibility | Description |
226
+|:-------|:-----|:-----|:-----------|:------------|
227
+| Session | string | | | |
228
+| User | string | | | |
229
+| Status | string | | | |
230
+| Type | string | | hidden | |
231
+| SQL ID | string | | hidden | |
232
+| Query | string | | | |
233
+| Elapsed | duration | milliseconds | | |
234
+| SQL Exec Start | string | | hidden | |
235
+| Module | string | | hidden | |
236
+| Action | string | | hidden | |
237
+| Program | string | | hidden | |
238
+| Machine | string | | hidden | |
239
240
241
src/go/plugin/go.d/collector/postgres/integrations/postgresql.md
+57
-47
@@ -234,16 +234,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
234
235
### Top Queries
236
237
+Top SQL queries from pg_stat_statements.
238
+
239
+Reads pg_stat_statements and returns the top entries sorted by the selected column.
240
+
241
+
242
| Aspect | Description |
243
|:-------|:------------|
244
| Name | `Postgres:top-queries` |
240
-| Summary | Top SQL queries from pg_stat_statements. |
241
-| Behavior | Reads pg_stat_statements and returns the top entries sorted by the selected column. |
245
| Performance | Requires pg_stat_statements and can be expensive on busy servers. |
246
| Security | Query text may contain unmasked literals (potential PII). |
244
-| Requirements | Requires the pg_stat_statements extension installed and enabled. |
247
| Availability | Available when pg_stat_statements is available and the collector is initialized. |
248
249
+#### Prerequisites
250
+
251
+##### Enable pg_stat_statements
252
+
253
+Install and enable the pg_stat_statements extension.
254
+
255
+
256
+
257
#### Parameters
258
259
| Parameter | Type | Description | Required | Default | Options |
@@ -254,50 +264,50 @@ This collector exposes real-time functions for interactive troubleshooting in th
264
265
Aggregated query statistics from pg_stat_statements.
266
257
-| Column | Type | Description |
258
-|:-------|:-----|:------------|
259
-| Query ID | string | |
260
-| Query | string | |
261
-| Database | string | |
262
-| User | string | |
263
-| Calls | integer | |
264
-| Total Time | duration | |
265
-| Mean Time | duration | |
266
-| Min Time | duration | |
267
-| Max Time | duration | |
268
-| Stddev Time | duration | |
269
-| Plans | integer | |
270
-| Total Plan Time | duration | |
271
-| Mean Plan Time | duration | |
272
-| Min Plan Time | duration | |
273
-| Max Plan Time | duration | |
274
-| Stddev Plan Time | duration | |
275
-| Rows | integer | |
276
-| Shared Blocks Hit | integer | |
277
-| Shared Blocks Read | integer | |
278
-| Shared Blocks Dirtied | integer | |
279
-| Shared Blocks Written | integer | |
280
-| Local Blocks Hit | integer | |
281
-| Local Blocks Read | integer | |
282
-| Local Blocks Dirtied | integer | |
283
-| Local Blocks Written | integer | |
284
-| Temp Blocks Read | integer | |
285
-| Temp Blocks Written | integer | |
286
-| Block Read Time | duration | |
287
-| Block Write Time | duration | |
288
-| WAL Records | integer | |
289
-| WAL Full Page Images | integer | |
290
-| WAL Bytes | integer | |
291
-| JIT Functions | integer | |
292
-| JIT Generation Time | duration | |
293
-| JIT Inlining Count | integer | |
294
-| JIT Inlining Time | duration | |
295
-| JIT Optimization Count | integer | |
296
-| JIT Optimization Time | duration | |
297
-| JIT Emission Count | integer | |
298
-| JIT Emission Time | duration | |
299
-| Temp Block Read Time | duration | |
300
-| Temp Block Write Time | duration | |
267
+| Column | Type | Unit | Visibility | Description |
268
+|:-------|:-----|:-----|:-----------|:------------|
269
+| Query ID | string | | hidden | |
270
+| Query | string | | | |
271
+| Database | string | | | |
272
+| User | string | | | |
273
+| Calls | integer | | | |
274
+| Total Time | duration | milliseconds | | |
275
+| Mean Time | duration | milliseconds | | |
276
+| Min Time | duration | milliseconds | hidden | |
277
+| Max Time | duration | milliseconds | hidden | |
278
+| Stddev Time | duration | milliseconds | hidden | |
279
+| Plans | integer | | hidden | |
280
+| Total Plan Time | duration | milliseconds | hidden | |
281
+| Mean Plan Time | duration | milliseconds | hidden | |
282
+| Min Plan Time | duration | milliseconds | hidden | |
283
+| Max Plan Time | duration | milliseconds | hidden | |
284
+| Stddev Plan Time | duration | milliseconds | hidden | |
285
+| Rows | integer | | | |
286
+| Shared Blocks Hit | integer | | | |
287
+| Shared Blocks Read | integer | | | |
288
+| Shared Blocks Dirtied | integer | | hidden | |
289
+| Shared Blocks Written | integer | | hidden | |
290
+| Local Blocks Hit | integer | | hidden | |
291
+| Local Blocks Read | integer | | hidden | |
292
+| Local Blocks Dirtied | integer | | hidden | |
293
+| Local Blocks Written | integer | | hidden | |
294
+| Temp Blocks Read | integer | | | |
295
+| Temp Blocks Written | integer | | | |
296
+| Block Read Time | duration | milliseconds | | |
297
+| Block Write Time | duration | milliseconds | | |
298
+| WAL Records | integer | | hidden | |
299
+| WAL Full Page Images | integer | | hidden | |
300
+| WAL Bytes | integer | | hidden | |
301
+| JIT Functions | integer | | hidden | |
302
+| JIT Generation Time | duration | milliseconds | hidden | |
303
+| JIT Inlining Count | integer | | hidden | |
304
+| JIT Inlining Time | duration | milliseconds | hidden | |
305
+| JIT Optimization Count | integer | | hidden | |
306
+| JIT Optimization Time | duration | milliseconds | hidden | |
307
+| JIT Emission Count | integer | | hidden | |
308
+| JIT Emission Time | duration | milliseconds | hidden | |
309
+| Temp Block Read Time | duration | milliseconds | hidden | |
310
+| Temp Block Write Time | duration | milliseconds | hidden | |
311
312
313
src/go/plugin/go.d/collector/proxysql/integrations/proxysql.md
+31
-21
@@ -176,16 +176,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
176
177
### Top Queries
178
179
+Top SQL queries from ProxySQL query digest stats.
180
+
181
+Queries stats_mysql_query_digest and returns the top entries sorted by the selected column.
182
+
183
+
184
| Aspect | Description |
185
|:-------|:------------|
186
| Name | `Proxysql:top-queries` |
182
-| Summary | Top SQL queries from ProxySQL query digest stats. |
183
-| Behavior | Queries stats_mysql_query_digest and returns the top entries sorted by the selected column. |
187
| Performance | Uses ProxySQL stats tables and can be expensive on busy systems. |
188
| Security | Query text may contain unmasked literals (potential PII). |
186
-| Requirements | Requires access to stats_mysql_query_digest in ProxySQL. |
189
| Availability | Available when the collector can query ProxySQL stats; returns errors if the SQL connection is unavailable. |
190
191
+#### Prerequisites
192
+
193
+##### Grant access to stats_mysql_query_digest
194
+
195
+Ensure the ProxySQL user can read stats_mysql_query_digest.
196
+
197
+
198
+
199
#### Parameters
200
201
| Parameter | Type | Description | Required | Default | Options |
@@ -196,24 +206,24 @@ This collector exposes real-time functions for interactive troubleshooting in th
206
207
Query digest statistics from ProxySQL.
208
199
-| Column | Type | Description |
200
-|:-------|:-----|:------------|
201
-| Digest | string | |
202
-| Query | string | |
203
-| Schema | string | |
204
-| User | string | |
205
-| Hostgroup | integer | |
206
-| Calls | integer | |
207
-| Total Time | duration | |
208
-| Avg Time | duration | |
209
-| Min Time | duration | |
210
-| Max Time | duration | |
211
-| Rows Affected | integer | |
212
-| Rows Sent | integer | |
213
-| Errors | integer | |
214
-| Warnings | integer | |
215
-| First Seen | string | |
216
-| Last Seen | string | |
209
+| Column | Type | Unit | Visibility | Description |
210
+|:-------|:-----|:-----|:-----------|:------------|
211
+| Digest | string | | hidden | |
212
+| Query | string | | | |
213
+| Schema | string | | | |
214
+| User | string | | hidden | |
215
+| Hostgroup | integer | | hidden | |
216
+| Calls | integer | | | |
217
+| Total Time | duration | milliseconds | | |
218
+| Avg Time | duration | milliseconds | | |
219
+| Min Time | duration | milliseconds | hidden | |
220
+| Max Time | duration | milliseconds | hidden | |
221
+| Rows Affected | integer | | | |
222
+| Rows Sent | integer | | | |
223
+| Errors | integer | | | |
224
+| Warnings | integer | | | |
225
+| First Seen | string | | hidden | |
226
+| Last Seen | string | | hidden | |
227
228
229
src/go/plugin/go.d/collector/redis/integrations/redis.md
+18
-12
@@ -109,16 +109,22 @@ This collector exposes real-time functions for interactive troubleshooting in th
109
110
### Top Queries
111
112
+Slow commands from Redis SLOWLOG. WARNING: Command arguments may contain unmasked literals (potential PII).
113
+
114
+Reads Redis SLOWLOG and returns the top entries sorted by the selected column.
115
+
116
+
117
| Aspect | Description |
118
|:-------|:------------|
119
| Name | `Redis:top-queries` |
115
-| Summary | Slow commands from Redis SLOWLOG. WARNING: Command arguments may contain unmasked literals (potential PII). |
116
-| Behavior | Reads Redis SLOWLOG and returns the top entries sorted by the selected column. |
120
| Performance | Uses SLOWLOG GET and may return many entries; use top_queries_limit to control size. |
121
| Security | Command arguments may contain unmasked literals (potential PII). |
119
-| Requirements | Requires access to the Redis SLOWLOG and a working connection. |
122
| Availability | Available when the collector is initialized; returns 503 if the collector is still connecting. |
123
124
+#### Prerequisites
125
+
126
+No additional configuration is required.
127
+
128
#### Parameters
129
130
| Parameter | Type | Description | Required | Default | Options |
@@ -129,15 +135,15 @@ This collector exposes real-time functions for interactive troubleshooting in th
135
136
Slowlog entries with command timing and metadata.
137
132
-| Column | Type | Description |
133
-|:-------|:-----|:------------|
134
-| ID | integer | |
135
-| Timestamp | timestamp | |
136
-| Command | string | |
137
-| Command Name | string | |
138
-| Duration | duration | |
139
-| Client Address | string | |
140
-| Client Name | string | |
138
+| Column | Type | Unit | Visibility | Description |
139
+|:-------|:-----|:-----|:-----------|:------------|
140
+| ID | integer | | hidden | |
141
+| Timestamp | timestamp | | | |
142
+| Command | string | | | |
143
+| Command Name | string | | | |
144
+| Duration | duration | milliseconds | | |
145
+| Client Address | string | | hidden | |
146
+| Client Name | string | | hidden | |
147
148
149
src/go/plugin/go.d/collector/rethinkdb/integrations/rethinkdb.md
+23
-13
@@ -104,16 +104,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
104
105
### Running Queries
106
107
+Currently running queries from rethinkdb.jobs. WARNING: Query text may contain unmasked literals (potential PII).
108
+
109
+Queries rethinkdb.jobs and returns running queries sorted by the selected column.
110
+
111
+
112
| Aspect | Description |
113
|:-------|:------------|
114
| Name | `Rethinkdb:running-queries` |
110
-| Summary | Currently running queries from rethinkdb.jobs. WARNING: Query text may contain unmasked literals (potential PII). |
111
-| Behavior | Queries rethinkdb.jobs and returns running queries sorted by the selected column. |
115
| Performance | Uses system tables and may be expensive on busy clusters. |
116
| Security | Query text may contain unmasked literals (potential PII). |
114
-| Requirements | Requires admin access to rethinkdb.jobs and a working connection. |
117
| Availability | Available when the collector is initialized; returns 503 if the collector is still connecting. |
118
119
+#### Prerequisites
120
+
121
+##### Grant admin access to rethinkdb.jobs
122
+
123
+Use an admin user with access to rethinkdb.jobs and ensure the connection is working.
124
+
125
+
126
+
127
#### Parameters
128
129
| Parameter | Type | Description | Required | Default | Options |
@@ -124,16 +134,16 @@ This collector exposes real-time functions for interactive troubleshooting in th
134
135
Snapshot of running queries from rethinkdb.jobs.
136
127
-| Column | Type | Description |
128
-|:-------|:-----|:------------|
129
-| Job ID | string | |
130
-| Query | string | |
131
-| Duration | duration | |
132
-| Type | string | |
133
-| User | string | |
134
-| Client Address | string | |
135
-| Client Port | integer | |
136
-| Servers | string | |
137
+| Column | Type | Unit | Visibility | Description |
138
+|:-------|:-----|:-----|:-----------|:------------|
139
+| Job ID | string | | hidden | |
140
+| Query | string | | | |
141
+| Duration | duration | milliseconds | | |
142
+| Type | string | | | |
143
+| User | string | | | |
144
+| Client Address | string | | hidden | |
145
+| Client Port | integer | | hidden | |
146
+| Servers | string | | hidden | |
147
148
149
src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md
+34
-28
@@ -95,9 +95,9 @@ The configuration file name is [go.d/sd/snmp.conf](https://github.com/netdata/ne
95
You can edit the configuration file using the edit-config script from the Netdata [config directory](https://learn.netdata.cloud/docs/netdata-agent/configuration#the-netdata-config-directory).
96
97
```bash
98
- cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
99
- sudo ./edit-config go.d/sd/snmp.conf
100
- ```
98
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
99
+sudo ./edit-config go.d/sd/snmp.conf
100
+```
101
102
103
#### Limits
@@ -117,7 +117,7 @@ Metrics and charts are **defined by the matched SNMP profile(s)** at runtime. Th
117
118
:::tip
119
120
- To understand the structure of these profiles (metrics, tags, virtual metrics, etc.), see **[SNMP Profile Format](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/profile-format.md)**.
120
+To understand the structure of these profiles (metrics, tags, virtual metrics, etc.), see **[SNMP Profile Format](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/snmp/profile-format.md)**.
121
122
:::
123
@@ -132,16 +132,22 @@ This collector exposes real-time functions for interactive troubleshooting in th
132
133
### Network Interfaces
134
135
+Network interface traffic and status metrics.
136
+
137
+Uses the latest cached SNMP interface data, filters by the selected type group, and sorts by the default column.
138
+
139
+
140
| Aspect | Description |
141
|:-------|:------------|
142
| Name | `Snmp:interfaces` |
138
-| Summary | Network interface traffic and status metrics. |
139
-| Behavior | Uses the latest cached SNMP interface data, filters by the selected type group, and sorts by the default column. |
143
| Performance | Uses cached data only and does not trigger additional SNMP requests. Large devices may return many rows. |
144
| Security | Exposes interface names and counters only. |
142
-| Requirements | Requires successful SNMP collection so interface data is cached. |
145
| Availability | Available after the collector has completed at least one data collection; returns 503 until cache is ready. |
146
147
+#### Prerequisites
148
+
149
+No additional configuration is required.
150
+
151
#### Parameters
152
153
| Parameter | Type | Description | Required | Default | Options |
@@ -152,27 +158,27 @@ This collector exposes real-time functions for interactive troubleshooting in th
158
159
Table of interface traffic and status from cached SNMP data.
160
155
-| Column | Type | Description |
156
-|:-------|:-----|:------------|
157
-| Interface | string | |
158
-| Type | string | |
159
-| Type Group | string | |
160
-| Admin Status | string | |
161
-| Oper Status | string | |
162
-| Traffic In | float | |
163
-| Traffic Out | float | |
164
-| Unicast In | float | |
165
-| Unicast Out | float | |
166
-| Broadcast In | float | |
167
-| Broadcast Out | float | |
168
-| Packets In | float | |
169
-| Packets Out | float | |
170
-| Errors In | float | |
171
-| Errors Out | float | |
172
-| Discards In | float | |
173
-| Discards Out | float | |
174
-| Multicast In | float | |
175
-| Multicast Out | float | |
161
+| Column | Type | Unit | Visibility | Description |
162
+|:-------|:-----|:-----|:-----------|:------------|
163
+| Interface | string | | | |
164
+| Type | string | | | |
165
+| Type Group | string | | | |
166
+| Admin Status | string | | | |
167
+| Oper Status | string | | | |
168
+| Traffic In | float | Mbits | | |
169
+| Traffic Out | float | Mbits | | |
170
+| Unicast In | float | Kpps | hidden | |
171
+| Unicast Out | float | Kpps | hidden | |
172
+| Broadcast In | float | Kpps | hidden | |
173
+| Broadcast Out | float | Kpps | hidden | |
174
+| Packets In | float | Kpps | | |
175
+| Packets Out | float | Kpps | | |
176
+| Errors In | float | packets/s | hidden | |
177
+| Errors Out | float | packets/s | hidden | |
178
+| Discards In | float | packets/s | | |
179
+| Discards Out | float | packets/s | | |
180
+| Multicast In | float | Kpps | hidden | |
181
+| Multicast Out | float | Kpps | hidden | |
182
183
184
src/go/plugin/go.d/collector/yugabytedb/integrations/yugabytedb.md
+52
-32
@@ -340,16 +340,26 @@ This collector exposes real-time functions for interactive troubleshooting in th
340
341
### Top Queries
342
343
+Top SQL queries from pg_stat_statements. WARNING: Query text may contain unmasked literals (potential PII).
344
+
345
+Reads pg_stat_statements and returns the top entries sorted by the selected column.
346
+
347
+
348
| Aspect | Description |
349
|:-------|:------------|
350
| Name | `Yugabytedb:top-queries` |
346
-| Summary | Top SQL queries from pg_stat_statements. WARNING: Query text may contain unmasked literals (potential PII). |
347
-| Behavior | Reads pg_stat_statements and returns the top entries sorted by the selected column. |
351
| Performance | Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout. |
352
| Security | Query text may contain unmasked literals (potential PII). |
350
-| Requirements | Requires pg_stat_statements installed and a SQL DSN configured for YSQL. |
353
| Availability | Available when YSQL is accessible; returns errors if the SQL connection is unavailable. |
354
355
+#### Prerequisites
356
+
357
+##### Enable pg_stat_statements for YSQL
358
+
359
+Install and enable pg_stat_statements and configure a YSQL DSN.
360
+
361
+
362
+
363
#### Parameters
364
365
| Parameter | Type | Description | Required | Default | Options |
@@ -360,32 +370,42 @@ This collector exposes real-time functions for interactive troubleshooting in th
370
371
Aggregated query statistics from pg_stat_statements.
372
363
-| Column | Type | Description |
364
-|:-------|:-----|:------------|
365
-| Query ID | string | |
366
-| Query | string | |
367
-| Database | string | |
368
-| User | string | |
369
-| Calls | integer | |
370
-| Total Time | duration | |
371
-| Mean Time | duration | |
372
-| Min Time | duration | |
373
-| Max Time | duration | |
374
-| Rows | integer | |
375
-| Stddev Time | duration | |
373
+| Column | Type | Unit | Visibility | Description |
374
+|:-------|:-----|:-----|:-----------|:------------|
375
+| Query ID | string | | hidden | |
376
+| Query | string | | | |
377
+| Database | string | | | |
378
+| User | string | | | |
379
+| Calls | integer | | | |
380
+| Total Time | duration | milliseconds | | |
381
+| Mean Time | duration | milliseconds | | |
382
+| Min Time | duration | milliseconds | hidden | |
383
+| Max Time | duration | milliseconds | hidden | |
384
+| Rows | integer | | | |
385
+| Stddev Time | duration | milliseconds | hidden | |
386
387
### Running Queries
388
389
+Currently running SQL statements from pg_stat_activity. WARNING: Query text may contain unmasked literals (potential PII).
390
+
391
+Reads pg_stat_activity and returns running statements sorted by the selected column.
392
+
393
+
394
| Aspect | Description |
395
|:-------|:------------|
396
| Name | `Yugabytedb:running-queries` |
382
-| Summary | Currently running SQL statements from pg_stat_activity. WARNING: Query text may contain unmasked literals (potential PII). |
383
-| Behavior | Reads pg_stat_activity and returns running statements sorted by the selected column. |
397
| Performance | Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout. |
398
| Security | Query text may contain unmasked literals (potential PII). |
386
-| Requirements | Requires a SQL DSN configured for YSQL and access to pg_stat_activity. |
399
| Availability | Available when YSQL is accessible; returns errors if the SQL connection is unavailable. |
400
401
+#### Prerequisites
402
+
403
+##### Grant access to pg_stat_activity
404
+
405
+Configure a YSQL DSN and grant access to pg_stat_activity.
406
+
407
+
408
+
409
#### Parameters
410
411
| Parameter | Type | Description | Required | Default | Options |
@@ -396,19 +416,19 @@ Aggregated query statistics from pg_stat_statements.
416
417
Snapshot of currently running SQL statements.
418
399
-| Column | Type | Description |
400
-|:-------|:-----|:------------|
401
-| PID | string | |
402
-| Query | string | |
403
-| Database | string | |
404
-| User | string | |
405
-| State | string | |
406
-| Wait Event Type | string | |
407
-| Wait Event | string | |
408
-| Application | string | |
409
-| Client Address | string | |
410
-| Query Start | string | |
411
-| Elapsed | duration | |
419
+| Column | Type | Unit | Visibility | Description |
420
+|:-------|:-----|:-----|:-----------|:------------|
421
+| PID | string | | hidden | |
422
+| Query | string | | | |
423
+| Database | string | | | |
424
+| User | string | | | |
425
+| State | string | | | |
426
+| Wait Event Type | string | | hidden | |
427
+| Wait Event | string | | hidden | |
428
+| Application | string | | hidden | |
429
+| Client Address | string | | hidden | |
430
+| Query Start | string | | hidden | |
431
+| Elapsed | duration | milliseconds | | |
432
433
434