Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion LegacyLearnCorrelateLinksWithGHURLs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Containers and VMs/Docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/ClickHouse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/CockroachDB.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/Couchbase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/Elasticsearch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/MariaDB.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/Microsoft SQL Server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/MongoDB.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/MySQL.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/OpenSearch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/Oracle DB.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/Percona MySQL.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/PostgreSQL.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/ProxySQL.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/Redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/RethinkDB.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions docs/Collecting Metrics/Databases/SQL databases generic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -276,7 +276,7 @@ metrics:
# Set function_only: true if this job only provides functions (no metrics).
function_only: <true|false> # 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: <function_id> # REQUIRED. Unique identifier.
name: <display_name> # OPTIONAL. Derived from id if not set.
Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Databases/YugabyteDB.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Collecting Metrics/Networking/SNMP devices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Dashboards and Charts/Dashboards and Charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/Dashboards and Charts/Node Filter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

Expand Down
Original file line number Diff line number Diff line change
@@ -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**:

Expand All @@ -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 cant 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
Expand All @@ -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 |
|-------------------|------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -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 |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
4 changes: 2 additions & 2 deletions docs/Developer and Contributor Corner/Glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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).

Expand Down
Loading