docs: fix Top tab leftovers (#21875)
Ilya Mashchenko committed
Mar 3, 2026 at 16:18 UTC
ba559b93c6051c2688abe024adc739bb33853438
3 files changed
+64
-59
docs/.map/map.yaml
+2
-2
@@ -494,9 +494,9 @@ sidebar:
494
edit_url: https://github.com/netdata/netdata/edit/master/src/collectors/systemd-journal.plugin/active_journal_centralization_guide_no_encryption.md
495
- type: integration_placeholder
496
integration_kind: logs
497
- # Top Consumers
497
+ # Live
498
- meta:
499
- label: Top Consumers
499
+ label: Live View
500
edit_url: https://github.com/netdata/netdata/edit/master/docs/top-monitoring-netdata-functions.md
501
description: Present the Netdata Functions what these are and why they should be used.
502
items:
docs/functions/databases.md
+43
-38
@@ -4,32 +4,32 @@
4
5
Database query functions provide deep visibility into SQL and NoSQL database performance through Netdata's Live tab. They help you identify problematic queries, detect deadlocks, and understand error patterns—all from the Netdata dashboard.
6
7
-| Capability | Description |
8
-|------------|-------------|
9
-| **Top Queries** | Identify the most expensive queries by execution time, I/O, rows processed, or other metrics |
10
-| **Running Queries** | See currently executing queries in real-time |
11
-| **Deadlock Detection** | View the latest detected deadlock with full transaction details |
12
-| **Error Attribution** | Correlate SQL errors with the queries that caused them |
7
+| Capability | Description |
8
+|------------------------|----------------------------------------------------------------------------------------------|
9
+| **Top Queries** | Identify the most expensive queries by execution time, I/O, rows processed, or other metrics |
10
+| **Running Queries** | See currently executing queries in real-time |
11
+| **Deadlock Detection** | View the latest detected deadlock with full transaction details |
12
+| **Error Attribution** | Correlate SQL errors with the queries that caused them |
13
14
## Supported Databases
15
16
-| Database | Top Queries | Running Queries | Deadlock Info | Error Info | Integration Docs |
17
-|----------|:-----------:|:---------------:|:-------------:|:----------:|------------------|
18
-| ClickHouse | ✅ | - | - | - | [ClickHouse](/src/go/plugin/go.d/collector/clickhouse/integrations/clickhouse.md) |
19
-| CockroachDB | ✅ | ✅ | - | - | [CockroachDB](/src/go/plugin/go.d/collector/cockroachdb/integrations/cockroachdb.md) |
20
-| Couchbase | ✅ | - | - | - | [Couchbase](/src/go/plugin/go.d/collector/couchbase/integrations/couchbase.md) |
21
-| Elasticsearch | ✅ | - | - | - | [Elasticsearch](/src/go/plugin/go.d/collector/elasticsearch/integrations/elasticsearch.md) |
22
-| MongoDB | ✅ | - | - | - | [MongoDB](/src/go/plugin/go.d/collector/mongodb/integrations/mongodb.md) |
23
-| Microsoft SQL Server | ✅ | - | ✅ | ✅* | [MSSQL](/src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md) |
24
-| MySQL | ✅ | - | ✅ | ✅* | [MySQL](/src/go/plugin/go.d/collector/mysql/integrations/mysql.md) |
25
-| MariaDB | ✅ | - | ✅ | ✅* | [MariaDB](/src/go/plugin/go.d/collector/mysql/integrations/mariadb.md) |
26
-| Percona Server | ✅ | - | ✅ | ✅* | [Percona](/src/go/plugin/go.d/collector/mysql/integrations/percona_mysql.md) |
27
-| Oracle Database | ✅ | ✅ | - | - | [Oracle](/src/go/plugin/go.d/collector/oracledb/integrations/oracle_db.md) |
28
-| PostgreSQL | ✅ | ✅ | - | ✅** | [PostgreSQL](/src/go/plugin/go.d/collector/postgres/integrations/postgresql.md) |
29
-| ProxySQL | ✅ | - | - | - | [ProxySQL](/src/go/plugin/go.d/collector/proxysql/integrations/proxysql.md) |
30
-| Redis | ✅ | - | - | - | [Redis](/src/go/plugin/go.d/collector/redis/integrations/redis.md) |
31
-| RethinkDB | - | ✅ | - | - | [RethinkDB](/src/go/plugin/go.d/collector/rethinkdb/integrations/rethinkdb.md) |
32
-| YugabyteDB | ✅ | ✅ | - | - | [YugabyteDB](/src/go/plugin/go.d/collector/yugabytedb/integrations/yugabytedb.md) |
16
+| Database | Top Queries | Running Queries | Deadlock Info | Error Info | Integration Docs |
17
+|----------------------|:-----------:|:---------------:|:-------------:|:----------:|--------------------------------------------------------------------------------------------|
18
+| ClickHouse | ✅ | - | - | - | [ClickHouse](/src/go/plugin/go.d/collector/clickhouse/integrations/clickhouse.md) |
19
+| CockroachDB | ✅ | ✅ | - | - | [CockroachDB](/src/go/plugin/go.d/collector/cockroachdb/integrations/cockroachdb.md) |
20
+| Couchbase | ✅ | - | - | - | [Couchbase](/src/go/plugin/go.d/collector/couchbase/integrations/couchbase.md) |
21
+| Elasticsearch | ✅ | - | - | - | [Elasticsearch](/src/go/plugin/go.d/collector/elasticsearch/integrations/elasticsearch.md) |
22
+| MongoDB | ✅ | - | - | - | [MongoDB](/src/go/plugin/go.d/collector/mongodb/integrations/mongodb.md) |
23
+| Microsoft SQL Server | ✅ | - | ✅ | ✅* | [MSSQL](/src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md) |
24
+| MySQL | ✅ | - | ✅ | ✅* | [MySQL](/src/go/plugin/go.d/collector/mysql/integrations/mysql.md) |
25
+| MariaDB | ✅ | - | ✅ | ✅* | [MariaDB](/src/go/plugin/go.d/collector/mysql/integrations/mariadb.md) |
26
+| Percona Server | ✅ | - | ✅ | ✅* | [Percona](/src/go/plugin/go.d/collector/mysql/integrations/percona_mysql.md) |
27
+| Oracle Database | ✅ | ✅ | - | - | [Oracle](/src/go/plugin/go.d/collector/oracledb/integrations/oracle_db.md) |
28
+| PostgreSQL | ✅ | ✅ | - | ✅** | [PostgreSQL](/src/go/plugin/go.d/collector/postgres/integrations/postgresql.md) |
29
+| ProxySQL | ✅ | - | - | - | [ProxySQL](/src/go/plugin/go.d/collector/proxysql/integrations/proxysql.md) |
30
+| Redis | ✅ | - | - | - | [Redis](/src/go/plugin/go.d/collector/redis/integrations/redis.md) |
31
+| RethinkDB | - | ✅ | - | - | [RethinkDB](/src/go/plugin/go.d/collector/rethinkdb/integrations/rethinkdb.md) |
32
+| YugabyteDB | ✅ | ✅ | - | - | [YugabyteDB](/src/go/plugin/go.d/collector/yugabytedb/integrations/yugabytedb.md) |
33
34
*\* Error Info is integrated directly into Top Queries results—each query row shows its associated errors.*
35
@@ -42,6 +42,7 @@ Database query functions provide deep visibility into SQL and NoSQL database per
42
Retrieves **accumulated query statistics** over a time window. These are aggregated metrics (total calls, total time, average time, etc.) from the database's query statistics infrastructure—not real-time snapshots.
43
44
**Filter options** vary by database but typically include:
45
+
46
- Execution time (total, average)
47
- Call count
48
- Rows processed (read, written, returned)
@@ -49,6 +50,7 @@ Retrieves **accumulated query statistics** over a time window. These are aggrega
50
- Resource usage (CPU, memory, locks)
51
52
The number of queries returned is configurable (default: 500). This is a two-stage process:
53
+
54
1. **Server-side**: Database returns the top N queries ranked by your chosen metric
55
2. **Client-side**: UI can further sort, filter, and explore the returned data
56
@@ -65,6 +67,7 @@ Displays the **most recently detected deadlock**—not a historical list. When a
67
**Supported**: MySQL/MariaDB/Percona, Microsoft SQL Server
68
69
Information provided:
70
+
71
- Deadlock timestamp and ID
72
- Participating transactions
73
- Victim transaction (rolled back)
@@ -78,6 +81,7 @@ Shows **recent SQL errors** from the database's error history. Error attribution
81
**Supported**: MySQL/MariaDB/Percona, Microsoft SQL Server, PostgreSQL (with pg_stat_monitor)
82
83
Attribution status values:
84
+
85
- `enabled` — Error details available for this query
86
- `no_data` — No recent errors for this query
87
- `not_enabled` — Error tracking not configured
@@ -89,23 +93,24 @@ Attribution status values:
93
94
Some databases normalize queries (replacing literals with placeholders), while others show actual values that may contain sensitive data:
95
92
-| Database | Query Text |
93
-|----------|:----------:|
94
-| ClickHouse | Normalized |
95
-| CockroachDB | ⚠️ Raw |
96
-| Couchbase | ⚠️ Raw |
97
-| Elasticsearch | ⚠️ Raw |
98
-| MongoDB | ⚠️ Raw |
99
-| Microsoft SQL Server | ⚠️ Raw |
96
+| Database | Query Text |
97
+|-----------------------|:-------------------------------------------:|
98
+| ClickHouse | Normalized |
99
+| CockroachDB | ⚠️ Raw |
100
+| Couchbase | ⚠️ Raw |
101
+| Elasticsearch | ⚠️ Raw |
102
+| MongoDB | ⚠️ Raw |
103
+| Microsoft SQL Server | ⚠️ Raw |
104
| MySQL/MariaDB/Percona | Normalized (Top Queries), ⚠️ Raw (Deadlock) |
101
-| Oracle | ⚠️ Raw |
102
-| PostgreSQL | Normalized |
103
-| ProxySQL | Normalized |
104
-| Redis | ⚠️ Raw |
105
-| RethinkDB | ⚠️ Raw |
106
-| YugabyteDB | ⚠️ Raw |
105
+| Oracle | ⚠️ Raw |
106
+| PostgreSQL | Normalized |
107
+| ProxySQL | Normalized |
108
+| Redis | ⚠️ Raw |
109
+| RethinkDB | ⚠️ Raw |
110
+| YugabyteDB | ⚠️ Raw |
111
112
**Legend**:
113
+
114
- **Normalized**: Literals replaced with placeholders (`SELECT * FROM users WHERE id = ?`)
115
- **⚠️ Raw**: May contain actual values (`SELECT * FROM users WHERE id = 12345`)
116
@@ -132,5 +137,5 @@ Each database requires specific setup. Click the integration link in the table a
137
138
## Related Documentation
139
135
-- [Top Consumers Overview](/docs/top-monitoring-netdata-functions.md)
140
+- [Live View](/docs/top-monitoring-netdata-functions.md)
141
- [Processes Function](/docs/functions/processes.md)
docs/top-monitoring-netdata-functions.md
+19
-19
@@ -1,4 +1,4 @@
1
-# Top Consumers
1
+# Live View
2
3
Netdata Agent collectors provide on-demand, runtime executable functions on the host where they are deployed. Available since v1.37.1.
4
@@ -8,24 +8,24 @@ Beyond their primary roles of collecting metrics, collectors can execute specifi
8
9
## What functions are currently available?
10
11
-| Function | Description | Alternative to CLI tools | Require Cloud | plugin - module |
12
-|:---|:---|---|:---|:---|
13
-| Block-devices | Disk I/O activity for all block devices, offering insights into both data transfer volume and operation performance. | `iostat` | no | [proc](https://github.com/netdata/netdata/tree/master/src/collectors/proc.plugin#readme) |
14
-| Containers-vms | Insights into the resource utilization of containers and QEMU virtual machines: CPU usage, memory consumption, disk I/O, and network traffic. | `docker stats`, `systemd-cgtop` | no | [cgroups](https://github.com/netdata/netdata/tree/master/src/collectors/cgroups.plugin#readme) |
15
-| Deadlock-info | Most recent deadlock events detected in the database. Supported databases: Microsoft SQL Server, MySQL, MariaDB, Percona MySQL. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): mssql, mysql |
16
-| Error-info | Recent SQL errors from database error tracking. Supported databases: Microsoft SQL Server, MySQL, MariaDB, Percona MySQL. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): mssql, mysql |
17
-| Ipmi-sensors | Readings and status of IPMI sensors. | `ipmi-sensors` | no | [freeipmi](https://github.com/netdata/netdata/tree/master/src/collectors/freeipmi.plugin#readme) |
18
-| Mount-points | Disk usage for each mount point, including used and available space, both in terms of percentage and actual bytes, as well as used and available inode counts. | `df` | no | [diskspace](https://github.com/netdata/netdata/tree/master/src/collectors/diskspace.plugin#readme) |
19
-| Network-connections | Real-time monitoring of all network connections, showing established connections, ports, protocols, and connection states across TCP/UDP services. | `netstat`, `ss` | yes | [network-viewer](https://github.com/netdata/netdata/tree/master/src/collectors/network-viewer.plugin) |
20
-| Network-interfaces | Network traffic, packet drop rates, interface states, MTU, speed, and duplex mode for all network interfaces. | `bmon`, `bwm-ng` | no | [proc](https://github.com/netdata/netdata/tree/master/src/collectors/proc.plugin#readme) |
21
-| Processes | Real-time information about the system's resource usage, including CPU utilization, memory consumption, and disk IO for every running process. | `top`, `htop` | yes | [apps](/src/collectors/apps.plugin/README.md) |
22
-| Running-queries | Currently executing SQL statements. Supported databases: CockroachDB, Oracle DB, PostgreSQL, RethinkDB, YugabyteDB. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): cockroachdb, oracledb, postgres, rethinkdb, yugabytedb |
23
-| SNMP-interfaces | Network interface traffic and status metrics from SNMP-enabled devices, including bandwidth, errors, discards, and operational status. | `snmpwalk` | no | [snmp](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector/snmp#readme) |
24
-| Systemd-list-units | Information about all systemd units, including their active state, description, whether or not they are enabled, and more. | `systemctl list-units` | yes | [systemd-journal](https://github.com/netdata/netdata/tree/master/src/collectors/systemd-journal.plugin#readme) |
25
-| Systemd-services | System resource utilization for all running systemd services: CPU, memory, and disk IO. | `systemd-cgtop` | no | [cgroups](https://github.com/netdata/netdata/tree/master/src/collectors/cgroups.plugin#readme) |
26
-| Top-queries | Aggregated SQL query performance metrics. Supported databases: ClickHouse, CockroachDB, Couchbase, Elasticsearch, MongoDB, Microsoft SQL Server, MySQL, MariaDB, OpenSearch, Oracle DB, Percona MySQL, PostgreSQL, ProxySQL, Redis, YugabyteDB. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): clickhouse, cockroachdb, couchbase, elasticsearch, mongodb, mssql, mysql, oracledb, postgres, proxysql, redis, yugabytedb |
27
-| Netdata-api-calls | Real-time tracing of API calls made to the Netdata Agent. It provides information on query, source, status, elapsed time, and more. | | yes | |
28
-| Netdata-streaming | Comprehensive overview of all Netdata children instances, offering detailed information about their status, replication completion time, and many more. | | yes | |
11
+| Function | Description | Alternative to CLI tools | Require Cloud | plugin - module |
12
+|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13
+| Block-devices | Disk I/O activity for all block devices, offering insights into both data transfer volume and operation performance. | `iostat` | no | [proc](https://github.com/netdata/netdata/tree/master/src/collectors/proc.plugin#readme) |
14
+| Containers-vms | Insights into the resource utilization of containers and QEMU virtual machines: CPU usage, memory consumption, disk I/O, and network traffic. | `docker stats`, `systemd-cgtop` | no | [cgroups](https://github.com/netdata/netdata/tree/master/src/collectors/cgroups.plugin#readme) |
15
+| Deadlock-info | Most recent deadlock events detected in the database. Supported databases: Microsoft SQL Server, MySQL, MariaDB, Percona MySQL. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): mssql, mysql |
16
+| Error-info | Recent SQL errors from database error tracking. Supported databases: Microsoft SQL Server, MySQL, MariaDB, Percona MySQL. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): mssql, mysql |
17
+| Ipmi-sensors | Readings and status of IPMI sensors. | `ipmi-sensors` | no | [freeipmi](https://github.com/netdata/netdata/tree/master/src/collectors/freeipmi.plugin#readme) |
18
+| Mount-points | Disk usage for each mount point, including used and available space, both in terms of percentage and actual bytes, as well as used and available inode counts. | `df` | no | [diskspace](https://github.com/netdata/netdata/tree/master/src/collectors/diskspace.plugin#readme) |
19
+| Network-connections | Real-time monitoring of all network connections, showing established connections, ports, protocols, and connection states across TCP/UDP services. | `netstat`, `ss` | yes | [network-viewer](https://github.com/netdata/netdata/tree/master/src/collectors/network-viewer.plugin) |
20
+| Network-interfaces | Network traffic, packet drop rates, interface states, MTU, speed, and duplex mode for all network interfaces. | `bmon`, `bwm-ng` | no | [proc](https://github.com/netdata/netdata/tree/master/src/collectors/proc.plugin#readme) |
21
+| Processes | Real-time information about the system's resource usage, including CPU utilization, memory consumption, and disk IO for every running process. | `top`, `htop` | yes | [apps](/src/collectors/apps.plugin/README.md) |
22
+| Running-queries | Currently executing SQL statements. Supported databases: CockroachDB, Oracle DB, PostgreSQL, RethinkDB, YugabyteDB. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): cockroachdb, oracledb, postgres, rethinkdb, yugabytedb |
23
+| SNMP-interfaces | Network interface traffic and status metrics from SNMP-enabled devices, including bandwidth, errors, discards, and operational status. | `snmpwalk` | no | [snmp](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector/snmp#readme) |
24
+| Systemd-list-units | Information about all systemd units, including their active state, description, whether or not they are enabled, and more. | `systemctl list-units` | yes | [systemd-journal](https://github.com/netdata/netdata/tree/master/src/collectors/systemd-journal.plugin#readme) |
25
+| Systemd-services | System resource utilization for all running systemd services: CPU, memory, and disk IO. | `systemd-cgtop` | no | [cgroups](https://github.com/netdata/netdata/tree/master/src/collectors/cgroups.plugin#readme) |
26
+| Top-queries | Aggregated SQL query performance metrics. Supported databases: ClickHouse, CockroachDB, Couchbase, Elasticsearch, MongoDB, Microsoft SQL Server, MySQL, MariaDB, OpenSearch, Oracle DB, Percona MySQL, PostgreSQL, ProxySQL, Redis, YugabyteDB. | | yes | [go.d](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/collector#readme): clickhouse, cockroachdb, couchbase, elasticsearch, mongodb, mssql, mysql, oracledb, postgres, proxysql, redis, yugabytedb |
27
+| Netdata-api-calls | Real-time tracing of API calls made to the Netdata Agent. It provides information on query, source, status, elapsed time, and more. | | yes | |
28
+| Netdata-streaming | Comprehensive overview of all Netdata children instances, offering detailed information about their status, replication completion time, and many more. | | yes | |
29
30
## How do functions work with streaming?
31