diff --git a/LegacyLearnCorrelateLinksWithGHURLs.json b/LegacyLearnCorrelateLinksWithGHURLs.json index 8622885d28..f9de2697d9 100644 --- a/LegacyLearnCorrelateLinksWithGHURLs.json +++ b/LegacyLearnCorrelateLinksWithGHURLs.json @@ -3020,5 +3020,8 @@ "https://learn.netdata.cloud/docs/collecting-metrics/applications/pandas": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/README.md", "https://learn.netdata.cloud/docs/collecting-metrics/applications/mesos": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mesos.md", "https://learn.netdata.cloud/docs/collecting-metrics/applications/kafka-consumer-lag": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/kafka_consumer_lag.md", - "https://learn.netdata.cloud/docs/collecting-metrics/applications/files-and-directories": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/filecheck/README.md" + "https://learn.netdata.cloud/docs/collecting-metrics/applications/files-and-directories": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/filecheck/README.md", + "https://learn.netdata.cloud/docs/top-consumers/processes": "https://github.com/netdata/netdata/blob/master/docs/functions/processes.md", + "https://learn.netdata.cloud/docs/top-consumers/database-queries": "https://github.com/netdata/netdata/blob/master/docs/functions/databases.md", + "https://learn.netdata.cloud/docs/top-consumers": "https://github.com/netdata/netdata/blob/master/docs/top-monitoring-netdata-functions.md" } \ No newline at end of file diff --git a/docs/Collecting Metrics/Containers and VMs/Docker.mdx b/docs/Collecting Metrics/Containers and VMs/Docker.mdx index ea35053212..55138b5a53 100644 --- a/docs/Collecting Metrics/Containers and VMs/Docker.mdx +++ b/docs/Collecting Metrics/Containers and VMs/Docker.mdx @@ -103,7 +103,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Containers diff --git a/docs/Collecting Metrics/Databases/ClickHouse.mdx b/docs/Collecting Metrics/Databases/ClickHouse.mdx index d6e5714e9d..34918a0b13 100644 --- a/docs/Collecting Metrics/Databases/ClickHouse.mdx +++ b/docs/Collecting Metrics/Databases/ClickHouse.mdx @@ -176,7 +176,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/CockroachDB.mdx b/docs/Collecting Metrics/Databases/CockroachDB.mdx index 7842c5bc50..2394399401 100644 --- a/docs/Collecting Metrics/Databases/CockroachDB.mdx +++ b/docs/Collecting Metrics/Databases/CockroachDB.mdx @@ -140,7 +140,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/Couchbase.mdx b/docs/Collecting Metrics/Databases/Couchbase.mdx index 0f14227604..da4ed643a2 100644 --- a/docs/Collecting Metrics/Databases/Couchbase.mdx +++ b/docs/Collecting Metrics/Databases/Couchbase.mdx @@ -80,7 +80,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/Elasticsearch.mdx b/docs/Collecting Metrics/Databases/Elasticsearch.mdx index 60313e4d0c..9bdc214508 100644 --- a/docs/Collecting Metrics/Databases/Elasticsearch.mdx +++ b/docs/Collecting Metrics/Databases/Elasticsearch.mdx @@ -176,7 +176,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/MariaDB.mdx b/docs/Collecting Metrics/Databases/MariaDB.mdx index deaa6cf828..08e4bded21 100644 --- a/docs/Collecting Metrics/Databases/MariaDB.mdx +++ b/docs/Collecting Metrics/Databases/MariaDB.mdx @@ -193,7 +193,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/Microsoft SQL Server.mdx b/docs/Collecting Metrics/Databases/Microsoft SQL Server.mdx index ea90284539..be03a0539c 100644 --- a/docs/Collecting Metrics/Databases/Microsoft SQL Server.mdx +++ b/docs/Collecting Metrics/Databases/Microsoft SQL Server.mdx @@ -245,7 +245,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/MongoDB.mdx b/docs/Collecting Metrics/Databases/MongoDB.mdx index 84ed6186c0..7c12ee800c 100644 --- a/docs/Collecting Metrics/Databases/MongoDB.mdx +++ b/docs/Collecting Metrics/Databases/MongoDB.mdx @@ -210,7 +210,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/MySQL.mdx b/docs/Collecting Metrics/Databases/MySQL.mdx index 9359bce050..da927dad3a 100644 --- a/docs/Collecting Metrics/Databases/MySQL.mdx +++ b/docs/Collecting Metrics/Databases/MySQL.mdx @@ -193,7 +193,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/OpenSearch.mdx b/docs/Collecting Metrics/Databases/OpenSearch.mdx index c55f4b3142..723eb40a79 100644 --- a/docs/Collecting Metrics/Databases/OpenSearch.mdx +++ b/docs/Collecting Metrics/Databases/OpenSearch.mdx @@ -176,7 +176,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/Oracle DB.mdx b/docs/Collecting Metrics/Databases/Oracle DB.mdx index fff015a0d0..f011342104 100644 --- a/docs/Collecting Metrics/Databases/Oracle DB.mdx +++ b/docs/Collecting Metrics/Databases/Oracle DB.mdx @@ -141,7 +141,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/Percona MySQL.mdx b/docs/Collecting Metrics/Databases/Percona MySQL.mdx index da4f99ca7e..88dff12cc9 100644 --- a/docs/Collecting Metrics/Databases/Percona MySQL.mdx +++ b/docs/Collecting Metrics/Databases/Percona MySQL.mdx @@ -193,7 +193,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/PostgreSQL.mdx b/docs/Collecting Metrics/Databases/PostgreSQL.mdx index 586968a01b..9a3597a310 100644 --- a/docs/Collecting Metrics/Databases/PostgreSQL.mdx +++ b/docs/Collecting Metrics/Databases/PostgreSQL.mdx @@ -237,7 +237,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/ProxySQL.mdx b/docs/Collecting Metrics/Databases/ProxySQL.mdx index b3a0991026..f81b216589 100644 --- a/docs/Collecting Metrics/Databases/ProxySQL.mdx +++ b/docs/Collecting Metrics/Databases/ProxySQL.mdx @@ -174,7 +174,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/Redis.mdx b/docs/Collecting Metrics/Databases/Redis.mdx index 7b14313c6d..3cc5d09511 100644 --- a/docs/Collecting Metrics/Databases/Redis.mdx +++ b/docs/Collecting Metrics/Databases/Redis.mdx @@ -112,7 +112,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Databases/RethinkDB.mdx b/docs/Collecting Metrics/Databases/RethinkDB.mdx index f7dfc63714..67b2f55658 100644 --- a/docs/Collecting Metrics/Databases/RethinkDB.mdx +++ b/docs/Collecting Metrics/Databases/RethinkDB.mdx @@ -102,7 +102,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Running Queries diff --git a/docs/Collecting Metrics/Databases/SQL databases generic.mdx b/docs/Collecting Metrics/Databases/SQL databases generic.mdx index 1bfe275e62..4e14fe79c7 100644 --- a/docs/Collecting Metrics/Databases/SQL databases generic.mdx +++ b/docs/Collecting Metrics/Databases/SQL databases generic.mdx @@ -33,7 +33,7 @@ To see what a specific job collects, open that job's dashboard in Netdata and inspect the charts and dimensions it created. Jobs can also define **functions** that provide interactive table views in -Netdata's Top tab. A job can have metrics only, functions only, or both. +Netdata's Live tab. A job can have metrics only, functions only, or both. :::tip @@ -57,7 +57,7 @@ For each metric block you define, it executes the SQL query (inline or via dimensions. Additionally, you can define **functions** that expose SQL query results as -interactive table views in Netdata's Top tab. Functions support filtering, +interactive table views in Netdata's Live tab. Functions support filtering, sorting, and searching without creating persistent metrics. ### Result Processing Modes @@ -117,11 +117,11 @@ Metrics and charts are **defined by your SQL queries and metric blocks** at runt ## Functions This collector supports user-defined SQL functions that expose query results as -interactive table views in Netdata's **Top** tab. Functions are configured per job +interactive table views in Netdata's **Live** tab. Functions are configured per job in the `functions` section of the job configuration. Since functions are entirely user-defined, no predefined functions are listed here. -In the Top tab, functions appear in a hierarchical menu: +In the Live tab, functions appear in a hierarchical menu: ``` Databases @@ -276,7 +276,7 @@ metrics: # Set function_only: true if this job only provides functions (no metrics). function_only: # OPTIONAL. Default: false. -# Expose SQL queries as interactive table views in Netdata's Top tab. +# Expose SQL queries as interactive table views in Netdata's Live tab. functions: - id: # REQUIRED. Unique identifier. name: # OPTIONAL. Derived from id if not set. @@ -312,7 +312,7 @@ functions: | **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 | | **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 | | | 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 | -| **Functions** | functions | A list of SQL functions exposed as interactive table views in Netdata's Top tab. Each function runs a SQL query and displays results in a filterable, sortable table. See [Functions](#functions) for details. | [] | no | +| **Functions** | functions | A list of SQL functions exposed as interactive table views in Netdata's Live tab. Each function runs a SQL query and displays results in a filterable, sortable table. See [Functions](#functions) for details. | [] | no | | | functions[].id | Unique identifier for this function. | | yes | | | functions[].name | Display name shown in the UI. Auto-derived from ID if not set. | | no | | | functions[].description | Help text shown in the UI. | | no | @@ -639,7 +639,7 @@ jobs: PostgreSQL example that provides an interactive slow query analysis view without collecting any time-series metrics. -This is useful for ad-hoc troubleshooting via the Netdata **Top** tab. +This is useful for ad-hoc troubleshooting via the Netdata **Live** tab. The function queries `pg_stat_statements` to show the slowest queries sorted by total execution time. diff --git a/docs/Collecting Metrics/Databases/YugabyteDB.mdx b/docs/Collecting Metrics/Databases/YugabyteDB.mdx index 9a74f702c2..d1d6b2bca6 100644 --- a/docs/Collecting Metrics/Databases/YugabyteDB.mdx +++ b/docs/Collecting Metrics/Databases/YugabyteDB.mdx @@ -338,7 +338,7 @@ Metrics: ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Top Queries diff --git a/docs/Collecting Metrics/Networking/SNMP devices.mdx b/docs/Collecting Metrics/Networking/SNMP devices.mdx index 14155cfb92..2af587520b 100644 --- a/docs/Collecting Metrics/Networking/SNMP devices.mdx +++ b/docs/Collecting Metrics/Networking/SNMP devices.mdx @@ -130,7 +130,7 @@ If `ping.enabled` is true, ICMP latency/packet-loss charts are also provided (or ## Functions -This collector exposes real-time functions for interactive troubleshooting in the Top tab. +This collector exposes real-time functions for interactive troubleshooting in the Live tab. ### Network Interfaces diff --git a/docs/Dashboards and Charts/Dashboards and Charts.mdx b/docs/Dashboards and Charts/Dashboards and Charts.mdx index 2d49e6507b..556be3cb5e 100644 --- a/docs/Dashboards and Charts/Dashboards and Charts.mdx +++ b/docs/Dashboards and Charts/Dashboards and Charts.mdx @@ -29,7 +29,7 @@ The Netdata dashboard consists of the following main sections: - [Nodes Tab](/docs/dashboards-and-charts/tabs/nodes) - [Netdata Charts](/docs/dashboards-and-charts/charts) - [Metrics Tab and Single Node Tabs](/docs/dashboards-and-charts/tabs/metrics) -- [Top Tab](/docs/dashboards-and-charts/tabs/top) +- [Live Tab](/docs/dashboards-and-charts/tabs/live) - [Logs Tab](/docs/dashboards-and-charts/tabs/logs) - [Dashboards Tab](/docs/dashboards-and-charts/tabs/dashboards) - [Alerts Tab](/docs/dashboards-and-charts/tabs/alerts) diff --git a/docs/Dashboards and Charts/Node Filter.mdx b/docs/Dashboards and Charts/Node Filter.mdx index f5d6f2e248..666777610b 100644 --- a/docs/Dashboards and Charts/Node Filter.mdx +++ b/docs/Dashboards and Charts/Node Filter.mdx @@ -16,7 +16,7 @@ Inside the filter, the nodes get categorized into three groups: | Group | Description | |---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Live | Nodes that are currently online, collecting and streaming metrics to Cloud. Live nodes display raised [Alert](/docs/dashboards-and-charts/tabs/alerts) counters, [Machine Learning](https://github.com/netdata/netdata/blob/master/src/ml/README.md) availability, and [Functions](/docs/top-consumers) availability | +| Live | Nodes that are currently online, collecting and streaming metrics to Cloud. Live nodes display raised [Alert](/docs/dashboards-and-charts/tabs/alerts) counters, [Machine Learning](https://github.com/netdata/netdata/blob/master/src/ml/README.md) availability, and [Functions](/docs/live-view) availability | | Stale | Child nodes that stopped streaming to their Parent, but the Parent is still online and has historical data available. For these nodes you can only see their ML status, as they are not online to provide more information | | Offline | Nodes that are disconnected and have no data available in any Parent. Offline nodes are automatically deleted after a threshold period (7 days for standalone agents, 48 hours for child nodes) and can also be deleted manually. | diff --git a/docs/Dashboards and Charts/Tabs/Top.mdx b/docs/Dashboards and Charts/Tabs/Live.mdx similarity index 76% rename from docs/Dashboards and Charts/Tabs/Top.mdx rename to docs/Dashboards and Charts/Tabs/Live.mdx index bafe4bef11..d7adff9fa9 100644 --- a/docs/Dashboards and Charts/Tabs/Top.mdx +++ b/docs/Dashboards and Charts/Tabs/Live.mdx @@ -1,17 +1,17 @@ --- -custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/top-tab.md" -sidebar_label: "Top" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/live-tab.md" +sidebar_label: "Live" learn_status: "Published" learn_rel_path: "Dashboards and Charts/Tabs" -description: "Instructions on how to use Functions" +description: "Access live information from monitored nodes through Netdata Functions" sidebar_position: "90" -learn_link: "https://learn.netdata.cloud/docs/dashboards-and-charts/tabs/top" -slug: "/dashboards-and-charts/tabs/top" +learn_link: "https://learn.netdata.cloud/docs/dashboards-and-charts/tabs/live" +slug: "/dashboards-and-charts/tabs/live" --- -# Top Tab +# Live Tab -The **Top tab** gives you access to [Netdata Functions](/docs/top-consumers) that can be executed on any node running the Netdata Agent. These specialized routines, provided by various collectors, offer enhanced insights and allow you to trigger specific actions directly on the monitored node. +The **Live tab** gives you real-time access to [Netdata Functions](/docs/live-view) that can be executed on any node running the Netdata Agent. These specialized routines, provided by various collectors, deliver live information from your monitored nodes—including database monitoring functions, network topology maps, process explorers, and more. You can **use these Functions to**: @@ -26,11 +26,11 @@ You can also execute a Function from the [Nodes tab](/docs/dashboards-and-charts :::note -If you receive an error saying that your node can’t execute Functions, check the [prerequisites](/docs/top-consumers) to ensure your node is configured properly. +If you receive an error saying that your node can't execute Functions, check the [prerequisites](/docs/live-view) to ensure your node is configured properly. ::: -## Top Tab Structure Overview +## Live Tab Structure Overview ```mermaid flowchart TD @@ -53,13 +53,13 @@ flowchart TD :::tip -The diagram above shows how Function selection and execution work in the Top tab, helping you visualize the flow from choosing a Function to viewing the results. +The diagram above shows how Function selection and execution work in the Live tab, helping you visualize the flow from choosing a Function to viewing the results. ::: -## Top Tab View +## Live Tab View -The main view of the Top tab provides two elements, depending on the selected Function: +The main view of the Live tab provides two elements, depending on the selected Function: | Element | Description | |-------------------|------------------------------------------------------------------------------------------------------------------------------| @@ -77,7 +77,7 @@ You can control the data refresh and update settings in the top right-hand corne ## Functions Bar -The **Functions bar**, located on the right-hand side of the Top tab, lets you select which Function to run, on which node, and apply filtering where available. +The **Functions bar**, located on the right-hand side of the Live tab, lets you select which Function to run, on which node, and apply filtering where available. | Option | Description | |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/Developer and Contributor Corner/Glossary.mdx b/docs/Developer and Contributor Corner/Glossary.mdx index 01da460152..a9baa6c898 100644 --- a/docs/Developer and Contributor Corner/Glossary.mdx +++ b/docs/Developer and Contributor Corner/Glossary.mdx @@ -63,7 +63,7 @@ Missing a term? Let us know or submit a request to expand our glossary. Together - [**Flood Protection**](/docs/alerts-&-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference#benefits-of-centralized-notifications): If a node has too many state changes like firing too many alerts or going from reachable to unreachable, Netdata Cloud enables flood protection. As long as a node is in flood protection mode, Netdata Cloud doesn’t send notifications about this node -- [**Functions** or **Netdata Functions**](/docs/top-consumers): Routines exposed by a collector on the Netdata Agent that can bring additional information to support troubleshooting or trigger some action to happen on the node itself. +- [**Functions** or **Netdata Functions**](/docs/live-view): Routines exposed by a collector on the Netdata Agent that can bring additional information to support troubleshooting or trigger some action to happen on the node itself. ## G @@ -108,7 +108,7 @@ Missing a term? Let us know or submit a request to expand our glossary. Together - [**Netdata Cloud** or **Cloud**](/docs/netdata-cloud): Netdata Cloud is a web application that gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can view key metrics, insightful charts, and active alerts from all your nodes in a single web interface. -- [**Netdata Functions** or **Functions**](/docs/top-consumers): Routines exposed by a collector on the Netdata Agent that can bring additional information to support troubleshooting or trigger some action to happen on the node itself. +- [**Netdata Functions** or **Functions**](/docs/live-view): Routines exposed by a collector on the Netdata Agent that can bring additional information to support troubleshooting or trigger some action to happen on the node itself. - [**Node States**](/docs/netdata-cloud/node-states-and-transitions): The connection status of nodes in Netdata Cloud. Nodes can be Live (actively streaming), Stale (not streaming but historical data available via Parent), Offline (disconnected, no data available), or Unseen (claimed but never connected). See [Node States and Transitions](/docs/netdata-cloud/node-states-and-transitions). diff --git a/docs/Live View/Database Queries.mdx b/docs/Live View/Database Queries.mdx new file mode 100644 index 0000000000..47a08e678e --- /dev/null +++ b/docs/Live View/Database Queries.mdx @@ -0,0 +1,152 @@ +--- +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/functions/databases.md" +sidebar_label: "Database Queries" +learn_status: "Published" +learn_rel_path: "Live View" +description: "Top and running database queries with deadlock and error attribution for 13 databases." +sidebar_position: "20" +learn_link: "https://learn.netdata.cloud/docs/live-view/database-queries" +slug: "/live-view/database-queries" +--- + +# Database Query Functions + +## Overview + +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. + +| Capability | Description | +|------------------------|----------------------------------------------------------------------------------------------| +| **Top Queries** | Identify the most expensive queries by execution time, I/O, rows processed, or other metrics | +| **Running Queries** | See currently executing queries in real-time | +| **Deadlock Detection** | View the latest detected deadlock with full transaction details | +| **Error Attribution** | Correlate SQL errors with the queries that caused them | + +## Supported Databases + +| Database | Top Queries | Running Queries | Deadlock Info | Error Info | Integration Docs | +|----------------------|:-----------:|:---------------:|:-------------:|:----------:|--------------------------------------------------------------------------------------------| +| ClickHouse | ✅ | - | - | - | [ClickHouse](/docs/collecting-metrics/databases/clickhouse) | +| CockroachDB | ✅ | ✅ | - | - | [CockroachDB](/docs/collecting-metrics/databases/cockroachdb) | +| Couchbase | ✅ | - | - | - | [Couchbase](/docs/collecting-metrics/databases/couchbase) | +| Elasticsearch | ✅ | - | - | - | [Elasticsearch](/docs/collecting-metrics/databases/elasticsearch) | +| MongoDB | ✅ | - | - | - | [MongoDB](/docs/collecting-metrics/databases/mongodb) | +| Microsoft SQL Server | ✅ | - | ✅ | ✅* | [MSSQL](/docs/collecting-metrics/databases/microsoft-sql-server) | +| MySQL | ✅ | - | ✅ | ✅* | [MySQL](/docs/collecting-metrics/databases/mysql) | +| MariaDB | ✅ | - | ✅ | ✅* | [MariaDB](/docs/collecting-metrics/databases/mariadb) | +| Percona Server | ✅ | - | ✅ | ✅* | [Percona](/docs/collecting-metrics/databases/percona-mysql) | +| Oracle Database | ✅ | ✅ | - | - | [Oracle](/docs/collecting-metrics/databases/oracle-db) | +| PostgreSQL | ✅ | ✅ | - | ✅** | [PostgreSQL](/docs/collecting-metrics/databases/postgresql) | +| ProxySQL | ✅ | - | - | - | [ProxySQL](/docs/collecting-metrics/databases/proxysql) | +| Redis | ✅ | - | - | - | [Redis](/docs/collecting-metrics/databases/redis) | +| RethinkDB | - | ✅ | - | - | [RethinkDB](/docs/collecting-metrics/databases/rethinkdb) | +| YugabyteDB | ✅ | ✅ | - | - | [YugabyteDB](/docs/collecting-metrics/databases/yugabytedb) | + +*\* Error Info is integrated directly into Top Queries results—each query row shows its associated errors.* + +*\*\* PostgreSQL error info requires [pg_stat_monitor](https://docs.percona.com/pg-stat-monitor/) (Percona). The collector auto-detects and uses it when available.* + +## Function Types + +### Top Queries + +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. + +**Filter options** vary by database but typically include: + +- Execution time (total, average) +- Call count +- Rows processed (read, written, returned) +- I/O metrics (logical reads, physical reads) +- Resource usage (CPU, memory, locks) + +The number of queries returned is configurable (default: 500). This is a two-stage process: + +1. **Server-side**: Database returns the top N queries ranked by your chosen metric +2. **Client-side**: UI can further sort, filter, and explore the returned data + +### Running Queries + +Shows **currently executing queries** at the moment of request. Essential for diagnosing stuck queries, long-running transactions, or unexpected load. + +**Supported**: CockroachDB, Oracle, PostgreSQL, RethinkDB, YugabyteDB + +### Deadlock Info + +Displays the **most recently detected deadlock**—not a historical list. When a new deadlock occurs, it replaces the previous one. + +**Supported**: MySQL/MariaDB/Percona, Microsoft SQL Server + +Information provided: + +- Deadlock timestamp and ID +- Participating transactions +- Victim transaction (rolled back) +- Query text and lock details +- Wait resource + +### Error Info + +Shows **recent SQL errors** from the database's error history. Error attribution is embedded directly in Top Queries results—each query row includes error details when available. + +**Supported**: MySQL/MariaDB/Percona, Microsoft SQL Server, PostgreSQL (with pg_stat_monitor) + +Attribution status values: + +- `enabled` — Error details available for this query +- `no_data` — No recent errors for this query +- `not_enabled` — Error tracking not configured +- `not_supported` — Database version lacks required features + +## Security Considerations + +### Query Text Exposure + +Some databases normalize queries (replacing literals with placeholders), while others show actual values that may contain sensitive data: + +| Database | Query Text | +|-----------------------|:-------------------------------------------:| +| ClickHouse | Normalized | +| CockroachDB | ⚠️ Raw | +| Couchbase | ⚠️ Raw | +| Elasticsearch | ⚠️ Raw | +| MongoDB | ⚠️ Raw | +| Microsoft SQL Server | ⚠️ Raw | +| MySQL/MariaDB/Percona | Normalized (Top Queries), ⚠️ Raw (Deadlock) | +| Oracle | ⚠️ Raw | +| PostgreSQL | Normalized | +| ProxySQL | Normalized | +| Redis | ⚠️ Raw | +| RethinkDB | ⚠️ Raw | +| YugabyteDB | ⚠️ Raw | + +**Legend**: + +- **Normalized**: Literals replaced with placeholders (`SELECT * FROM users WHERE id = ?`) +- **⚠️ Raw**: May contain actual values (`SELECT * FROM users WHERE id = 12345`) + +:::caution + +Error messages may contain sensitive values regardless of query normalization. Ensure appropriate access controls are in place. + +::: + +### Recommendations + +1. **Disable unneeded functions** — Each integration supports configuration options to disable specific functions +2. **Use Netdata Cloud access controls** — Assign users to appropriate Rooms and Roles +3. **Use dedicated database users** — Grant only the permissions required for monitoring + +## Getting Started + +Each database requires specific setup. Click the integration link in the table above for: + +- Prerequisites and permissions required +- Configuration options +- Available metrics and columns +- Database-specific notes + +## Related Documentation + +- [Live View](/docs/live-view) +- [Processes Function](/docs/live-view/processes) diff --git a/docs/Live View/Live View.mdx b/docs/Live View/Live View.mdx new file mode 100644 index 0000000000..7ca0297e1a --- /dev/null +++ b/docs/Live View/Live View.mdx @@ -0,0 +1,55 @@ +--- +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/top-monitoring-netdata-functions.md" +sidebar_label: "Live View" +learn_status: "Published" +learn_rel_path: "Live View" +description: "Present the Netdata Functions what these are and why they should be used." +sidebar_position: "120" +learn_link: "https://learn.netdata.cloud/docs/live-view" +slug: "/live-view" +--- + +# Live View + +Netdata Agent collectors provide on-demand, runtime executable functions on the host where they are deployed. Available since v1.37.1. + +## What is a function? + +Beyond their primary roles of collecting metrics, collectors can execute specific routines when requested. These routines provide additional diagnostic information or trigger actions directly on the host node. + +## What functions are currently available? + +| Function | Description | Alternative to CLI tools | Require Cloud | plugin - module | +|:--------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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) | +| 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) | +| 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 | +| 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 | +| Ipmi-sensors | Readings and status of IPMI sensors. | `ipmi-sensors` | no | [freeipmi](https://github.com/netdata/netdata/tree/master/src/collectors/freeipmi.plugin#readme) | +| 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) | +| 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) | +| 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) | +| 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](https://github.com/netdata/netdata/blob/master/src/collectors/apps.plugin/README.md) | +| 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 | +| 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) | +| 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) | +| 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) | +| 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 | +| 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 | | +| Netdata-streaming | Comprehensive overview of all Netdata children instances, offering detailed information about their status, replication completion time, and many more. | | yes | | + +## How do functions work with streaming? + +When streaming is enabled, function definitions propagate from Child nodes to their Parent node. If this Parent node is connected to Netdata Cloud, it can trigger function execution on any of its connected Child nodes. + +## Why are some functions only available on Netdata Cloud? + +Some functions are exclusively available through Netdata Cloud for security reasons. Since functions can execute node-level routines that may access sensitive information, we restrict their exposure through the Agent's API. This security concern is addressed by our [ACLK](/docs/netdata-cloud/agent-cloud-link-aclk) protocol, which provides secure communication between Netdata Agent and Netdata Cloud. + +## Feedback + +If you have ideas or requests for other functions: + +- Participate in the relevant [GitHub discussion](https://github.com/netdata/netdata/discussions/14412) +- Open a [feature request](https://github.com/netdata/netdata-cloud/issues/new?assignees=&labels=feature+request%2Cneeds+triage&template=FEAT_REQUEST.yml&title=%5BFeat%5D%3A+) on Netdata Cloud repo +- Join the Netdata community on [Discord](https://discord.com/invite/2mEmfW735j) and let us know. diff --git a/docs/Top Consumers/Processes.mdx b/docs/Live View/Processes.mdx similarity index 99% rename from docs/Top Consumers/Processes.mdx rename to docs/Live View/Processes.mdx index 549b0005ff..39d5b2e2ae 100644 --- a/docs/Top Consumers/Processes.mdx +++ b/docs/Live View/Processes.mdx @@ -2,10 +2,10 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/functions/processes.md" sidebar_label: "Processes" learn_status: "Published" -learn_rel_path: "Top Consumers" +learn_rel_path: "Live View" sidebar_position: "10" -learn_link: "https://learn.netdata.cloud/docs/top-consumers/processes" -slug: "/top-consumers/processes" +learn_link: "https://learn.netdata.cloud/docs/live-view/processes" +slug: "/live-view/processes" --- # Function: Top / Processes diff --git a/docs/Netdata Cloud/Netdata Cloud.mdx b/docs/Netdata Cloud/Netdata Cloud.mdx index fae47deda9..2335692505 100644 --- a/docs/Netdata Cloud/Netdata Cloud.mdx +++ b/docs/Netdata Cloud/Netdata Cloud.mdx @@ -135,7 +135,7 @@ The Cloud prefers: - The most distant (from the Child) Parent that is available when doing metrics visualization queries (since usually these Parents have been added for this purpose). -- The closest (to the Child) Parent available for [Top Monitoring](/docs/top-consumers). The streaming protocol of Parents and Children is able to forward such requests to the leaf child, via the Parents, to respond with live and accurate data. +- The closest (to the Child) Parent available for [Top Monitoring](/docs/live-view). The streaming protocol of Parents and Children is able to forward such requests to the leaf child, via the Parents, to respond with live and accurate data. You may connect Children to the Cloud for high-availability, in cases where their Parents become unreachable. diff --git a/docs/Netdata Parents/Metrics Centralization Points/Replication of Past Samples.mdx b/docs/Netdata Parents/Metrics Centralization Points/Replication of Past Samples.mdx index debf02dd48..b464e3c1df 100644 --- a/docs/Netdata Parents/Metrics Centralization Points/Replication of Past Samples.mdx +++ b/docs/Netdata Parents/Metrics Centralization Points/Replication of Past Samples.mdx @@ -127,7 +127,7 @@ You can monitor how replication is progressing through both your dashboard and A ### Dashboard Monitoring -Check your replication progress right in your dashboard using the Netdata Function `Netdata-streaming`, under the `Top` tab. +Check your replication progress right in your dashboard using the Netdata Function `Netdata-streaming`, under the `Live` tab. ### API Monitoring diff --git a/docs/Security and Privacy Design/Access Control and Feature Availability.mdx b/docs/Security and Privacy Design/Access Control and Feature Availability.mdx index ece6d53d38..db7b3589b1 100644 --- a/docs/Security and Privacy Design/Access Control and Feature Availability.mdx +++ b/docs/Security and Privacy Design/Access Control and Feature Availability.mdx @@ -48,7 +48,7 @@ Without authentication, anyone who can reach the Netdata dashboard could access | Multi-node views | 5 nodes | 5 nodes | Unlimited | | Custom dashboards | 1 per agent | 1 per room | Unlimited | -### Functions (Top Tab) +### Functions (Live Tab) Functions provide on-demand, detailed information beyond standard metrics. diff --git a/docs/Top Consumers/Database Queries.mdx b/docs/Top Consumers/Database Queries.mdx deleted file mode 100644 index f998017ec3..0000000000 --- a/docs/Top Consumers/Database Queries.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/functions/databases.md" -sidebar_label: "Database Queries" -learn_status: "Published" -learn_rel_path: "Top Consumers" -description: "Top and running database queries with deadlock and error attribution for 13 databases." -sidebar_position: "20" -learn_link: "https://learn.netdata.cloud/docs/top-consumers/database-queries" -slug: "/top-consumers/database-queries" ---- - -# Database Query Functions - -## Overview - -Database query functions provide deep visibility into SQL and NoSQL database performance through Netdata's Top tab. They help you identify problematic queries, detect deadlocks, and understand error patterns—all from the Netdata dashboard. - -| Capability | Description | -|------------|-------------| -| **Top Queries** | Identify the most expensive queries by execution time, I/O, rows processed, or other metrics | -| **Running Queries** | See currently executing queries in real-time | -| **Deadlock Detection** | View the latest detected deadlock with full transaction details | -| **Error Attribution** | Correlate SQL errors with the queries that caused them | - -## Supported Databases - -| Database | Top Queries | Running Queries | Deadlock Info | Error Info | Integration Docs | -|----------|:-----------:|:---------------:|:-------------:|:----------:|------------------| -| ClickHouse | ✅ | - | - | - | [ClickHouse](/docs/collecting-metrics/databases/clickhouse) | -| CockroachDB | ✅ | ✅ | - | - | [CockroachDB](/docs/collecting-metrics/databases/cockroachdb) | -| Couchbase | ✅ | - | - | - | [Couchbase](/docs/collecting-metrics/databases/couchbase) | -| Elasticsearch | ✅ | - | - | - | [Elasticsearch](/docs/collecting-metrics/databases/elasticsearch) | -| MongoDB | ✅ | - | - | - | [MongoDB](/docs/collecting-metrics/databases/mongodb) | -| Microsoft SQL Server | ✅ | - | ✅ | ✅* | [MSSQL](/docs/collecting-metrics/databases/microsoft-sql-server) | -| MySQL | ✅ | - | ✅ | ✅* | [MySQL](/docs/collecting-metrics/databases/mysql) | -| MariaDB | ✅ | - | ✅ | ✅* | [MariaDB](/docs/collecting-metrics/databases/mariadb) | -| Percona Server | ✅ | - | ✅ | ✅* | [Percona](/docs/collecting-metrics/databases/percona-mysql) | -| Oracle Database | ✅ | ✅ | - | - | [Oracle](/docs/collecting-metrics/databases/oracle-db) | -| PostgreSQL | ✅ | ✅ | - | ✅** | [PostgreSQL](/docs/collecting-metrics/databases/postgresql) | -| ProxySQL | ✅ | - | - | - | [ProxySQL](/docs/collecting-metrics/databases/proxysql) | -| Redis | ✅ | - | - | - | [Redis](/docs/collecting-metrics/databases/redis) | -| RethinkDB | - | ✅ | - | - | [RethinkDB](/docs/collecting-metrics/databases/rethinkdb) | -| YugabyteDB | ✅ | ✅ | - | - | [YugabyteDB](/docs/collecting-metrics/databases/yugabytedb) | - -*\* Error Info is integrated directly into Top Queries results—each query row shows its associated errors.* - -*\*\* PostgreSQL error info requires [pg_stat_monitor](https://docs.percona.com/pg-stat-monitor/) (Percona). The collector auto-detects and uses it when available.* - -## Function Types - -### Top Queries - -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. - -**Filter options** vary by database but typically include: -- Execution time (total, average) -- Call count -- Rows processed (read, written, returned) -- I/O metrics (logical reads, physical reads) -- Resource usage (CPU, memory, locks) - -The number of queries returned is configurable (default: 500). This is a two-stage process: -1. **Server-side**: Database returns the top N queries ranked by your chosen metric -2. **Client-side**: UI can further sort, filter, and explore the returned data - -### Running Queries - -Shows **currently executing queries** at the moment of request. Essential for diagnosing stuck queries, long-running transactions, or unexpected load. - -**Supported**: CockroachDB, Oracle, PostgreSQL, RethinkDB, YugabyteDB - -### Deadlock Info - -Displays the **most recently detected deadlock**—not a historical list. When a new deadlock occurs, it replaces the previous one. - -**Supported**: MySQL/MariaDB/Percona, Microsoft SQL Server - -Information provided: -- Deadlock timestamp and ID -- Participating transactions -- Victim transaction (rolled back) -- Query text and lock details -- Wait resource - -### Error Info - -Shows **recent SQL errors** from the database's error history. Error attribution is embedded directly in Top Queries results—each query row includes error details when available. - -**Supported**: MySQL/MariaDB/Percona, Microsoft SQL Server, PostgreSQL (with pg_stat_monitor) - -Attribution status values: -- `enabled` — Error details available for this query -- `no_data` — No recent errors for this query -- `not_enabled` — Error tracking not configured -- `not_supported` — Database version lacks required features - -## Security Considerations - -### Query Text Exposure - -Some databases normalize queries (replacing literals with placeholders), while others show actual values that may contain sensitive data: - -| Database | Query Text | -|----------|:----------:| -| ClickHouse | Normalized | -| CockroachDB | ⚠️ Raw | -| Couchbase | ⚠️ Raw | -| Elasticsearch | ⚠️ Raw | -| MongoDB | ⚠️ Raw | -| Microsoft SQL Server | ⚠️ Raw | -| MySQL/MariaDB/Percona | Normalized (Top Queries), ⚠️ Raw (Deadlock) | -| Oracle | ⚠️ Raw | -| PostgreSQL | Normalized | -| ProxySQL | Normalized | -| Redis | ⚠️ Raw | -| RethinkDB | ⚠️ Raw | -| YugabyteDB | ⚠️ Raw | - -**Legend**: -- **Normalized**: Literals replaced with placeholders (`SELECT * FROM users WHERE id = ?`) -- **⚠️ Raw**: May contain actual values (`SELECT * FROM users WHERE id = 12345`) - -:::caution - -Error messages may contain sensitive values regardless of query normalization. Ensure appropriate access controls are in place. - -::: - -### Recommendations - -1. **Disable unneeded functions** — Each integration supports configuration options to disable specific functions -2. **Use Netdata Cloud access controls** — Assign users to appropriate Rooms and Roles -3. **Use dedicated database users** — Grant only the permissions required for monitoring - -## Getting Started - -Each database requires specific setup. Click the integration link in the table above for: - -- Prerequisites and permissions required -- Configuration options -- Available metrics and columns -- Database-specific notes - -## Related Documentation - -- [Top Consumers Overview](/docs/top-consumers) -- [Processes Function](/docs/top-consumers/processes) diff --git a/docs/Top Consumers/Top Consumers.mdx b/docs/Top Consumers/Top Consumers.mdx deleted file mode 100644 index dc5c7b8b14..0000000000 --- a/docs/Top Consumers/Top Consumers.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/top-monitoring-netdata-functions.md" -sidebar_label: "Top Consumers" -learn_status: "Published" -learn_rel_path: "Top Consumers" -description: "Present the Netdata Functions what these are and why they should be used." -sidebar_position: "120" -learn_link: "https://learn.netdata.cloud/docs/top-consumers" -slug: "/top-consumers" ---- - -# Top Consumers - -Netdata Agent collectors provide on-demand, runtime executable functions on the host where they are deployed. Available since v1.37.1. - -## What is a function? - -Beyond their primary roles of collecting metrics, collectors can execute specific routines when requested. These routines provide additional diagnostic information or trigger actions directly on the host node. - -## What functions are currently available? - -| Function | Description | Alternative to CLI tools | Require Cloud | plugin - module | -|:---|:---|---|:---|:---| -| 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) | -| 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) | -| 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 | -| 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 | -| Ipmi-sensors | Readings and status of IPMI sensors. | `ipmi-sensors` | no | [freeipmi](https://github.com/netdata/netdata/tree/master/src/collectors/freeipmi.plugin#readme) | -| 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) | -| 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) | -| 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) | -| 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](https://github.com/netdata/netdata/blob/master/src/collectors/apps.plugin/README.md) | -| 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 | -| 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) | -| 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) | -| 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) | -| 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 | -| 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 | | -| Netdata-streaming | Comprehensive overview of all Netdata children instances, offering detailed information about their status, replication completion time, and many more. | | yes | | - -## How do functions work with streaming? - -When streaming is enabled, function definitions propagate from Child nodes to their Parent node. If this Parent node is connected to Netdata Cloud, it can trigger function execution on any of its connected Child nodes. - -## Why are some functions only available on Netdata Cloud? - -Some functions are exclusively available through Netdata Cloud for security reasons. Since functions can execute node-level routines that may access sensitive information, we restrict their exposure through the Agent's API. This security concern is addressed by our [ACLK](/docs/netdata-cloud/agent-cloud-link-aclk) protocol, which provides secure communication between Netdata Agent and Netdata Cloud. - -## Feedback - -If you have ideas or requests for other functions: - -- Participate in the relevant [GitHub discussion](https://github.com/netdata/netdata/discussions/14412) -- Open a [feature request](https://github.com/netdata/netdata-cloud/issues/new?assignees=&labels=feature+request%2Cneeds+triage&template=FEAT_REQUEST.yml&title=%5BFeat%5D%3A+) on Netdata Cloud repo -- Join the Netdata community on [Discord](https://discord.com/invite/2mEmfW735j) and let us know. diff --git a/ingest/generated_map.yaml b/ingest/generated_map.yaml index 4f6640f601..ec1ff7de59 100644 --- a/ingest/generated_map.yaml +++ b/ingest/generated_map.yaml @@ -5372,9 +5372,9 @@ message: DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE LOGS' metadata.yaml FILE - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/top-monitoring-netdata-functions.md - sidebar_label: Top Consumers + sidebar_label: Live View learn_status: Published - learn_rel_path: Top Consumers + learn_rel_path: Live View keywords: null description: Present the Netdata Functions what these are and why they should be used. @@ -5383,7 +5383,7 @@ - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/functions/processes.md sidebar_label: Processes learn_status: Published - learn_rel_path: Top Consumers + learn_rel_path: Live View keywords: null description: null meta_yaml: .nan @@ -5391,7 +5391,7 @@ - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/functions/databases.md sidebar_label: Database Queries learn_status: Published - learn_rel_path: Top Consumers + learn_rel_path: Live View keywords: null description: Top and running database queries with deadlock and error attribution for 13 databases. @@ -6319,12 +6319,12 @@ embedded dashboards for granular troubleshooting of ongoing issues. meta_yaml: .nan message: .nan -- custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/top-tab.md - sidebar_label: Top +- custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/live-tab.md + sidebar_label: Live learn_status: Published learn_rel_path: Dashboards and Charts/Tabs keywords: null - description: Instructions on how to use Functions + description: Access live information from monitored nodes through Netdata Functions meta_yaml: .nan message: .nan - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/themes.md diff --git a/ingest/one_commit_back_file-dict.yaml b/ingest/one_commit_back_file-dict.yaml index b4ec08b088..c4b6346dee 100644 --- a/ingest/one_commit_back_file-dict.yaml +++ b/ingest/one_commit_back_file-dict.yaml @@ -99,7 +99,7 @@ - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-enterprise-evaluation-corrected.md learn_path: /docs/welcome-to-netdata/enterprise-evaluation-guide - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/top-monitoring-netdata-functions.md - learn_path: /docs/top-consumers + learn_path: /docs/live-view - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/glossary.md learn_path: /docs/developer-and-contributor-corner/glossary - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/realtime-monitoring.md @@ -179,9 +179,9 @@ - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/getting-started-netdata/guide.md learn_path: /docs/getting-started - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/functions/processes.md - learn_path: /docs/top-consumers/processes + learn_path: /docs/live-view/processes - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/functions/databases.md - learn_path: /docs/top-consumers/database-queries + learn_path: /docs/live-view/database-queries - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/nodes-tab.md learn_path: /docs/dashboards-and-charts/tabs/nodes - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/netdata-charts.md @@ -206,8 +206,8 @@ learn_path: /docs/dashboards-and-charts/tabs/alerts - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/anomaly-advisor-tab.md learn_path: /docs/dashboards-and-charts/tabs/anomalies -- custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/top-tab.md - learn_path: /docs/dashboards-and-charts/tabs/top +- custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/live-tab.md + learn_path: /docs/dashboards-and-charts/tabs/live - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/kubernetes-tab.md learn_path: /docs/dashboards-and-charts/tabs/kubernetes - custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboards-and-charts/expanded-chart-analysis.md diff --git a/netlify.toml b/netlify.toml index 996175a41a..a3bea871ff 100644 --- a/netlify.toml +++ b/netlify.toml @@ -2085,17 +2085,13 @@ from="/docs/data-collection/monitor-anything/Any%20Application%20-%20Generic%20Collectors/Go-applications" to="/docs/collecting-metrics/applications/go-applications-expvar" -[[redirects]] - from="/docs/troubleshooting-and-machine-learning/run-time-troubleshooting-with-functions" - to="/docs/dashboards-and-charts/tabs/top" - [[redirects]] from="/docs/troubleshooting-and-machine-learning/metric-correlations" to="/docs/netdata-ai/troubleshooting/metric-correlations" [[redirects]] from="/docs/troubleshooting-and-machine-learning/functions" - to="/docs/top-consumers" + to="/docs/live-view" [[redirects]] from="/docs/troubleshooting-and-machine-learning/events-feed" @@ -3191,7 +3187,7 @@ [[redirects]] from="/docs/netdata-dashboards-and-visualizations/functions" - to="/docs/top-consumers" + to="/docs/live-view" [[redirects]] from="/docs/netdata-dashboards-and-visualizations/events-feed" @@ -3285,10 +3281,6 @@ from="/docs/metrics-streaming-and-replication" to="/docs/netdata-parents/metrics-centralization-points" -[[redirects]] - from="/docs/machine-learning-and-assisted-troubleshooting/run-time-troubleshooting-with-functions" - to="/docs/dashboards-and-charts/tabs/top" - [[redirects]] from="/docs/machine-learning-and-assisted-troubleshooting/metric-correlations" to="/docs/netdata-ai/troubleshooting/metric-correlations" @@ -4719,7 +4711,7 @@ [[redirects]] from="/docs/visualizations/functions" - to="/docs/top-consumers" + to="/docs/live-view" [[redirects]] from="/docs/visualizations/events-feed" @@ -4869,10 +4861,6 @@ from="/docs/monitor-your-infrastructure/choose-your-netdata-cloud-theme" to="/docs/dashboards-and-charts/theme" -[[redirects]] - from="/docs/ml-and-troubleshooting/run-time-troubleshooting-with-functions" - to="/docs/dashboards-and-charts/tabs/top" - [[redirects]] from="/docs/ml-and-troubleshooting/metric-correlations" to="/docs/netdata-ai/troubleshooting/metric-correlations" @@ -7311,11 +7299,7 @@ [[redirects]] from="/docs/top-monitoring" - to="/docs/top-consumers" - -[[redirects]] - from="/docs/machine-learning-and-anomaly-detection/run-time-troubleshooting-with-functions" - to="/docs/dashboards-and-charts/tabs/top" + to="/docs/live-view" [[redirects]] from="/docs/collecting-metrics/storage,-mount-points-and-filesystems/megacli-hardware-raid" @@ -7323,7 +7307,7 @@ [[redirects]] from="/docs/top-monitoring-%20netdata-functions%20/top-monitoring-netdata-functions" - to="/docs/top-consumers" + to="/docs/live-view" [[redirects]] from="/docs/netdata-cloud/role-based-access-model" @@ -7761,10 +7745,6 @@ from="/docs/dashboards-and-charts/visualization-date-and-time-controls" to="/docs/dashboards-and-charts/time-controls" -[[redirects]] - from="/docs/dashboards-and-charts/top-tab" - to="/docs/dashboards-and-charts/tabs/top" - [[redirects]] from="/docs/dashboards-and-charts/nodes-tab" to="/docs/dashboards-and-charts/tabs/nodes" @@ -8511,7 +8491,7 @@ [[redirects]] from="/docs//top-monitoring-netdata-functions" - to="/docs/top-consumers" + to="/docs/live-view" [[redirects]] from="/docs/collecting-metrics/metrics-centralization-points/replication-of-past-samples" @@ -10893,4 +10873,16 @@ from="/docs/collecting-metrics/applications/files-and-directories" to="/docs/collecting-metrics/synthetic-testing/files-and-directories" +[[redirects]] + from="/docs/top-consumers/processes" + to="/docs/live-view/processes" + +[[redirects]] + from="/docs/top-consumers/database-queries" + to="/docs/live-view/database-queries" + +[[redirects]] + from="/docs/top-consumers" + to="/docs/live-view" + # section: dynamic << END \ No newline at end of file