@cryptotaxi247 / netdata-1 / commits / 4c96a564e

Dashboards and charts (#20162)

Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>

kanelatechnical committed Apr 23, 2025 at 15:23 UTC 4c96a564ee9f9d9061ed05bd00171dafed732c5c
10 files changed +919 -610
docs/dashboards-and-charts/README.md
+40 -21
@@ -1,38 +1,57 @@
1 # Dashboards and Charts
2
3 -This guide covers how to access both Agent and Cloud dashboards, along with links to explore specific sections in more detail.
3 +This guide explains how to access both **Agent** and **Cloud** dashboards in Netdata, with direct links to explore each section in more detail.
4
5 -When you access the Netdata dashboard through the Cloud, you'll always have the latest version available.
5 +When you access the Netdata dashboard through Cloud, you always see the latest available version.
6
7 -By default, the Agent dashboard shows the latest version (matching Netdata Cloud). However, there are a few exceptions:
7 +By default, the **Agent dashboard** also shows the latest version (matching Netdata Cloud). However, there are a few exceptions:
8
9 -- Without internet access, the Agent can't download the newest dashboards. In this case, it will automatically use the bundled version.
10 -- Users have defined, e.g., through URL bookmark that they want to see the previous version of the dashboard (accessible `http://NODE:19999/v1`, replacing `NODE` with the IP address or hostname of your Agent).
9 +- If the Agent has **no internet access**, it will automatically use the bundled dashboard version.
10 +- Users can manually load the previous dashboard version (for example, through a bookmark) using:
11 + `http://NODE:19999/v1`
12 + Replace `NODE` with the IP address or hostname of your Agent.
13
12 -## Main sections
14 +---
15 +
16 +## Main Sections
17
18 The Netdata dashboard consists of the following main sections:
19
16 -- [Home tab](/docs/dashboards-and-charts/home-tab.md)
17 -- [Nodes tab](/docs/dashboards-and-charts/nodes-tab.md)
18 -- [Netdata charts](/docs/dashboards-and-charts/netdata-charts.md)
19 -- [Metrics tab and single node tabs](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md)
20 -- [Top tab](/docs/dashboards-and-charts/top-tab.md)
21 -- [Logs tab](/docs/dashboards-and-charts/logs-tab.md)
22 -- [Dashboards tab](/docs/dashboards-and-charts/dashboards-tab.md)
23 -- [Alerts tab](/docs/dashboards-and-charts/alerts-tab.md)
24 -- [Events tab](/docs/dashboards-and-charts/events-feed.md)
20 +- [Home Tab](/docs/dashboards-and-charts/home-tab.md)
21 +- [Nodes Tab](/docs/dashboards-and-charts/nodes-tab.md)
22 +- [Netdata Charts](/docs/dashboards-and-charts/netdata-charts.md)
23 +- [Metrics Tab and Single Node Tabs](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md)
24 +- [Top Tab](/docs/dashboards-and-charts/top-tab.md)
25 +- [Logs Tab](/docs/dashboards-and-charts/logs-tab.md)
26 +- [Dashboards Tab](/docs/dashboards-and-charts/dashboards-tab.md)
27 +- [Alerts Tab](/docs/dashboards-and-charts/alerts-tab.md)
28 +- [Events Tab](/docs/dashboards-and-charts/events-feed.md)
29 +
30 +:::tip
31 +
32 +Some dashboard features require a Netdata Cloud login and a connected Agent — such as saving chart preferences, accessing custom dashboards, or executing node Functions.
33 +
34 +:::
35
26 -> **Note**
27 ->
28 -> Some dashboard sections may require the user to be signed in and have the Agent connected to Netdata Cloud for their full functionality when accessed through the Agent. Examples include saving visualization settings on charts or custom dashboards, connecting a node to Netdata Cloud, or executing functions on an Agent.
36 +---
37
30 -## How to access the dashboards?
38 +## How to Access the Dashboards
39
40 ### Netdata Cloud
41
34 -You can access the dashboard at <https://app.netdata.cloud/> and [sign-in with an account or sign-up](/docs/netdata-cloud/authentication-and-authorization/README.md) if you don't have an account yet.
42 +Access the Cloud dashboard at:
43 +**<https://app.netdata.cloud/>**
44 +
45 +[Sign in or sign up](https://app.netdata.cloud/sign-in) if you don’t have an account yet.
46 +
47 +---
48
49 ### Netdata Agent
50
38 -To view your Netdata dashboard, open a web browser and enter the address `http://NODE:19999` - replace `NODE` with your Agent's IP address or hostname. If the Agent is on the same machine, use `http://localhost:19999`.
51 +To view your local Netdata Agent dashboard:
52 +
53 +- Open a browser and go to:
54 + `http://NODE:19999`
55 + Replace `NODE` with your Agent’s IP address or hostname.
56 +- If viewing from the same machine where the Agent is installed, use:
57 + `http://localhost:19999`
\ No newline at end of file
docs/dashboards-and-charts/alerts-tab.md
+116 -36
@@ -1,58 +1,138 @@
1 -# Alerts tab
1 +# Alerts Tab
2
3 -Netdata comes with hundreds of pre-configured health alerts designed to notify you when an anomaly or performance issue affects your node or its applications.
3 +Netdata provides hundreds of pre-configured health alerts to notify you when an anomaly or performance issue affects your node or its applications.
4
5 -## Active tab
5 +---
6
7 -From the Active tab, you can see all the active alerts in your Room. You will be presented with a table having information about each alert that is in warning or critical state.
7 +## Raised Alerts Tab
8
9 -You can always sort the table by a certain column by clicking on the name of that column, and using the gear icon on the top right to control which columns are visible at any given time.
9 +The **Raised Alerts** tab shows all current alerts in your Room that are in a **warning** or **critical** state.
10
11 -### Filter alerts
11 +### Alert Table Overview
12
13 -From this tab, you can also filter alerts with the right-hand bar. More specifically, you can filter:
13 +The table provides key details about each active alert:
14
15 -- **Alert status**: Filter based on the status of the alerts (e.g., Warning, Critical)
16 -- **Alert class**: Filter based on the class of the alert (e.g., Latency, Utilization, Workload, etc.)
17 -- **Alert type & component**: Filter based on the alert's type (e.g., System, Web Server) and component (e.g., CPU, Disk, Load)
18 -- **Alert role**: Filter by the role that the alert is set to notify (e.g., Sysadmin, Webmaster etc.)
19 -- **Host labels**: Filter based on the host labels that are configured for the nodes across the Room (e.g., `_cloud_instance_region` to match `us-east-1`)
20 -- **Node status**: Filter by node availability status (e.g., Live or Offline)
21 -- **Netdata version**: Filter by Netdata version (e.g., `v1.45.3`)
22 -- **Nodes**: Filter the alerts based on the nodes of your Room.
15 +| Column | Description |
16 +|----------------------|----------------------------------------------------------------------|
17 +| **Alert Name** | The name of the alert; click to view alert details. |
18 +| **Status** | Current state: Warning or Critical. |
19 +| **Class** | The alert's class (e.g., Latency, Utilization). |
20 +| **Type & Component** | The system type and component involved. |
21 +| **Role** | The notification role assigned to the alert. |
22 +| **Node Name** | The node where the alert was triggered. |
23 +| **Silencing Rule** | Whether silencing rules are applied. |
24 +| **Actions** | Options to create silencing rules or ask Netdata Assistant for help. |
25
24 -### View alert details
26 +Use the **gear icon** (top right) to control which columns are visible. Sort alerts by clicking on column headers.
27
26 -By clicking on the name of an entry of the table, you can access that alert's details page, providing you with:
28 +---
29
28 -- Latest and Triggered time values
29 -- The alert's description
30 -- A link to the Netdata Advisor's page about this alert
31 -- The chart at the time frame that the alert was triggered
32 -- The alert's information: Node name, chart instance, type, component and class
33 -- Configuration section
34 -- Instance values - Node Instances
30 +## Filtering Alerts
31
36 -At the bottom of the panel you can click the green button "View alert page" to open a dynamic tab containing all the info for this alert in a tab format, where you can also run correlations and go to the node's chart that raised the particular alert.
32 +Filter the alert list using the right-hand bar:
33
38 -### Silence an alert
34 +| Filter Option | Purpose |
35 +|----------------------------|----------------------------------------------------------------------------------|
36 +| **Alert Status** | Filter by status (Warning, Critical). |
37 +| **Alert Class** | Filter by class (e.g., Latency, Utilization). |
38 +| **Alert Type & Component** | Filter by alert type (e.g., System, Web Server) and component (e.g., CPU, Disk). |
39 +| **Alert Role** | Filter by the notification role (e.g., Sysadmin, Webmaster). |
40 +| **Host Labels** | Filter by host labels (e.g., `_cloud_instance_region=us-east-1`). |
41 +| **Node Status** | Filter by node availability (Live, Offline). |
42 +| **Netdata Version** | Filter by the Netdata version. |
43 +| **Nodes** | Filter by specific nodes. |
44
40 -From this tab, the "Silencing" column shows if there is any rule present for each alert, and from the "Actions" column you can create a new [silencing rule](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#alert-notification-silencing-rules) for this alert, or get help and information about this alert from the [Netdata Assistant](/docs/netdata-assistant.md).
45 +---
46
42 -## Alert Configurations tab
47 +## Viewing Alert Details
48
44 -From this tab, you can view all the configurations for all running alerts in your Room. Each row concerns one alert, and it provides information about it in the rest of the table columns.
49 +Click on an alert name to open the **alert details page**, which provides:
50
46 -By running alerts, we mean alerts that are related to some metric that is or was collected. Netdata may have more alerts pre-configured that aren't applicable to your monitoring use-cases.
51 +| Section | Description |
52 +|------------------------------|--------------------------------------------------------------|
53 +| **Latest / Triggered Time** | Shows when the alert was last triggered. |
54 +| **Description** | Includes a detailed explanation of the alert. |
55 +| **Netdata Advisor Link** | Links to related Netdata Advisor guidance. |
56 +| **Triggered Chart Snapshot** | Visualizes the chart at the alert’s trigger time. |
57 +| **Alert Metadata** | Shows node name, chart instance, type, component, and class. |
58 +| **Configuration** | Displays the alert's configuration parameters. |
59 +| **Instance Values** | Provides node instance details. |
60
48 -You can control which columns are visible by using the gear icon on the right-hand side.
61 +At the bottom of this page, click **View alert page** to open a dynamic view where you can:
62
50 -Similarly to the previous tab, you can see the silencing status of an alert, while also being able to dig deeper and show the configuration for the alert and ask the [Netdata Assistant](/docs/netdata-assistant.md) for help.
63 +- Run metric correlations.
64 +- Navigate to the specific node’s chart that triggered the alert.
65
52 -### See the configuration for an alert
66 +---
67
54 -From the actions column you can explore the alert's configuration, split by the different nodes that have this alert configured.
68 +## Silencing Alerts
69
56 -From there, you can click on any of the rows to get to the individual alert configurations for that node.
70 +In the **Raised Alerts** tab:
71
58 -Click on an alert row to see the alert's page, with all the information about when it was last triggered, and what its configuration is.
72 +- The **Silencing column** shows whether a silencing rule exists for an alert.
73 +- The **Actions column** allows you to:
74 + - Create a new [silencing rule](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#alert-notification-silencing-rules).
75 + - Ask for help from the [Netdata Assistant](/docs/netdata-assistant.md).
76 +
77 +---
78 +
79 +## Alert Configurations Tab
80 +
81 +The **Alert Configurations** tab shows the configuration of all running alerts in your Room.
82 +
83 +:::note
84 +
85 +"Running alerts" are alerts attached to metrics that are actively being collected. Pre-configured alerts that do not match your setup may not appear here.
86 +
87 +:::
88 +
89 +### Configuration Table Overview
90 +
91 +| Column | Description |
92 +|--------------------|-----------------------------------------------------|
93 +| **Alert Name** | The name of the alert; click to view configuration. |
94 +| **Node Name** | The node where this configuration applies. |
95 +| **Status** | Whether the alert is active or silenced. |
96 +| **Silencing Rule** | Indicates if silencing rules are applied. |
97 +| **Actions** | Explore configuration or ask the Netdata Assistant. |
98 +
99 +Use the **gear icon** to adjust which columns are displayed.
100 +
101 +---
102 +
103 +## Viewing Alert Configuration
104 +
105 +From the **Actions column**, click **Show Configuration** to:
106 +
107 +| Action | Outcome |
108 +|---------------------|--------------------------------------------------------------|
109 +| **Explore by Node** | View configurations split by node. |
110 +| **View Alert Page** | See full alert details, including configuration and history. |
111 +
112 +This allows you to investigate:
113 +
114 +- When the alert last triggered.
115 +- All configuration parameters per node.
116 +
117 +---
118 +
119 +## Alert Lifecycle Diagram
120 +
121 +```mermaid
122 +graph TD
123 + A[Metric Collection] --> B[Alert Evaluation]
124 + B --> C{Condition Met}
125 + C -- Yes --> D[Trigger Alert]
126 + D --> E[Alert in Raised Alerts Tab]
127 + E --> F[Details and Chart Snapshot]
128 + E --> G[Apply Silencing Rule]
129 + F --> H[Explore Metrics<br/>Run Correlations]
130 + G --> I[No Notification Sent]
131 + C -- No --> J[No Alert Triggered]
132 +```
133 +
134 +:::tip
135 +
136 +The diagram above illustrates the flow of alert detection and management, from metric collection to alert evaluation, triggering, and optional silencing.
137 +
138 +:::
\ No newline at end of file
docs/dashboards-and-charts/anomaly-advisor-tab.md
+56 -14
@@ -1,26 +1,68 @@
1 -# Anomaly Advisor tab
1 +# Anomaly Advisor Tab
2
3 -The Anomaly Advisor tab lets you focus on potentially anomalous metrics and charts related to a particular highlighted window of interest. In addition to this tab, each chart in the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) also has an [Anomaly Rate ribbon](/docs/dashboards-and-charts/netdata-charts.md#anomaly-rate-ribbon).
3 +The **Anomaly Advisor** tab helps you identify potentially anomalous metrics and charts by focusing on a highlighted timeframe of interest. This feature uses Netdata's **Anomaly Rate ML scoring** to rank metrics based on unusual behavior.
4
5 -More details about configuration can be found in the [ML documentation](/src/ml/README.md).
5 +Each chart in the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) also features an [Anomaly Rate ribbon](/docs/dashboards-and-charts/netdata-charts.md#anomaly-rate-ribbon) for anomaly visibility.
6
7 -This tab uses our [Anomaly Rate ML feature](/src/ml/README.md#anomaly-bit) to score metrics in terms of anomalous behavior.
7 +For configuration details, see the [ML documentation](/src/ml/README.md).
8
9 -- The "Anomaly Rate" chart shows the percentage of anomalous metrics over time per node.
9 +---
10
11 -- The "Count of Anomalous Metrics" chart shows raw counts of anomalous metrics per node so may often be similar to the Anomaly Rate chart, apart from where nodes may have different numbers of metrics.
11 +## How Anomaly Advisor Works
12
13 -- The "Anomaly Events Detected" chart shows whether the anomaly rate per node has increased enough to cause a node-level anomaly. Anomaly events will appear slightly after the anomaly rate starts to increase in the timeline, this is because a significant number of metrics in the node need to be anomalous before an anomaly event is triggered.
13 +The Anomaly Advisor leverages Netdata’s machine learning to evaluate anomaly rates across your nodes. It provides three key visualizations:
14
15 -Once you have highlighted a window of interest, you should see an ordered list of charts, with the Anomaly Rate being displayed as a purple ribbon in the chart.
15 +| Chart Name | Purpose | Why It Matters |
16 +|--------------------------------|-------------------------------------------------------------------|----------------------------------------------------------------|
17 +| **Anomaly Rate** | Shows the percentage of anomalous metrics over time per node. | Helps you quickly spot nodes behaving abnormally. |
18 +| **Count of Anomalous Metrics** | Displays raw counts of anomalous metrics per node. | Useful when nodes have different numbers of collected metrics. |
19 +| **Anomaly Events Detected** | Indicates when the anomaly rate has triggered a node-level event. | Focuses your attention on meaningful spikes, not just noise. |
20
17 -> **Tip**
18 ->
19 -> You can also use the [node filter](/docs/dashboards-and-charts/node-filter.md) to select which nodes you want to include or exclude.
21 +:::note
22
21 -The right side of the page displays an anomaly index for the highlighted timeline of interest. The index is sorted from most anomalous (highest level of anomaly) to least (lowest level of anomaly). Clicking on an entry in the index will get you to the corresponding chart for the anomalous metric.
23 +**Anomaly Events Detected** appear slightly after anomaly rates rise, as they require a significant portion of metrics on the node to show anomalous behavior.
24 +
25 +:::
26 +
27 +---
28 +
29 +## Workflow Overview
30 +
31 +1. **Highlight a timeframe of interest** on the anomaly charts.
32 +2. An ordered list of related charts appears, ranked by anomaly level.
33 +3. The **Anomaly Rate ribbon** (purple) is visible on each chart.
34 +4. Use the right-hand anomaly index to sort metrics from most to least anomalous.
35 +5. Click an entry in the index to navigate directly to the corresponding chart.
36 +
37 +:::tip
38 +
39 +Use the [node filter](/docs/dashboards-and-charts/node-filter.md) to focus on specific nodes before highlighting a timeframe.
40 +
41 +:::
42 +
43 +---
44
45 ## Usage Tips
46
25 -- If you are interested in a subset of specific nodes, then filtering to just those nodes before highlighting is recommended to get better results. When you highlight a timeframe, Netdata will ask the Agents for a ranking across all metrics, so if there is a subset of nodes, there will be less "averaging" going on, and you'll get a less noisy ranking.
26 -- Ideally, try and highlight close to a spike or window of interest so that the resulting ranking can narrow-in more easily on the timeline you are interested in.
47 +| Tip | Why It Matters |
48 +|-----------------------------------------------|------------------------------------------------------------------|
49 +| Filter to specific nodes before highlighting. | Reduces noise by limiting averaging across unrelated nodes. |
50 +| Highlight close to the anomaly spike. | Improves ranking accuracy by focusing on the relevant timeframe. |
51 +
52 +---
53 +
54 +## Anomaly Advisor Diagram
55 +
56 +```mermaid
57 +graph TD
58 + A[Highlight **Timeframe**] --> B[**Rank** Metrics by Score]
59 + B --> C[Show Ordered Charts]
60 + C --> D[**Pick** from Anomaly Index]
61 + D --> E[**Investigate** Metrics]
62 +```
63 +
64 +:::tip
65 +
66 +This diagram shows the Anomaly Advisor flow: highlight, rank, and explore. Use the ranking to prioritize which charts to investigate.
67 +
68 +:::
\ No newline at end of file
docs/dashboards-and-charts/dashboards-tab.md
+108 -55
@@ -1,96 +1,149 @@
1 -# Dashboards tab
1 +# Dashboards Tab
2
3 -With Netdata Cloud, you can build **custom dashboards** that target your infrastructure's unique needs. Put key metrics from any number of distributed systems in one place for a bird's eye view of your infrastructure.
3 +With **Netdata Cloud**, you can build **custom dashboards** that target your infrastructure’s unique needs. Dashboards help you centralize key metrics from any number of distributed systems, offering a clear, interactive overview of your infrastructure.
4
5 -Click on the **Dashboards** tab in any Room to get started.
5 +Click the **Dashboards** tab in any Room to get started.
6
7 -## Create your first dashboard
7 +---
8
9 -From the Dashboards tab, click on the **+** button.
9 +## Create Your First Dashboard
10
11 -In the modal, give your custom dashboard a name, and click **+ Add**.
11 +To create a new dashboard:
12
13 -- The **Add Chart** button on the top right of the interface adds your first chart card. From the dropdown, select either **All Nodes** or a specific node.
13 +1. From the **Dashboards** tab, click the **+** button.
14 +2. In the modal, enter a name for your dashboard and click **+ Add**.
15
15 - Next, select the context. You'll see a preview of the chart before you finish adding it. In this modal you can also [interact with the chart](/docs/dashboards-and-charts/netdata-charts.md), meaning you can configure all the aspects of the [NIDL framework](/docs/dashboards-and-charts/netdata-charts.md#nidl-framework) of the chart and more in detail, you can:
16 - - define which `group by` method to use
17 - - select the aggregation function over the data source
18 - - select nodes
19 - - select instances
20 - - select dimensions
21 - - select labels
22 - - select the aggregation function over time
16 +You can now add elements to your dashboard:
17
24 - After you are done configuring the chart, you can also change the type of the chart from the right-hand side of the [Title bar](/docs/dashboards-and-charts/netdata-charts.md#title-bar), and select which of the final dimensions you want to be visible and in what order, from the [Dimensions bar](/docs/dashboards-and-charts/netdata-charts.md#dimensions-bar).
18 +### Add a Chart
19
26 -- The **Add Text** button on the top right of the interface creates a new card with user-defined text, which you can use to describe or document a particular dashboard's meaning and purpose.
20 +Click the **Add Chart** button at the top right of the dashboard.
21
28 -> ### Important
29 ->
30 -> Be sure to click the **Save** button any time you make changes to your dashboard.
22 +| Step | Action |
23 +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
24 +| **Select Source** | Choose **All Nodes** or a specific node. |
25 +| **Choose Context** | Select the metric context. A preview of the chart will appear. |
26 +| **Configure Chart** | Adjust settings using the [NIDL framework](/docs/dashboards-and-charts/netdata-charts.md#nidl-framework): <br/>- Group by method <br/>- Aggregation function over the data source <br/>- Nodes <br/>- Instances <br/>- Dimensions <br/>- Labels <br/>- Aggregation function over time |
27 +| **Chart Type** | Change the chart type using the [Title bar](/docs/dashboards-and-charts/netdata-charts.md#title-bar). |
28 +| **Dimension Visibility** | Select which dimensions to display and set their order via the [Dimensions bar](/docs/dashboards-and-charts/netdata-charts.md#dimensions-bar). |
29
32 -## Using your dashboard
30 +### Add Text Cards
31
34 -Dashboards are designed to be interactive and flexible so you can design them to your needs. They are made from any number of charts and cards, which can contain charts or text.
32 +Click the **Add Text** button at the top right to add a text card.
33
36 -### Charts
34 +Use text cards to:
35
38 -The charts you add to any dashboard are [fully interactive](/docs/dashboards-and-charts/netdata-charts.md), just like any other Netdata chart. You can zoom in and out, highlight timeframes, and more.
36 +- Document the purpose of the dashboard.
37 +- Add notes for your team members.
38
40 -Charts also synchronize as you interact with them, even across contexts _or_ nodes.
39 +:::tip
40
42 -### Text cards
41 +Click the **T** icon in the text box to switch between font sizes.
42
44 -You can use text cards as notes to explain to other members of the [Room](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#rooms) the purpose of the dashboard's arrangement.
43 +:::
44
46 -By clicking the `T` icon on the text box, you can switch between font sizes.
45 +:::important
46
48 -### Move elements
47 +Always click the **Save** button after making changes to your dashboard.
48
50 -To move a chart or a card, click and hold on **Drag & drop** at the top right of each element and drag it to a new location. A green placeholder indicates the
51 -new location. Once you release your mouse, other elements re-sort to the grid system automatically.
49 +:::
50
53 -### Resize elements
51 +---
52
55 -To resize any element on a dashboard, click in the bottom-right corner and drag it to its new size. Other elements re-sort to the grid system automatically.
53 +## Dashboard Layout Overview
54
57 -### Go to chart
55 +```mermaid
56 +graph TD
57 + A[Dashboard Grid]
58 + A --> B[Chart Element]
59 + A --> C[Text Card]
60 + B --> D[Move / Resize]
61 + C --> D
62 + D --> E[Save Changes]
63 + B --> F[Delete Option]
64 + C --> F
65 +```
66
59 -Quickly jump to the location of the chart in either the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) or if the chart refers to a single node, its single node dashboard by clicking the 3-dot icon in the corner of any chart to open a menu. Hit the **Go-to-Chart** item.
67 +:::tip
68
61 -You'll land directly on that chart of interest, but you can now scroll up and down to correlate your findings with other
62 -charts. Of course, you can continue to zoom, highlight, and pan through time just as you're used to with Netdata Charts.
69 +The diagram above shows how charts and text cards interact within the dashboard layout. Use **drag & drop to move elements and resize** them as needed. Save your layout to keep changes. Remove elements using the delete option.
70
64 -### Rename a chart
71 +:::
72
66 -Using the 3-dot icon in the corner of any chart, you can rename it to better explain your use case or the visualization settings you've chosen for the chart.
73 +:::tip
74
68 -### Remove an individual element
75 +Keep related charts close together to improve visual correlation between metrics.
76
70 -Click on the 3-dot icon in the corner of any card to open a menu. Click the **Remove** item to remove the card.
77 +:::
78
72 -## Managing your dashboard
79 +---
80
74 -To see dashboards associated with the current Room, click the **Dashboards** tab in any Room. You can select dashboards and delete them using the 🗑️ icon.
81 +## Using Your Dashboard
82
76 -### Update/save a dashboard
83 +Dashboards are interactive and flexible. You can design them to fit your needs using any combination of charts and text cards.
84
78 -If you've made changes to a dashboard, such as adding or moving elements, the **Save** button is enabled. Click it to save your most recent changes.
85 +### Chart Interaction
86
80 -Any other members of the Room will be able to see these changes the next time they load this dashboard.
87 +Charts on custom dashboards are [fully interactive](/docs/dashboards-and-charts/netdata-charts.md):
88
82 -If multiple users attempt to make concurrent changes to the same dashboard, the second user who hits Save will be
83 -prompted to either overwrite the dashboard or reload to see the most recent changes.
89 +- Zoom, pan, and highlight timeframes.
90 +- Synchronize charts across contexts and nodes.
91
85 -### Delete a dashboard
92 +### Text Cards
93
87 -Delete any dashboard by navigating to it and clicking the **Delete** button. This will remove this entry from the
88 -dropdown for every member of this Room.
94 +Text cards allow you to explain the arrangement or intent behind the dashboard. Share insights with your team directly on the dashboard.
95
90 -### Minimum browser viewport
96 +---
97
92 -Because of the visual complexity of individual charts, dashboards require a minimum browser viewport of 800px.
98 +## Organizing Dashboard Elements
99
94 -## What's next?
100 +### Move Elements
101
96 -Once you've designed a dashboard or two, make sure to [invite your team](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#team-collaboration) if you haven't already. You can add these new users to the same Room to let them see the same dashboards without any effort.
102 +| Action | How to Do It |
103 +|--------------------------|-------------------------------------------------------------------------------------------------|
104 +| **Move a chart or card** | Click and hold **Drag & drop** at the top right of the element, then move it to a new location. |
105 +| **Resize an element** | Click and drag from the bottom-right corner of the element. |
106 +
107 +:::tip
108 +
109 +Elements automatically align to the grid system after moving or resizing.
110 +
111 +:::
112 +
113 +---
114 +
115 +## Chart Management Actions
116 +
117 +| Action | How to Perform |
118 +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
119 +| **Go to chart** | Use the 3-dot icon on any chart → click **Go-to-Chart**. Navigate directly to the chart in the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) or the single-node dashboard. |
120 +| **Rename a chart** | Use the 3-dot icon on any chart → click **Rename**. |
121 +| **Remove a chart or card** | Use the 3-dot icon on the element → click **Remove**. |
122 +
123 +---
124 +
125 +## Managing Your Dashboard
126 +
127 +| Action | How to Perform |
128 +|------------------------|-----------------------------------------------------------------|
129 +| **View dashboards** | Click the **Dashboards** tab in any Room. |
130 +| **Delete a dashboard** | Select the dashboard → click the 🗑️ icon or **Delete** button. |
131 +| **Save changes** | Click the **Save** button after making any edits. |
132 +
133 +:::note
134 +
135 +If multiple users edit the same dashboard at once, the second user who clicks **Save** will be prompted to either overwrite or reload the dashboard to see the latest changes.
136 +
137 +:::
138 +
139 +---
140 +
141 +## Minimum Browser Viewport Requirement
142 +
143 +Due to the visual complexity of individual charts, dashboards require a **minimum browser viewport width of 800px**.
144 +
145 +---
146 +
147 +## Next Steps
148 +
149 +After designing your dashboards, [invite your team](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#team-collaboration) to collaborate. Add new users to the same Room so they can view and interact with your dashboards effortlessly.
\ No newline at end of file
docs/dashboards-and-charts/events-feed.md
+98 -74
@@ -1,74 +1,98 @@
1 -# Events tab
2 -
3 -The Events tab provides a feed which is a powerful feature that tracks events that happen on your infrastructure, or in your Space. The feed lets you investigate events that occurred in the past, which is invaluable for troubleshooting. Common use cases are ones like when a node goes offline, and you want to understand what events happened before that. A detailed event history can also assist in attributing sudden pattern changes in a time series to specific changes in your environment.
4 -
5 -## What are the available events?
6 -
7 -At a high-level view, these are the domains from which the Events feed will provide visibility into.
8 -
9 -> **Note**
10 ->
11 -> Based on your space's plan, different allowances are defined to query past data.
12 -
13 -| **Domains of events** | **Community** | **Homelab** | **Business** | **Enterprise On-Premise** |
14 -|:------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:------------|:-------------|:--------------------------|
15 -| **[Auditing events](#auditing-events)** <p>Events related to actions done on your Space, e.g. invite user, change user role or change plan.</p> | 4 hours | 90 days | 90 days | User dependent |
16 -| **[Topology events](#topology-events)** <p>Node state transition events, e.g. live or offline.</p> | 4 hours | 14 days | 14 days | User dependent |
17 -| **[Alert events](#alert-events)** <p>Alert state transition events, can be seen as an alert history log.</p> | 4 hours | 90 days | 90 days | User dependent |
18 -
19 -### Auditing events
20 -
21 -| **Event name** | **Description** | **Example** |
22 -|:------------------------------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------|
23 -| Space Created | The space was created. | Space `Acme Space` was **created** |
24 -| Room Created | A Room was created on the Space. | Room `DB Servers` was **created** by `John Doe` |
25 -| Room Deleted | A Room was deleted from the Space. | Room `DB servers` was **deleted** by `John Doe` |
26 -| User Invited to Space | A user was invited to join the Space. | User `John Smith` was **invited** to this space by `Alan Doe` |
27 -| User Uninvited from Space | An invitation for a user to join the space was revoked. | User `John Smith` was **uninvited** from this space |
28 -| User Added to Space | A user was added to the Space from an invitation (user accepted the invitation). | User `John Smith` was **added** to this space by invite of `Alan Doe` |
29 -| User Removed from Space | A user was added to the Space from an invitation. | User `John Smith` was **removed** from this space by `Alan Doe` |
30 -| User Added to Room | A user was added to a Room on the Space. | User `John Smith` was **added** to Room `DB servers` |
31 -| User Removed from Room | A user was removed from a Room on the Space. | User `John Smith` was **removed** from Room `DB Servers` by `Alan Doe` |
32 -| User Space Properties Changed | The properties of a user on the Space have changed, e.g. change user role | User role for `John Smith` was **changed** to `troubleshooter` by `Alan Doe` |
33 -| Node Added To Room | The node was added to a Room on the Space. | Node `ip-xyz.ec2.internal` was **added** to Room `DB Servers` by `John Doe` |
34 -| Node Removed To Room | The node was removed from a Room on the Space. | Node `ip-xyz.ec2.internal` was **removed** from Room `DB Servers` by `John Doe` |
35 -| Silencing Rule Created | A new alert notification silencing rule was created on the Space. | Silencing rule `DB Servers schedule silencing` on Rooms `All nodes` and `DB Servers` was **created** by `John Smith` |
36 -| Silencing Rule Changed | An existing alert notification silencing rule was modified on the Space. | Silencing rule `DB Servers schedule silencing` on Rooms `All nodes` and `DB Servers` was **changed** by `John Doe` |
37 -| Silencing Rule Deleted | An existing alert notifications silencing rule was removed from the Space. | Silencing rule `DB Servers schedule silencing` on Rooms `All nodes` and `DB Servers` was **changed** by `Alan Smith` |
38 -| Space Claiming Token Created | A Space Claiming Token was created. | Claiming Token was created by user `John Doe` |
39 -| Space Claiming Token Revoked | A Space Claiming Token was revoked. | Claiming Token `_OtF2ssjrv` was revoked by user `John Doe` |
40 -
41 -### Topology events
42 -
43 -| **Event name** | **Description** | **Example** |
44 -|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------|
45 -| Node Became Live | The node is collecting and streaming metrics to Cloud. | Node `netdata-k8s-state-xyz` was **live** |
46 -| Node Became Stale | The node is offline and not streaming metrics to Cloud. It can show historical data from a parent node. | Node `ip-xyz.ec2.internal` was **stale** |
47 -| Node Became Offline | The node is offline, not streaming metrics to Cloud and not available in any parent node. | Node `ip-xyz.ec2.internal` was **offline** |
48 -| Node Created | The node is created but it is still `Unseen` on Cloud, didn't establish a successful connection yet. | Node `ip-xyz.ec2.internal` was **created** |
49 -| Node Removed | The node was removed from the Space, for example by using the `Delete` action on the node. This is a soft delete in that the node gets marked as deleted, but retains the association with this space. If it becomes live again, it will be restored (see `Node Restored` below) and reappear in this space as before. | Node `ip-xyz.ec2.internal` was **deleted (soft)** |
50 -| Node Restored | The node was restored. See `Node Removed` above. | Node `ip-xyz.ec2.internal` was **restored** |
51 -| Node Deleted | The node was deleted from the Space. This is a hard delete and no information on the node is retained. | Node `ip-xyz.ec2.internal` was **deleted (hard)** |
52 -| Agent Connected | The Agent connected to the Cloud MQTT server (Agent-Cloud Link established).<br/>These events can only be seen on _All nodes_ Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has connected to Cloud. |
53 -| Agent Disconnected | The Agent disconnected from the Cloud MQTT server (Agent-Cloud Link severed).<br/>These events can only be seen on _All nodes_ Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has disconnected from Cloud: **Connection Timeout**. |
54 -| Space Statistics | Daily snapshot of space node statistics.<br/>These events can only be seen on _All nodes_ Room. | Space statistics. Nodes: **22 live**, **21 stale**, **18 removed**, **61 total**. |
55 -
56 -### Alert events
57 -
58 -| **Event name** | **Description** | **Example** |
59 -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60 -| Node Alert State Changed | These are node alert state transition events and can be seen as an alert history log. You will be able to see transitions to or from any of these states: Cleared, Warning, Critical, Removed, Error or Unknown | Transition to Cleared:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` recovered with value **8.33%**<br/><br/>Transition from Cleared to Warning or Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was raised to **WARNING** with value **10%**<br/><br/>Transition from Warning to Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` escalated to **CRITICAL** with value **25%**<br/><br/>Transition from Critical to Warning:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was demoted to **WARNING** with value **10%**<br/><br/>Transition to Removed:<br/>Alert `httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` is no longer available, state can't be assessed.<br/><br/>Transition to Error:<br/>For this alert `httpcheck_web_service_bad_status` related to `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` we couldn't calculate the current value ⓘ |
61 -
62 -## Who can access the events?
63 -
64 -All users will be able to see events from the Topology and Alerts domain, but Auditing events, once these are added, will only be accessible to administrators. For more details, check the [Netdata Role-Based Access model](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md).
65 -
66 -## How to use the events feed
67 -
68 -1. Click on the **Events** tab (located near the top of your screen)
69 -2. You will be presented with a table listing the events that occurred from the timeframe defined on the [date time picker](/docs/dashboards-and-charts/visualization-date-and-time-controls.md#date-and-time-selector)
70 -3. You can use the filtering capabilities available on the right-hand bar to slice through the results provided
71 -
72 -> **Note**
73 ->
74 -> When you try to query a longer period than what your space allows, you will see an error message highlighting that you are querying data outside your plan.
1 +# Events Tab
2 +
3 +The **Events tab** provides a powerful feed that tracks key activities across your infrastructure and Space. It helps you investigate historical events, making it easier to correlate changes with anomalies or node behavior.
4 +
5 +Use the Events feed to:
6 +
7 +- Quickly identify what happened before or after a node went offline.
8 +- Attribute sudden metric changes to specific environment events.
9 +- Access a detailed history of alert transitions and node state changes.
10 +
11 +:::note
12 +
13 +Based on your Space plan, the time range available for querying past events may vary.
14 +
15 +:::
16 +
17 +---
18 +
19 +## Available Event Domains
20 +
21 +The Events feed provides visibility into the following event types:
22 +
23 +| **Event Domain** | **Community** | **Homelab** | **Business** | **Enterprise On-Premise** |
24 +|-----------------------------------------|---------------|-------------|--------------|---------------------------|
25 +| **[Auditing events](#auditing-events)** | 4 hours | 90 days | 90 days | User-dependent |
26 +| **[Topology events](#topology-events)** | 4 hours | 14 days | 14 days | User-dependent |
27 +| **[Alert events](#alert-events)** | 4 hours | 90 days | 90 days | User-dependent |
28 +
29 +---
30 +
31 +## Auditing Events
32 +
33 +These events log user actions and Space configuration changes:
34 +
35 +| **Event Name** | **Description** | **Example** |
36 +|-------------------------|------------------------------------------|---------------------------------------------------------------------------------|
37 +| Space Created | A new Space was created. | Space `Acme Space` was **created**. |
38 +| Room Created | A Room was added to the Space. | Room `DB Servers` was **created** by `John Doe`. |
39 +| Room Deleted | A Room was removed from the Space. | Room `DB Servers` was **deleted** by `John Doe`. |
40 +| User Invited to Space | A user was invited to join the Space. | User `John Smith` was **invited** by `Alan Doe`. |
41 +| User Removed from Space | A user was removed from the Space. | User `John Smith` was **removed** by `Alan Doe`. |
42 +| Silencing Rule Created | A new silencing rule was added. | Silencing rule `DB Servers schedule silencing` was **created** by `John Smith`. |
43 +| Silencing Rule Changed | An existing silencing rule was modified. | Silencing rule was **changed** by `John Doe`. |
44 +| Silencing Rule Deleted | A silencing rule was removed. | Silencing rule was **deleted** by `Alan Smith`. |
45 +
46 +---
47 +
48 +## Topology Events
49 +
50 +These events track changes to node connectivity and state:
51 +
52 +| **Event Name** | **Description** | **Example** |
53 +|---------------------|--------------------------------------------------|---------------------------------------------------------|
54 +| Node Became Live | Node started streaming metrics to Cloud. | Node `netdata-k8s-state-xyz` is **live**. |
55 +| Node Became Offline | Node stopped streaming metrics, fully offline. | Node `ip-xyz.ec2.internal` is **offline**. |
56 +| Node Created | Node was created but not yet seen by Cloud. | Node `ip-xyz.ec2.internal` was **created**. |
57 +| Node Deleted | Node was hard deleted from the Space. | Node `ip-xyz.ec2.internal` was **deleted (hard)**. |
58 +| Agent Connected | Agent connected to the Cloud server (MQTT link). | Agent `7d87bqs9-cv42-4823-8sd4-3614548850c7` connected. |
59 +| Agent Disconnected | Agent disconnected from the Cloud server. | Agent disconnected due to **Connection Timeout**. |
60 +
61 +---
62 +
63 +## Alert Events
64 +
65 +These events log alert state transitions for node metrics:
66 +
67 +| **Event Name** | **Description** | **Example** |
68 +|--------------------------|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
69 +| Node Alert State Changed | Records state changes such as Cleared, Warning, Critical, Removed, Error, or Unknown. | Alert `httpcheck_web_service_bad_status` on node `netdata-parent-xyz` escalated to **CRITICAL** with value **25%**. |
70 +
71 +---
72 +
73 +## Who Can Access Events?
74 +
75 +| **User Role** | **Event Domains Accessible** |
76 +|--------------------|-------------------------------------------------|
77 +| Administrators | All event domains (Auditing, Topology, Alerts). |
78 +| Non-administrators | Topology and Alerts only. |
79 +
80 +:::note
81 +
82 +See the [Role-Based Access model](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md) for details.
83 +
84 +:::
85 +
86 +---
87 +
88 +## How to Use the Events Feed
89 +
90 +1. Click the **Events** tab.
91 +2. Define the timeframe using the [Date and Time selector](/docs/dashboards-and-charts/visualization-date-and-time-controls.md#date-and-time-selector).
92 +3. Apply filters from the right-hand bar, such as **event domain**, **node**, **alert severity**, or **time range**, to focus on the data you need.
93 +
94 +:::note
95 +
96 +If your query exceeds the retention limits of your plan, an error will indicate that the requested data is outside your allowed timeframe.
97 +
98 +:::
\ No newline at end of file
docs/dashboards-and-charts/home-tab.md
+14 -54
@@ -1,60 +1,20 @@
1 # Home tab
2
3 -The Home tab allows users to see an overview of their Room.
3 +The **Home tab** offers a **real-time overview of your Room** in Netdata Cloud. Use it to quickly assess your infrastructure’s health and key metrics at a glance.
4
5 -## Total nodes
5 +| Feature | Description |
6 +|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7 +| **Total nodes** | Shows the total number of nodes, broken down by state: **Live**, **Offline**, or **Stale**. |
8 +| **Active alerts** | Displays the number of active alerts in a donut chart, with counters for both **Critical** and **Warning** alerts. |
9 +| **Nodes map** | Interactive map with color-coded node statuses and hoverable details. Classify nodes by **Status**, **OS**, **Technology**, **Agent version**, **Replication factor**, **Cloud provider**, **Cloud region**, or **Instance type**. Configure color-coding by **Status**, **Connection stability**, or **Replication factor**. |
10 +| **Data replication** | Two bar charts: (1) Node roles as **Parents**, **Children**, and **Standalone**. (2) Replication factors as **None**, **Single**, and **Multi**. |
11 +| **Alerts overview (last 24h)** | Two views of alert activity: (1) Bar chart showing nodes with the most alerts in the last 24 hours. (2) Table of the top alerts, with instance name, number of occurrences, and duration (in seconds). |
12 +| **Netdata Assistant shortcut** | Button to start a conversation with the [Netdata Assistant](https://github.com/netdata/netdata/edit/master/docs/netdata-assistant.md) for help and troubleshooting. |
13 +| **Space metrics** | Displays key statistics: **Metrics collected**, **Charts visualized**, and **Alerts configured**. |
14 +| **Data retention per node** | Bar chart showing the number of nodes grouped by retention period. |
15
7 -The total number of nodes is presented and dissected by their state, Live, Offline or Stale.
16 +:::tip
17
9 -## Active alerts
18 +Use the Home tab regularly to stay ahead of infrastructure issues and monitor alert trends at a glance.
19
11 -The number of active alerts is presented in a donut chart, while also having counters for both Critical and Warning alerts.
12 -
13 -## Nodes map
14 -
15 -A map consisting of node entries allows for quick hoverable information about each node, while also presenting node status in a color-coded way.
16 -
17 -The map classification can be altered, allowing the categorization of nodes by:
18 -
19 -- Status (e.g.,. Live)
20 -- OS (e.g., Ubuntu)
21 -- Technology (e.g., Container)
22 -- Agent version (e.g., v1.45.2)
23 -- Replication factor (e.g., Single, Multi)
24 -- Cloud provider (e.g., AWS)
25 -- Cloud region (e.g., us-east-1)
26 -- Instance type (e.g., c6a.xlarge)
27 -
28 -Color-coding can also be configured between:
29 -
30 -- Status (e.g., Live, Offline)
31 -- Connection stability (e.g., Stable, Unstable)
32 -- Replication factor (e.g., None, Single)
33 -
34 -## Data replication
35 -
36 -There are two views about data replication in the Home tab:
37 -
38 -The first bar chart presents the amount of **Parents**, **Children** and **Standalone** nodes.
39 -
40 -The second bar chart presents the number of nodes depending on their Replication factor, **None**, **Single** and **Multi**.
41 -
42 -## Alerts overview over the last 24h
43 -
44 -There are two views that display information about nodes that produced the most alerts and top alerts in the last 24 hours.
45 -
46 -The first bar chart presents the nodes that produced the most alerts in a time window of the last 24 hours.
47 -
48 -The second table contains the top alerts in the last 24 hours, along with their instance, the occurrences and their duration in seconds.
49 -
50 -## Netdata Assistant shortcut
51 -
52 -In the Home tab, there is a shortcut button to start an instant conversation with the [Netdata Assistant](https://github.com/netdata/netdata/edit/master/docs/netdata-assistant.md).
53 -
54 -## Space metrics
55 -
56 -There are three key metrics that are displayed in the Home tab, **Metrics collected**, **Charts visualized** and **Alerts configured**.
57 -
58 -## Data retention per Nodes
59 -
60 -This bar chart shows the number of nodes based on their retention period.
20 +:::
\ No newline at end of file
docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md
+65 -16
@@ -1,25 +1,74 @@
1 -# Metrics tab and single node tabs
1 +# Metrics Tab and Single Node Tabs
2
3 -The Metrics tab is where all the time series [charts](/docs/dashboards-and-charts/netdata-charts.md) for all the nodes of a Room are located.
3 +The **Metrics tab** provides real-time, per-second time series charts for all nodes in a Room. It helps you visualize, explore, and troubleshoot metrics across your entire infrastructure in one place.
4
5 -You can also see single-node dashboards, essentially the same dashboard the Metrics tab offers but only for one node. They are reached from most places in the UI, often by clicking the name of a node.
5 +You can also view **single-node dashboards**, which offer the same charts but are focused on a single node. You can access these dashboards from most places in the Netdata UI, often by clicking the name of a node.
6
7 -From this tab, a user can also reach the Integrations tab and run [Metric Correlations](/docs/metric-correlations.md)
7 +From the Metrics tab, you can also access:
8
9 -## Dashboard structure
9 +- The **Integrations tab**
10 +- **Metric Correlations** to identify related metrics and uncover patterns across your infrastructure
11
11 -The dashboard consists of various charts presented in different chart types. They are categorized based on their [context](/docs/dashboards-and-charts/netdata-charts.md#contexts) and at the beginning of each section, there is a predefined arrangement of charts helping you to get an overview for that particular section.
12 +:::note
13
13 -## Chart navigation Menu
14 +Learn more: [Metric Correlations documentation](/docs/metric-correlations.md)
15
15 -On the right-hand side, there is a bar that:
16 +:::
17
17 -- Allows for quick navigation through the sections of the dashboard
18 -- Provides a filtering mechanism that can filter charts by:
19 - - Host labels
20 - - Node status
21 - - Netdata version
22 - - Individual nodes
23 -- Presents the active alerts for the Room
18 +---
19
25 -From this bar you can also view the maximum chart anomaly rate on each menu section by clicking the `AR%` button.
20 +## Metrics Tab Structure Overview
21 +
22 +```mermaid
23 +graph TD
24 + A[Metrics Tab - Multi-node]
25 + A --> B[Integrations Tab]
26 + A --> C[Metric Correlations]
27 + A --> D[Single Node Tabs]
28 + D --> E[Node-specific charts]
29 +```
30 +
31 +:::tip
32 +
33 +The diagram above shows how the Metrics tab connects to related features and single-node dashboards, making it easier to navigate between views.
34 +
35 +:::
36 +
37 +---
38 +
39 +## How the Dashboard is Organized
40 +
41 +The dashboard displays various charts organized by their [context](/docs/dashboards-and-charts/netdata-charts.md#contexts). At the beginning of each section, there is a predefined arrangement of charts that provides an overview for that particular group of metrics.
42 +
43 +The available chart types and grouping options allow flexible data visualization for troubleshooting and analysis.
44 +
45 +:::tip
46 +
47 +Use the chart arrangement at the start of each section to quickly identify patterns, spikes, or anomalies before diving into detailed chart filtering.
48 +
49 +:::
50 +
51 +---
52 +
53 +## Chart Navigation Menu
54 +
55 +The **Chart Navigation Menu**, located on the right-hand side of the dashboard, helps you navigate through sections, filter charts, and view active alerts.
56 +
57 +| Feature | Description |
58 +|-------------------------------|----------------------------------------------------------------------------------------------------------------|
59 +| **Section Navigation** | Navigate quickly through the dashboard sections. |
60 +| **Chart Filtering Options** | Filter charts by: <br/> - Host labels <br/> - Node status <br/> - Netdata version <br/> - Individual nodes |
61 +| **Active Alerts Display** | View active alerts for the Room. |
62 +| **Anomaly Rate (AR%) Button** | Check the maximum chart anomaly rate for each section by clicking the `AR%` button. |
63 +
64 +:::tip
65 +
66 +Use chart filtering to reduce visual noise and focus on the nodes, labels, or statuses that matter most to your investigation.
67 +
68 +:::
69 +
70 +:::tip
71 +
72 +The **AR% button** shows the maximum anomaly rate for each dashboard section, helping you quickly identify where issues may be occurring.
73 +
74 +:::
\ No newline at end of file
docs/dashboards-and-charts/netdata-charts.md
+341 -271
@@ -1,424 +1,494 @@
1 # Netdata Charts
2
3 -Learn how to use Netdata's powerful charts to troubleshoot with real-time, per-second metric data.
3 +Netdata charts provide **real-time, per-second metrics** to help you troubleshoot and explore your infrastructure with high-resolution insights.
4
5 -Netdata excels in collecting, storing, and organizing metrics in out-of-the-box dashboards.
6 -To make sense of all the metrics, Netdata offers an enhanced version of charts that update every second.
5 +## What Makes Netdata Charts Special
6
8 -These charts provide a lot of useful information, so that you can:
7 +Netdata excels at collecting, storing, and presenting metrics in ready-to-use dashboards. Its enhanced charts update every second and offer:
8
10 -- Enjoy the high-resolution, granular metrics collected by Netdata
11 -- Examine all the metrics by hovering over them with your cursor
12 -- Filter the metrics in any way you want to use the [Definition bar](#definition-bar)
13 -- View the combined anomaly rate of all underlying data with the [Anomaly Rate ribbon](#anomaly-rate-ribbon)
14 -- Explore even more details about a chart's metrics through [hovering over certain elements of it](#hover-over-the-chart)
15 -- Use intuitive tooling and shortcuts to pan, zoom or highlight areas of interest in your charts
16 -- On highlight, get easy access to [Metric Correlations](/docs/metric-correlations.md) to see other metrics with similar patterns
17 -- Have the dimensions sorted based on name or value
18 -- View information about the chart, its plugin, context, and type
19 -- View individual metric collection status about a chart
9 +- High-resolution, granular metrics
10 +- Interactive data exploration through metric hover overlays
11 +- Customizable filtering using the Definition bar
12 +- Anomaly detection via the Anomaly Rate ribbon
13 +- Intuitive tools for panning, zooming, and highlighting areas of interest
14 +- Quick access to **Metric Correlations** for finding patterns across metrics
15 +- Flexible dimension sorting by name, value, or anomaly rate
16 +- Detailed chart information including plugin, context, and type
17 +- Real-time status of metric collection
18 +- Access to the underlying data via the **Data Queries API** for advanced use cases
19
21 -These charts are available on Netdata Cloud's
22 -[Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md), [single node tabs](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) and
23 -on your [Custom Dashboards](/docs/dashboards-and-charts/dashboards-tab.md).
20 +You can view these charts in Netdata Cloud’s **Metrics tab**, **individual node views**, and **Custom Dashboards**.
21
25 -## Overview
22 +---
23
27 -A Netdata chart looks like this:
24 +## Metric Correlations
25
29 -<img src="https://user-images.githubusercontent.com/70198089/236133212-353c102f-a6ed-45b7-9251-34e004c7a10a.png" width="900" alt="A Netdata Chart"/>
26 +Netdata charts allow you to quickly identify related metrics using the Metric Correlations feature. When you highlight an area of interest on a chart (such as a spike or anomaly), Netdata suggests other metrics that display similar behavior during the same timeframe.
27
31 -With a quick glance, you have immediate information available at your disposal:
28 +This helps you find root causes or related system activity without manually searching through all metrics.
29
33 -- [Chart title and units](#title-bar)
34 -- [Anomaly Rate ribbon](#anomaly-rate-ribbon)
35 -- [Definition bar](#definition-bar)
36 -- [Toolbar](#toolbar)
37 -- [Chart area](#hover-over-the-chart)
38 -- [Legend with dimensions](#dimensions-bar)
30 +:::note
31
40 -## Fundamental elements
32 +Learn more: [Metric Correlations documentation](/docs/metric-correlations.md)
33
42 -While Netdata's charts require no configuration and are easy to interact with, they have a lot of underlying complexities. To meaningfully organize charts out of the box based on what's happening in your nodes, Netdata uses the concepts of [dimensions](#dimensions), [contexts](#contexts), and [families](#families).
34 +:::
35
44 -Understanding how these works will help you more easily navigate the dashboard,
45 -[write new alerts](/src/health/REFERENCE.md), or play around
46 -with the [API](/src/web/api/README.md).
36 +## Chart Anatomy
37 +
38 +Each Netdata chart is designed to provide quick insights and interactive exploration:
39 +
40 +![A Netdata Chart](https://user-images.githubusercontent.com/70198089/236133212-353c102f-a6ed-45b7-9251-34e004c7a10a.png)
41 +
42 +| Chart Element | Description |
43 +|------------------------|------------------------------------------------|
44 +| Title bar | Shows the chart title and units of measurement |
45 +| Anomaly Rate ribbon | Displays the combined anomaly rate of all data |
46 +| Definition bar | Provides filtering and grouping options |
47 +| Toolbar | Offers tools for interacting with the chart |
48 +| Chart area | Displays the metrics data |
49 +| Legend with dimensions | Lists all metric dimensions with color coding |
50 +
51 +---
52 +
53 +## Core Concepts
54 +
55 +Understanding how Netdata organizes and presents metrics helps you make the most of its charts.
56
57 ### Dimensions
58
50 -A **dimension** is a value that gets shown on a chart. The value can be raw data or calculated values, such as the
51 -average (the default), minimum, or maximum. These values can then be given any type of unit. For example, CPU
52 -utilization is represented as a percentage, disk I/O as `MiB/s`, and available RAM as an absolute value in `MiB` or
53 -`GiB`.
59 +A **dimension** is a value shown on a chart. Dimensions can represent:
60
55 -Beneath every chart (or on the right side if you configure the dashboard) is a legend of dimensions. When there are
56 -multiple dimensions, you'll see a different entry in the legend for each dimension.
61 +- Raw collected data
62 +- Calculated values (such as average, minimum, or maximum)
63 +- Various units (such as percentages, MiB/s, GiB)
64
58 -The **Apps CPU Time** chart (with the [context](#contexts) `apps.cpu`), which visualizes CPU utilization of
59 -different types of processes/services/applications on your node, always provides a vibrant example of a chart with
60 -multiple dimensions.
65 +Each chart’s legend lists its dimensions. You can hide or show specific dimensions to focus on what matters most.
66
62 -Dimensions can be [hidden](#show-and-hide-dimensions) to help you focus your attention.
67 +---
68
69 ### Contexts
70
66 -A **context** is a way of grouping charts by the types of metrics collected and dimensions displayed. It's like a machine-readable naming and organization scheme.
71 +A **context** groups charts by metric type and displayed dimensions. Contexts define how charts are organized and where they appear in the Netdata menu.
72
68 -For example, the **Apps CPU Time** has the context `apps.cpu`. A little further down on the dashboard is a similar
69 -chart, **Apps Real Memory (w/o shared)** with the context `apps.mem`. The `apps` portion of the context is the **type**,
70 -whereas anything after the `.` is specified either by the chart's developer or by the [family](#families).
73 +**Examples:**
74
72 -By default, a chart's type affects where it fits in the menu, while its family creates submenus.
75 +- `apps.cpu` for **Apps CPU Time**
76 +- `apps.mem` for **Apps Real Memory**
77
74 -Netdata also relies on contexts for [alert configuration](/src/health/REFERENCE.md) (the [`on` line](/src/health/REFERENCE.md#alert-line-on)).
78 +The part before the dot (`.`) is the **type**, while the part after is defined by the chart’s developer or its family.
79 +
80 +Contexts are also used for alert configurations.
81 +
82 +---
83
84 ### Families
85
78 -**Families** are a _single instance_ of a hardware or software resource that needs to be displayed separately from
79 -similar instances.
86 +A **family** represents a specific instance of a hardware or software resource that needs its own chart.
87
81 -For example, let's look at the **Disks** section, which contains a number of charts with contexts like `disk.io`,
82 -`disk.ops`, `disk.backlog`, and `disk.util`. If your node has multiple disk drives at `sda` and `sdb`, Netdata creates
83 -a separate family for each.
88 +For example, in disk monitoring:
89
85 -Netdata now merges the contexts and families to create charts that are grouped by family, following a
86 -`[context].[family]` naming scheme, so that you can see the `disk.io` and `disk.ops` charts for `sda` right next to each
87 -other.
90 +- Disk drives like `sda` and `sdb` each have their own family.
91
89 -Given the four example contexts, and two families of `sda` and `sdb`, Netdata will create the following charts and their
90 -names:
92 +The combination of **context** and **family** forms the `[context].[family]` naming scheme:
93
94 | Context | `sda` family | `sdb` family |
93 -|:---------------|--------------------|--------------------|
95 +|----------------|--------------------|--------------------|
96 | `disk.io` | `disk_io.sda` | `disk_io.sdb` |
97 | `disk.ops` | `disk_ops.sda` | `disk_ops.sdb` |
98 | `disk.backlog` | `disk_backlog.sda` | `disk_backlog.sdb` |
99 | `disk.util` | `disk_util.sda` | `disk_util.sdb` |
100
99 -## Title bar
101 +---
102 +
103 +## Title Bar
104 +
105 +The Title bar provides essential information and quick actions for each chart:
106 +
107 +![Netdata Chart Title bar](https://github.com/netdata/netdata/assets/70198089/75d700de-bc7d-4b96-b73d-7b248b83afea)
108 +
109 +| Title Bar Element | Description |
110 +|-------------------|-----------------------------------------------------|
111 +| Netdata icon | Indicates live data updates (when time is playing) |
112 +| Chart title | Shows the title, metric, and unit of measurement |
113 +| Chart status icon | Displays loading, timeout, error, or no-data status |
114 +
115 +Quick actions available from the Title bar:
116 +
117 +![Title bar actions](https://github.com/netdata/netdata/assets/70198089/d21f326e-065c-4a08-bee9-69ad23736e38)
118 +
119 +| Action | Description |
120 +|------------------|--------------------------------------------------------------|
121 +| Manage Alerts | Configure alerts for this chart |
122 +| Chart info | View detailed chart metadata |
123 +| Chart type | Switch between line, stacked, area, bar, and multi-bar views |
124 +| Enter fullscreen | Expand the chart for full-screen analysis |
125 +| User settings | Save chart preferences across dashboard reloads |
126 +| Drag and Drop | Add the chart to an existing or new dashboard |
127 +
128 +## User Settings Priority
129 +
130 +When configuring chart preferences using the User Settings action in the Title Bar, Netdata applies the following priority order:
131 +
132 +Personal settings: Highest priority, specific to the individual user.
133 +
134 +Room settings: Shared across users in the same Room if no personal settings exist.
135 +
136 +Space settings: Global defaults across the Space if no Room or personal settings exist.
137 +
138 +This hierarchy ensures that your personal preferences always take precedence, while still allowing collaborative defaults at the Room or Space level.
139 +
140 +---
141
101 -When you start interacting with a chart, you'll notice valuable information on the Title bar:
142 +## Definition Bar
143
103 -<img src="https://github.com/netdata/netdata/assets/70198089/75d700de-bc7d-4b96-b73d-7b248b83afea" width="900" alt="Netdata Chart Title bar"/>
144 +The Definition bar provides powerful filtering and grouping options, helping you explore your metrics more effectively:
145
105 -Title bar elements:
146 +![Definition bar](https://user-images.githubusercontent.com/70198089/236134615-e53a1d68-8a0f-466b-b2ef-1974085f0e8d.png)
147
107 -- **Netdata icon**: this indicates that data is continuously being updated, this happens if [Time controls](/docs/dashboards-and-charts/visualization-date-and-time-controls.md#time-controls) are in Play or Force Play mode.
108 -- **Chart title**: on the chart title you can see the title together with the metric being displayed, as well as the unit of measurement.
109 -- **Chart status icon**: possible values are: Loading, Timeout, Error or No data, otherwise this icon is not shown.
148 +| Definition Bar Element | Description |
149 +|------------------------|----------------------------------------------------|
150 +| Group by option | Choose how to group your data visualization |
151 +| Aggregate function | Select how to aggregate data from multiple sources |
152 +| Nodes filter | Filter data from specific nodes |
153 +| Instances filter | Filter specific instances of data |
154 +| Dimensions filter | Filter particular dimensions |
155 +| Labels filter | Filter by specific labels |
156 +| Time aggregation | Control how data points are aggregated over time |
157 +| Reset button | Return to default filtering and grouping settings |
158
111 -Along with viewing chart type, context, and units, on this bar you have access to immediate actions over the chart:
159 +---
160
113 -<img src="https://github.com/netdata/netdata/assets/70198089/d21f326e-065c-4a08-bee9-69ad23736e38" width="200" alt="Netdata Chart Title bar immediate actions"/>
161 +## NIDL Framework
162
115 -- **Manage Alerts**: manage [Alert configurations](/docs/dashboards-and-charts/alerts-tab.md#alert-configurations-tab) for this chart.
116 -- **Chart info**: get more information relevant to the chart you are interacting with.
117 -- **Chart type**: change the chart type from **line**, **stacked**, **area**, **stacked bar** and **multi bar**.
118 -- **Enter fullscreen mode**: expand the current chart to the full size of your screen.
119 -- **User settings**: save your settings for the chart at hand, so it persists across dashboard reloads.
120 - - Personal has the top priority.
121 - - Room and Space settings for a chart are shared across all users who don't have personal settings for it.
122 -- **Drag and Drop the chart to a Dashboard**: add the chart to an existing custom [Dashboard](/docs/dashboards-and-charts/dashboards-tab.md) or directly create a new one that includes the chart.
163 +The **NIDL (Nodes, Instances, Dimensions, Labels)** framework helps you filter, group, and understand chart data at a glance.
164
124 -## Definition bar
165 +:::tip
166
126 -Each composite chart has a definition bar to provide information and options about the following:
167 +For a detailed explanation, click the image below to open it in a new tab where you can zoom in.
168
128 -<img src="https://user-images.githubusercontent.com/70198089/236134615-e53a1d68-8a0f-466b-b2ef-1974085f0e8d.png" width="900" alt="Netdata Chart Definition bar"/>
169 +<a href="https://user-images.githubusercontent.com/2662304/235475061-44628011-3b1f-4c44-9528-34452018eb89.png" target="_blank">
170 + <img src="https://user-images.githubusercontent.com/2662304/235475061-44628011-3b1f-4c44-9528-34452018eb89.png" width="400" alt="Netdata NIDL Framework"/>
171 +</a>
172
130 -- Group by option
131 -- Aggregate function to be applied in case multiple data sources exist
132 -- Nodes filter
133 -- Instances filter
134 -- Dimensions filter
135 -- Labels filter
136 -- The aggregate function over time to be applied if one point in the chart consists of multiple data points aggregated
137 -- Resetting the Definition bar
173 +:::
174
139 -### NIDL framework
175 +These dropdown menus serve two main functions:
176
141 -To help users instantly understand and validate the data they see on charts, we developed the NIDL (Nodes, Instances, Dimensions, Labels) framework. This information is visualized on all charts.
177 +1. Provide context about the metrics being visualized.
178 +2. Enable flexible grouping and filtering for tailored views.
179
143 -> You can explore the in-depth infographic by clicking on this image and opening it in a new tab,
144 -> allowing you to zoom in to the different parts of it.
145 ->
146 -> <a href="https://user-images.githubusercontent.com/2662304/235475061-44628011-3b1f-4c44-9528-34452018eb89.png" target="_blank">
147 -> <img src="https://user-images.githubusercontent.com/2662304/235475061-44628011-3b1f-4c44-9528-34452018eb89.png" width="400" border="0" align="center" alt="Netdata NIDL Framework"/>
148 -> </a>
180 +![NIDL Dropdown menus](https://user-images.githubusercontent.com/43294513/235470150-62a3b9ac-51ca-4c0d-81de-8804e3d733eb.png)
181
150 -You can rapidly access condensed information for collected metrics, grouped by node, monitored instances, dimension, or any key/value label pair.
182 +| Metric Information | Description |
183 +|---------------------|-----------------------------------------------------|
184 +| Volume contribution | Shows how much each metric contributes to the total |
185 +| Anomaly rate | Displays anomaly rate for the selected timeframe |
186 +| Value statistics | Shows minimum, average, and maximum values |
187
152 -At the Definition bar of each chart, there are a few dropdown menus:
188 +---
189
154 -<img src="https://user-images.githubusercontent.com/43294513/235470150-62a3b9ac-51ca-4c0d-81de-8804e3d733eb.png" width="900" alt="Netdata Chart NIDL Dropdown menus"/>
190 +## Group By Dropdown
191
156 -These dropdown menus have two functions:
192 +The **Group by** dropdown allows you to apply different grouping strategies on the same dataset:
193
158 -1. Provide additional information about the visualized chart to help with understanding the data that is presented.
159 -2. Provide filtering and grouping capabilities, altering the query on the fly, to help get different views of the dataset.
194 +![Group by dropdown](https://user-images.githubusercontent.com/43294513/235468819-3af5a1d3-8619-48fb-a8b7-8e8b4cf6a8ff.png)
195
161 -The NIDL framework attaches metadata to every metric that is collected to provide for each of them the following consolidated data for the visible time frame:
196 +| Grouping Option | Description |
197 +|--------------------|------------------------------------------------------------|
198 +| Group by Node | Summarize data by node with one dimension per node |
199 +| Group by Instance | Summarize data by instance with one dimension per instance |
200 +| Group by Dimension | Aggregate data across all nodes by dimension |
201 +| Group by Label | Summarize data based on label values |
202
163 -1. The volume contribution of each metric into the final query. So even if a query comes from 1000 nodes, the contribution of each node in the result can instantly be visualized. The same goes for instances, dimensions and labels. Especially for labels, Netdata also provides the volume contribution of each label `key:value` pair to the final query, so that you can immediately see how much every label value involved in the query affected the chart.
164 -2. The anomaly rate of each of them for the time-frame of the query. This is used to quickly spot which of the nodes, instances, dimensions or labels have anomalies in the requested time-frame.
165 -3. The minimum, average and maximum values of all the points used for the query. This is used to quickly spot which of the nodes, instances, dimensions or labels are responsible for a spike or a dive in the chart.
203 +:::tip
204
167 -All of these dropdown menus can be used for instantly filtering the information shown by including or excluding specific nodes, instances, dimensions or labels. Directly from the dropdown menu, without the need to edit a query string and without any additional knowledge of the underlying data.
205 +When working with cgroups (VMs and containers), using **Group by Instance** shows data from all contributing cgroups. Apply additional filters to focus on specific instances and save these views to your dashboards.
206
169 -### Group by dropdown
207 +:::
208
171 -The "Group by" dropdown menu allows selecting one or more groupings to be applied at once on the same dataset.
209 +:::tip
210
173 -<img src="https://user-images.githubusercontent.com/43294513/235468819-3af5a1d3-8619-48fb-a8b7-8e8b4cf6a8ff.png" width="900" alt="Netdata Chart Group by dropdown"/>
211 +Use **Group by Instance, Dimension** to visualize the time series for each individual collected metric in the chart.
212
175 -It supports:
213 +:::
214
177 -1. **Group by Node**, to summarize the data of each node, and provide one dimension on the chart for each of the nodes involved. Filtering nodes is supported at the same time, using the node dropdown menu.
178 -2. **Group by Instance**, to summarize the data of each instance and provide one dimension on the chart for each of the instances involved. Filtering instances is supported at the same time, using the instance dropdown menu.
179 -3. **Group by Dimension**, so that each metric in the visualization is the aggregation of a single dimension. This provides a per dimension view of the data from all the nodes in the Room, taking into account filtering criteria if defined.
180 -4. **Group by Label**, to summarize the data for each label value. Multiple label keys can be selected at the same time.
215 +---
216
182 -Using this menu, you can slice and dice the data in any possible way, to quickly get different views of it, without the need to edit a query string and without any need to better understand the format of the underlying data.
217 +## Aggregate Functions Dropdown
218
184 -> ### Tip
185 ->
186 -> A very pertinent example is composite charts over contexts related to cgroups (VMs and containers).
187 -> You have the means to change the default group by or apply filtering to get a better view into what data you’re trying to analyze.
188 -> For example, if you change the group by to _instance_ you get a view with the data of all the instances (cgroups) that contribute to that chart.
189 -> Then you can use further filtering tools to focus the data that is important to you and even save the result to your own dashboards.
190 ->
191 -> ### Tip
192 ->
193 -> Group by instance, dimension to see the time series of every individual collected metric participating in the chart.
219 +Each chart has a default aggregation function, which you can adjust as needed:
220
195 -### Aggregate functions over data sources dropdown
221 +![Aggregate functions](https://user-images.githubusercontent.com/70198089/236136725-778670b4-7e81-44a8-8d3d-f38ded823c94.png)
222
197 -Each chart uses an opinionated-but-valuable default aggregate function over the data sources.
223 +| Function | Description |
224 +|----------|-----------------------------------------------------------------------------------------------------|
225 +| Average | Displays the average value across sources |
226 +| Sum | Shows the sum of all contributed values |
227 +| Min | Displays the minimum value (closest to zero or largest magnitude for negative values) |
228 +| Max | Displays the maximum value (largest magnitude for positive values or closest to zero for negatives) |
229
199 -<img src="https://user-images.githubusercontent.com/70198089/236136725-778670b4-7e81-44a8-8d3d-f38ded823c94.png" width="500" alt="Netdata Chart Aggregate functions over data"/>
230 +## Aggregate Functions Over Time – Additional Dropdown Examples
231
201 -For example, the `system.cpu` chart shows the average for each dimension from every contributing chart, while the `net.net` chart shows the sum for each dimension from every contributing chart, which can also come from multiple networking interfaces.
232 +When selecting aggregation functions over time, charts may offer dropdown menus for **Percentiles** and **Trimmed Mean / Median** selection. Below are examples of these dropdowns:
233
203 -The following aggregate functions are available for each selected dimension:
234 +### Percentile Selection Example:
235
205 -- **Average**: Displays the average value from contributing nodes. If a composite chart has five nodes with the following
206 - values for the `out` dimension&mdash;`-2.1`, `-5.5`, `-10.2`, `-15`, `-0.1`&mdash;the composite chart displays a
207 - value of `−6.58`.
208 -- **Sum**: Displays the sum of contributed values. Using the same nodes, dimension, and values as above, the composite
209 - chart displays a metric value of `-32.9`.
210 -- **Min**: Displays a minimum value. For dimensions with positive values, the min is the value closest to zero. For
211 - charts with negative values, the min is the value with the largest magnitude.
212 -- **Max**: Displays a maximum value. For dimensions with positive values, the max is the value with the largest
213 - magnitude. For charts with negative values, the max is the value closet to zero.
236 +![Percentile selection dropdown](https://user-images.githubusercontent.com/70198089/236410299-de5f3367-f3b0-4beb-a73f-a49007c543d4.png)
237
215 -### Nodes dropdown
238 +### Trimmed Mean / Median Selection Example:
239
217 -In this dropdown, you can view or filter the nodes contributing time-series metrics to the chart.
218 -This menu also provides the contribution of each node to the volume of the chart, and a break-down of the anomaly rate of the queried data per node.
240 +![Trimmed Mean or Median selection dropdown](https://user-images.githubusercontent.com/70198089/236410858-74b46af9-280a-4ab2-ad26-5a6aa9403aa8.png)
241
220 -<img src="https://user-images.githubusercontent.com/70198089/236137765-b57d5443-3d4b-42f4-9e3d-db1eb606626f.png" width="900" alt="Netdata Chart Nodes dropdown"/>
242 +These options let you control how outliers and edge cases are handled during time-based aggregation.
243
222 -If one or more nodes can't contribute to a given chart, the definition bar shows a warning symbol plus the number of
223 -affected nodes, then lists them in the dropdown along with the associated error. Nodes might return errors because of
224 -networking issues, a stopped `netdata` service, or because that node doesn’t have any metrics for that context.
244 +---
245
226 -### Instances dropdown
246 +## Nodes Dropdown
247
228 -In this dropdown, you can view or filter the instances contributing time-series metrics to the chart.
229 -This menu also provides the contribution of each instance to the volume of the chart, and a break-down of the anomaly rate of the queried data per instance.
248 +Filter and explore the contribution of each node to your chart:
249
231 -<img src="https://user-images.githubusercontent.com/70198089/236138302-4dd4072e-3a0d-43bb-a9d8-4dde79c65e92.png" width="900" alt="Netdata Chart Instances dropdown"/>
250 +![Nodes dropdown](https://user-images.githubusercontent.com/70198089/236137765-b57d5443-3d4b-42f4-9e3d-db1eb606626f.png)
251
233 -### Dimensions dropdown
252 +| Node Information | Description |
253 +|-------------------------|----------------------------------------------------------|
254 +| Contribution percentage | Shows each node’s share of the total data volume |
255 +| Anomaly rate | Displays anomaly rate per node |
256 +| Error messages | Lists any errors preventing nodes from contributing data |
257
235 -In this dropdown, you can view or filter the original dimensions contributing time-series metrics to the chart.
236 -This menu also presents the contribution of each original dimension on the chart, and a break-down of the anomaly rate of the data per dimension.
258 +---
259
238 -<img src="https://user-images.githubusercontent.com/70198089/236138796-08dc6ac6-9a50-4913-a46d-d9bbcedd48f6.png" width="900" alt="Netdata Chart Dimensions Dropdown"/>
260 +## Instances Dropdown
261
240 -### Labels dropdown
262 +Use the **Instances** dropdown to filter or view the contribution of specific instances within your data:
263
242 -In this dropdown, you can view or filter the contributing time-series labels of the chart.
243 -This menu also presents the contribution of each label on the chart,and a break-down of the anomaly rate of the data per label.
264 +![Instances dropdown](https://user-images.githubusercontent.com/70198089/236138302-4dd4072e-3a0d-43bb-a9d8-4dde79c65e92.png)
265
245 -<img src="https://user-images.githubusercontent.com/70198089/236139027-8a51a958-2074-4675-a41b-efff30d8f51a.png" width="900" alt="Netdata Chart Labels Dropdown"/>
266 +| Instance Information | Description |
267 +|-------------------------|--------------------------------------------------------------|
268 +| Contribution percentage | Shows how much each instance contributes to the chart volume |
269 +| Anomaly rate | Displays the anomaly rate for each instance |
270
247 -### Aggregate functions over time
271 +---
272
249 -When the granularity of the data collected is higher than the plotted points on the chart, an aggregation function over
250 -time is applied.
273 +## Dimensions Dropdown
274
252 -<img src="https://user-images.githubusercontent.com/70198089/236411297-e123db06-0117-4e24-a5ac-955b980a8f55.png" width="400" alt="Netdata Chart Aggregate functions over time"/>
275 +The **Dimensions** dropdown allows you to filter by or focus on particular dimensions within your chart:
276
254 -By default, the aggregation applied is _average_ but the user can choose different options from the following:
277 +![Dimensions dropdown](https://user-images.githubusercontent.com/70198089/236138796-08dc6ac6-9a50-4913-a46d-d9bbcedd48f6.png)
278
256 -- Min, Max, Average or Sum
257 -- Percentile
258 - - you can specify the percentile you want to focus on: 25th, 50th, 75th, 80th, 90th, 95th, 97th, 98th and 99th.
259 - <img src="https://user-images.githubusercontent.com/70198089/236410299-de5f3367-f3b0-4beb-a73f-a49007c543d4.png" width="250" alt="Netdata Chart Aggregate functions over time Percentile selection"/>
260 -- Trimmed Mean or Trimmed Median
261 - - you can choose the percentage of data that you want to focus on: 1%, 2%, 3%, 5%, 10%, 15%, 20% and 25%.
262 - <img src="https://user-images.githubusercontent.com/70198089/236410858-74b46af9-280a-4ab2-ad26-5a6aa9403aa8.png" width="250" alt="Netdata Chart Aggregate functions over time Trimmed Mean or Median selection"/>
263 -- Median
264 -- Standard deviation
265 -- Coefficient of variation
266 -- Delta
267 -- Single or Double exponential smoothing
279 +| Dimension Information | Description |
280 +|-------------------------|---------------------------------------------------------------|
281 +| Contribution percentage | Shows how much each dimension contributes to the chart volume |
282 +| Anomaly rate | Displays the anomaly rate for each dimension |
283
269 -For more details on each, you can refer to our Agent's HTTP API details on [Data Queries - Data Grouping](/src/web/api/queries/README.md#data-grouping).
284 +---
285
271 -### Reset to defaults
286 +## Labels Dropdown
287
273 -Finally, you can reset everything to its defaults by clicking the green "Reset" prompt at the end of the definition bar.
288 +Filter or view your data by **labels**, giving you flexibility to isolate metrics by their tags:
289
275 -## Anomaly Rate ribbon
290 +![Labels dropdown](https://user-images.githubusercontent.com/70198089/236139027-8a51a958-2074-4675-a41b-efff30d8f51a.png)
291
277 -Netdata's unsupervised machine learning algorithm creates a unique model for each metric collected by your Agents, using exclusively the metric's past data.
278 -It then uses these unique models during data collection to predict the value that should be collected and check if the collected value is within the range of acceptable values based on past patterns and behavior.
292 +| Label Information | Description |
293 +|-------------------------|-------------------------------------------------|
294 +| Contribution percentage | Shows each label’s contribution to chart volume |
295 +| Anomaly rate | Displays the anomaly rate breakdown by label |
296
280 -If the value collected is an outlier, it is marked as anomalous.
297 +---
298
282 -<img src="https://user-images.githubusercontent.com/70198089/236139886-79d63cf6-61ed-4aa7-842c-b5a1728c870d.png" width="900" alt="Netdata Chart Anomaly Rate Ribbon"/>
299 +## Aggregate Functions Over Time
300
284 -This unmatched capability of real-time predictions, as data is collected, allows you to **detect anomalies for potentially millions of metrics across your entire infrastructure within a second of occurrence**.
301 +When data resolution exceeds the chart’s granularity, **time-based aggregation** is applied. The aggregation function over time ensures that large amounts of data are still readable and insightful.
302
286 -The Anomaly Rate ribbon on top of each chart visualizes the combined anomaly rate of all the underlying data, highlighting areas of interest that may not be easily visible to the naked eye.
303 +![Aggregate functions over time](https://user-images.githubusercontent.com/70198089/236411297-e123db06-0117-4e24-a5ac-955b980a8f55.png)
304
288 -Hovering over the Anomaly Rate ribbon provides a histogram of the anomaly rates per presented dimension, for the specific point in time.
305 +| Aggregation Function | Description |
306 +|------------------------------|----------------------------------------------|
307 +| Min, Max, Average, Sum | Basic statistical aggregations |
308 +| Percentile (25th–99th) | Show specific percentiles of the data points |
309 +| Trimmed Mean/Median (1%–25%) | Remove outliers before calculating averages |
310 +| Median | Display the middle value of the data set |
311 +| Standard deviation | Measure data variability |
312 +| Coefficient of variation | Show relative variability |
313 +| Delta | Display the change between data points |
314 +| Exponential smoothing | Apply weighted averaging to recent points |
315
290 -Anomaly Rate visualization doesn’t make Netdata slower. Anomaly rate is saved in the Netdata database, together with metric values, and due to the smart design of Netdata, it doesn’t even incur a disk footprint penalty.
316 +:::tip
317
292 -## Hover over the chart
318 +For more details, see [Data Queries - Data Grouping](/src/web/api/queries/README.md#data-grouping).
319
294 -Hovering over any point in the chart will reveal a more informative overlay.
295 -It includes a bar indicating the volume percentage of each time series compared to the total, the anomaly rate, and a notification on if there are data collection issues.
320 +:::
321
297 -This overlay sorts all dimensions by value, makes bold the closest dimension to the mouse and presents a histogram based on the values of the dimensions.
322 +---
323
299 -<img src="https://user-images.githubusercontent.com/70198089/236141460-bfa66b99-d63c-4a2c-84b1-2509ed94857f.png" width="500" alt="Netdata Chart Hover over Chart"/>
324 +## Reset to Defaults
325
301 -When hovering the anomaly ribbon, the overlay sorts all dimensions by anomaly rate, and presents a histogram of these anomaly rates.
326 +Click the green **Reset** button at the end of the Definition bar to restore the chart’s filtering and grouping options to their defaults.
327
303 -### Info column
328 +---
329
305 -Additionally, when hovering over the chart, the overlay may display an indication in the "Info" column.
330 +## Anomaly Rate Ribbon
331
307 -Currently, this column is used to inform users of any data collection issues that might affect the chart.
308 -Below each chart, there is an information ribbon. This ribbon currently shows three states related to the points presented in the chart:
332 +Netdata uses machine learning models trained on past data to predict expected metric values. These models identify anomalies in real time as soon as outliers occur.
333
310 -1. **Partial Data**
311 - At least one of the dimensions in the chart has partial data, meaning that not all instances available contributed data to this point. This can happen when a container is stopped, or when a node is restarted. This indicator helps to gain confidence of the dataset, in situations when unusual spikes or dives appear due to infrastructure maintenance, or due to failures to part of the infrastructure.
334 +![Anomaly Rate Ribbon](https://user-images.githubusercontent.com/70198089/236139886-79d63cf6-61ed-4aa7-842c-b5a1728c870d.png)
335
313 -2. **Overflown**
314 - At least one of the data sources included in the chart has a counter that has overflowed at this point.
336 +| Anomaly Ribbon Feature | Description |
337 +|------------------------|-----------------------------------------------------|
338 +| Visual indicator | Shows the combined anomaly rate across all data |
339 +| Hover information | Displays a histogram of anomaly rates per dimension |
340 +| Real-time detection | Flags anomalies within seconds of occurrence |
341
316 -3. **Empty Data**
317 - At least one of the dimensions included in the chart has no data at all for the given points.
342 +This feature enables you to catch issues quickly across large volumes of metrics.
343
319 -All these indicators are also visualized per dimension, in the pop-over that appears when hovering the chart.
344 +---
345
321 -<img src="https://user-images.githubusercontent.com/70198089/236145768-8ffadd02-93a4-4e9e-b4ae-c1367f614a7e.png" width="700" alt="Netdata Chart Hover over the chart Info Column"/>
346 +## Hover Over the Chart
347
323 -## Play, Pause and Reset
348 +Hovering over any point on a chart reveals a detailed information overlay, making it easy to explore your metrics interactively:
349
325 -Your charts are controlled using the available [Time controls](/docs/dashboards-and-charts/visualization-date-and-time-controls.md#time-controls).
326 -Besides these, when interacting with the chart, you can also activate these controls by:
350 +![Chart hover overlay](https://user-images.githubusercontent.com/70198089/236141460-bfa66b99-d63c-4a2c-84b1-2509ed94857f.png)
351
328 -- Hovering over any chart to temporarily pause it - this momentarily switches time control to Pause, so that you can
329 - hover over a specific timeframe. When moving out of the chart, time control will go back to Play (if it was, it's
330 - a previous state)
331 -- Clicking on the chart to lock it - this enables the Pause option on the time controls, to the current timeframe. This
332 - is if you want to jump to a different chart to look for possible correlations.
333 -- Double-clicking to release a previously locked chart - move the time control back to Play
352 +| Hover Information | Description |
353 +|-------------------|------------------------------------------------------------------|
354 +| Volume percentage | Shows the contribution of each time series compared to the total |
355 +| Anomaly rate | Displays the anomaly rate for each dimension |
356 +| Collection issues | Indicates any data collection problems |
357 +| Value histogram | Visualizes the distribution of dimension values |
358
335 -| Interaction | Keyboard/mouse | Touchpad/touchscreen | Time control |
336 -|:------------------|:---------------|:---------------------|:----------------------|
337 -| **Pause** a chart | `hover` | `n/a` | Temporarily **Pause** |
338 -| **Stop** a chart | `click` | `tap` | **Pause** |
339 -| **Reset** a chart | `double click` | `n/a` | **Play** |
359 +When you hover over the **Anomaly Rate ribbon**, the dimensions are sorted by anomaly rate, and a histogram displays these rates to help you quickly identify problematic metrics.
360
341 -Note: These interactions are available when the default "Pan" action is used from the [Tool Bar](#toolbar).
361 +---
362 +
363 +### Info Column
364 +
365 +The **Info Column** appears during hover and provides detailed data collection insights:
366 +
367 +![Info Column](https://user-images.githubusercontent.com/70198089/236145768-8ffadd02-93a4-4e9e-b4ae-c1367f614a7e.png)
368 +
369 +| Indicator | Description |
370 +|--------------|-------------------------------------------------------------------------------|
371 +| Partial Data | At least one dimension has partial data (not all instances contributed fully) |
372 +| Overflown | At least one data source has a counter that overflowed |
373 +| Empty Data | At least one dimension has no data for the selected points |
374 +
375 +---
376 +
377 +## Play, Pause, and Reset Controls
378 +
379 +Control chart playback and interact with time using the **Time Controls**. These controls help you pause or reset the charts while exploring metrics.
380 +
381 +| Interaction | Keyboard / Mouse | Touchpad / Touchscreen | Time Control Effect |
382 +|-------------------------|---------------------------|------------------------|-----------------------------------------|
383 +| Pause chart (temporary) | Hover over the chart | n/a | Temporarily pauses playback |
384 +| Stop chart (lock pause) | Click on the chart | Tap | Locks playback at selected time |
385 +| Reset playback | Double-click on the chart | n/a | Resumes playback (returns to Play mode) |
386 +
387 +These controls work when the **default “Pan” action** is selected in the toolbar.
388 +
389 +---
390
391 ## Toolbar
392
345 -While exploring the chart, a toolbar will appear. This toolbar is there to support you on this task.
346 -The available manipulation tools you can select are:
393 +The chart **Toolbar** provides interactive tools for manipulating the chart view:
394 +
395 +![Chart Toolbar](https://user-images.githubusercontent.com/70198089/236143292-c1d75528-263d-4ddd-9db8-b8d6a31cb83e.png)
396
348 -<img src="https://user-images.githubusercontent.com/70198089/236143292-c1d75528-263d-4ddd-9db8-b8d6a31cb83e.png" width="400" alt="Netdata Chart Tool bar"/>
397 +| Tool | Description |
398 +|-----------------|-----------------------------------------|
399 +| Pan | Move through the timeline |
400 +| Highlight | Select specific timeframes for analysis |
401 +| Select and Zoom | Zoom into selected timeframes |
402 +| Chart Zoom | Zoom in or out on the chart |
403 +| Reset Zoom | Return to the original view |
404
350 -- Pan
351 -- Highlight
352 -- Select and zoom
353 -- Chart zoom
354 -- Reset zoom
405 +---
406
407 ### Pan
408
358 -Drag your mouse/finger to the right to pan backward through time, or drag to the left to pan forward in time. Think of
359 -it like pushing the current timeframe off the screen to see what came before or after.
409 +Use the **Pan Tool** to navigate through time on the chart:
410
361 -| Interaction | Keyboard | Mouse | Touchpad/touchscreen |
362 -|:------------|:---------|:---------------|:---------------------|
363 -| **Pan** | `n/a` | `click + drag` | `touch drag` |
411 +| Pan Interaction | Keyboard | Mouse | Touchpad/Touchscreen |
412 +|------------------|----------|----------------|----------------------|
413 +| Pan through time | n/a | Click and drag | Touch drag |
414 +
415 +Drag right to move backward in time and left to move forward.
416 +
417 +---
418
419 ### Highlight
420
367 -Selecting timeframes is useful when you see an interesting spike or change in a chart and want to investigate further by:
421 +The **Highlight Tool** allows you to select timeframes for deeper analysis:
422 +
423 +| Highlight Interaction | Keyboard/Mouse | Touchpad/Touchscreen |
424 +|-----------------------|------------------------------------------------------|----------------------|
425 +| Highlight timeframe | Alt + mouse selection or ⌘ + mouse selection (macOS) | n/a |
426 +
427 +Use highlighting to investigate spikes, anomalies, or unusual behavior. Click on the chart area to clear the highlight selection.
428 +
429 +---
430 +
431 +### Select and Zoom
432 +
433 +Zoom into specific timeframes for maximum data granularity:
434 +
435 +| Zoom Interaction | Keyboard/Mouse | Touchpad/Touchscreen |
436 +|------------------------|------------------------------------|----------------------|
437 +| Zoom to timeframe | Shift + mouse vertical selection | n/a |
438 +| Horizontal Y-axis zoom | Shift + mouse horizontal selection | n/a |
439 +
440 +---
441 +
442 +### Zoom In and Out
443 +
444 +The **Chart Zoom** tool allows you to zoom in and out to view different time ranges:
445
369 -- Looking at the same period of time on other charts/sections
370 -- Running [metric correlations](/docs/metric-correlations.md) to filter metrics that also show something different in the selected period, vs the previous one
446 +| Zoom Interaction | Keyboard/Mouse | Touchpad/Touchscreen |
447 +|------------------|---------------------------|-----------------------------------------------|
448 +| Zoom in/out | Shift + mouse scrollwheel | Two-finger pinch or Shift + two-finger scroll |
449
372 -| Interaction | Keyboard/mouse | Touchpad/touchscreen |
373 -|:-----------------------------------|:---------------------------------------------------------|:---------------------|
374 -| **Highlight** a specific timeframe | `Alt + mouse selection` or `⌘ + mouse selection` (macOS) | `n/a` |
450 +Zooming in helps you analyze recent events in detail, while zooming out provides an overview of longer-term trends.
451
376 -> **Note**
377 ->
378 -> To clear a highlighted timeframe, click on the chart area.
452 +---
453
380 -### Select and zoom
454 +## Dimensions Bar
455
382 -You can zoom to a specific timeframe, either horizontally or vertically, by selecting a timeframe.
456 +The **Dimensions Bar** allows you to manage how dimensions are displayed within the chart. Sorting and hiding dimensions helps you focus on the most relevant data.
457
384 -| Interaction | Keyboard/mouse | Touchpad/touchscreen |
385 -|:-------------------------------------------|:-------------------------------------|:---------------------|
386 -| **Zoom** to a specific timeframe | `Shift + mouse vertical selection` | `n/a` |
387 -| **Horizontal Zoom** a specific Y-axis area | `Shift + mouse horizontal selection` | `n/a` |
458 +### Order Dimensions Legend
459
389 -### Chart zoom
460 +You can sort the dimensions legend using various criteria:
461
391 -Zooming in helps you see metrics with maximum granularity, which is useful when you're trying to diagnose the root cause
392 -of an anomaly or outage.
462 +![Order dimensions](https://user-images.githubusercontent.com/70198089/236144658-6c3d0e31-9bcb-45f3-bb95-4eafdcbb0a58.png)
463
394 -Zooming out lets you see metrics within the larger context, such as the last hour, day, or week, which is useful in understanding what "normal" looks like, or to identify long-term trends, like a slow creep in memory usage.
464 +| Sorting Option | Description |
465 +|------------------------|---------------------------------------------------------|
466 +| Dimension name | Sort alphabetically (ascending or descending) |
467 +| Dimension value | Sort by current metric values (ascending or descending) |
468 +| Dimension anomaly rate | Sort by anomaly rate (ascending or descending) |
469
396 -| Interaction | Keyboard/mouse | Touchpad/touchscreen |
397 -|:-------------------|:----------------------------|:-----------------------------------------------------|
398 -| **Zoom** in or out | `Shift + mouse scrollwheel` | `two-finger pinch` <br />`Shift + two-finger scroll` |
470 +---
471
400 -## Dimensions bar
472 +### Show and Hide Dimensions
473
402 -### Order dimensions legend
474 +Simplify your charts by showing only the dimensions you want to focus on:
475
404 -The bottom legend where you can see the dimensions of the chart can be ordered by:
476 +| Dimension Interaction | Keyboard/Mouse | Touchpad/Touchscreen |
477 +|------------------------------|------------------------|----------------------|
478 +| Show one dimension only | Click on the dimension | Tap |
479 +| Toggle individual dimensions | Shift + click | n/a |
480
406 -<img src="https://user-images.githubusercontent.com/70198089/236144658-6c3d0e31-9bcb-45f3-bb95-4eafdcbb0a58.png" width="300" alt="Netdata Chart order dimensions legend"/>
481 +This feature is especially useful for identifying unusual behavior by isolating specific metrics.
482
408 -- Dimension name (Ascending or Descending)
409 -- Dimension value (Ascending or Descending)
410 -- Dimension Anomaly Rate (Ascending or Descending)
483 +---
484
412 -### Show and hide dimensions
485 +## Resize a Chart
486
414 -Hiding dimensions simplifies the chart and can help you better discover exactly which aspect of your system might be
415 -behaving strangely.
487 +Adjust the height of a chart to fit your analysis needs:
488
417 -| Interaction | Keyboard/mouse | Touchpad/touchscreen |
418 -|:---------------------------------------|:----------------|:---------------------|
419 -| **Show one** dimension and hide others | `click` | `tap` |
420 -| **Toggle (show/hide)** one dimension | `Shift + click` | `n/a` |
489 +- **Resize**: Click and drag the resize handle located at the bottom-right corner of the chart.
490 +- **Restore original size**: Double-click the resize handle.
491
422 -## Resize a chart
492 +This allows you to expand charts for more detailed analysis or condense them for a broader dashboard view.
493
424 -To resize the chart, click-and-drag the icon in the bottom-right corner of any chart. To restore the chart to its original height, double-click the same icon.
494 +*Netdata charts combine clarity, flexibility, and interactivity, designed to help you focus on what matters most in your infrastructure.*
\ No newline at end of file
docs/dashboards-and-charts/nodes-tab.md
+14 -51
@@ -1,57 +1,20 @@
1 # Nodes tab
2
3 -The Nodes tab provides a summarized view of your [Room](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#rooms), allowing you to view quick information per node.
3 +The **Nodes tab** provides a live, centralized view of every node in your [Room](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#rooms), allowing you to filter, sort, and interact with key node information.
4
5 -> **Tip**
6 ->
7 -> Keep in mind that all configurations mentioned below are persistent and visible across all users.
5 +:::tip
6
9 -## Center information view
7 +All configurations on this page are persistent and visible to all users in the Room.
8
11 -The center information view consists of one row per node, and can be configured and filtered by the user.
9 +:::
10
13 -### Filtering and adjusting the view
14 -
15 -In the top right-hand corner, you can:
16 -
17 -- Order the nodes per status or per alert status
18 -- Select which charts you want to be displayed as quick reference points
19 -
20 -### Node row
21 -
22 -Each node row allows you to:
23 -
24 -- View the node's status
25 -- Go to a single node dashboard by clicking the node name
26 -- View information about the node, along with a button to display more in the right-hand sidebar
27 -- View active alerts for the node
28 -- View Machine Learning status
29 -- View Functions capability status
30 -- Add configuration (beta)
31 -- [Add alert silencing rules](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md)
32 -- View a set of key attributes collected on your node
33 -
34 -## Right bar
35 -
36 -The bar on the right-hand side provides additional information about the nodes in the Room and allows you to filter what is displayed in the [center information view](#center-information-view).
37 -
38 -### Node hierarchy
39 -
40 -The first tab displays a hierarchy of the nodes displayed, making it easy to find a specific node by name. It follows the ordering that the user has selected.
41 -
42 -### Filters sub-tab
43 -
44 -The second tab allows you to filter which nodes are displayed, you can filter by:
45 -
46 -- Host labels
47 -- Node status
48 -- Netdata version
49 -- Individual nodes
50 -
51 -### Alerts sub-tab
52 -
53 -The third tab displays Room alerts and allows you to see additional information about each alert.
54 -
55 -### Info sub-tab
56 -
57 -The last tab presents information about a node, by clicking the `i` icon from a node's row, right next to its name.
11 +| Section | Description |
12 +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13 +| **Center information view** | Displays one row per node. You can configure and filter the view to focus on the information that matters most. |
14 +| **Filtering and adjusting the view** | Use the top right-hand corner options to: <br/>• Order nodes by **status** or **alert status** <br/>• Select which charts to display as quick reference points |
15 +| **Node row actions** | For each node, you can: <br/>• View status <br/>• Open the single node dashboard <br/>• Access node details via the sidebar <br/>• View active alerts <br/>• Check Machine Learning status <br/>• Check Functions capability status <br/>• Add configuration (beta) <br/>• [Add alert silencing rules](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md) <br/>• View key collected attributes |
16 +| **Right-hand bar** | Offers additional filtering and information options for the nodes displayed in the center view. |
17 +| **Node hierarchy (right bar)** | Displays a hierarchy of the nodes based on the selected ordering, making it easier to locate specific nodes by name. |
18 +| **Filters sub-tab** | Allows filtering of nodes by: <br/>• Host labels <br/>• Node status <br/>• Netdata version <br/>• Individual nodes |
19 +| **Alerts sub-tab** | Displays Room alerts and additional details for each alert. |
20 +| **Info sub-tab** | Shows detailed node information when you click the info (`i`) icon next to a node's name. |
\ No newline at end of file
docs/dashboards-and-charts/top-tab.md
+67 -18
@@ -1,27 +1,76 @@
1 -# Top tab
1 +# Top Tab
2
3 -The Top tab allows you to run [Netdata Functions](/docs/top-monitoring-netdata-functions.md) on a node where a Netdata Agent is running. These routines are exposed by a given collector.
4 -They can be used to retrieve additional information to help you troubleshoot or to trigger some action to happen on the node itself.
3 +The **Top tab** gives you access to [Netdata Functions](/docs/top-monitoring-netdata-functions.md) 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.
4
6 -> **Tip**
7 ->
8 -> You can also execute a Function from the [Nodes tab](/docs/dashboards-and-charts/nodes-tab.md), by pressing the `f(x)` button.
9 ->
10 -> **Note**
11 ->
12 -> If you get an error saying that your node can't execute Functions, check the [prerequisites](/docs/top-monitoring-netdata-functions.md).
5 +You can **use these Functions to**:
6
14 -The main view of this tab provides you with (depending on the Function) two elements: a visualization on the top and a table on the bottom.
7 +- **Retrieve** extra diagnostic **information**
8 +- Perform actions to support **troubleshooting directly on the node**
9
16 -Visualizations vary depending on the Function and most allow for user customization.
10 +:::tip
11
18 -On the top right-hand corner you can:
12 +You can also execute a Function from the [Nodes tab](/docs/dashboards-and-charts/nodes-tab.md) by pressing the `f(x)` button next to the node.
13
20 -- Refresh the results (Given that the dashboard is on `Paused` mode)
21 -- Set the update interval of the results.
14 +:::
15
23 -## Functions bar
16 +:::note
17
25 -The bar on the right-hand side allows you to select which Function to run, on which node, and then depending on the Function, there might be more fine-grained filtering available.
18 +If you receive an error saying that your node can’t execute Functions, check the [prerequisites](/docs/top-monitoring-netdata-functions.md) to ensure your node is configured properly.
19
27 -For example, the `Block-devices` Function allows you to filter per Device, Type, ID, Model and Serial number or the Block devices on your node.
20 +:::
21 +
22 +---
23 +
24 +## Top Tab Structure Overview
25 +
26 +```mermaid
27 +graph TD
28 + A[Functions Bar]
29 + A --> B[Function Execution]
30 + B --> C[Visualization]
31 + C --> D[Results Table]
32 +```
33 +
34 +:::tip
35 +
36 +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.
37 +
38 +:::
39 +
40 +---
41 +
42 +## Top Tab View
43 +
44 +The main view of the Top tab provides two elements, depending on the selected Function:
45 +
46 +| Element | Description |
47 +|-------------------|------------------------------------------------------------------------------------------------------------------------------|
48 +| **Visualization** | Located at the top of the page. The type of visualization depends on the selected Function and may allow user customization. |
49 +| **Data Table** | Located below the visualization. Displays detailed results from the executed Function. |
50 +
51 +### View Controls
52 +
53 +You can control the data refresh and update settings in the top right-hand corner of the view:
54 +
55 +| Control | Description |
56 +|-------------------------|--------------------------------------------------------------------------|
57 +| **Refresh results** | Manually refresh results (works when the dashboard is in `Paused` mode). |
58 +| **Set update interval** | Configure how often the results should refresh. |
59 +
60 +---
61 +
62 +## Functions Bar
63 +
64 +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.
65 +
66 +| Option | Description |
67 +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
68 +| **Select Function** | Choose the Function to run from the available routines. |
69 +| **Select Node** | Select the node where the Function will execute. |
70 +| **Apply Filtering** | Narrow down results using the available filters. <br/> Example for the `Block-devices` Function: <br/> - Device <br/> - Type <br/> - ID <br/> - Model <br/> - Serial number |
71 +
72 +:::tip
73 +
74 +The available filters depend on the Function you select. After choosing the Function, use the filters provided to narrow down the results and focus on the data you need.
75 +
76 +:::
\ No newline at end of file