Have one documentation page about Netdata Charts (#16042)
Fotis Voutsas committed
Oct 3, 2023 at 13:37 UTC
ed980aea2b4be53465e65e6b7e77debe2e0afb6c
5 files changed
+68
-90
docs/cloud/visualize/interact-new-charts.md
+60
-7
@@ -1,4 +1,4 @@
1
-# Interact with charts
1
+# Netdata Charts
2
3
Learn how to use Netdata's powerful charts to troubleshoot with real-time, per-second metric data.
4
@@ -37,6 +37,65 @@ With a quick glance you have immediate information available at your disposal:
37
- [Chart area](#hover-over-the-chart)
38
- [Legend with dimensions](#dimensions-bar)
39
40
+## Fundemental elements
41
+
42
+While Netdata's charts require no configuration and are easy to interact with, they have a lot of underlying complexity. 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).
43
+
44
+Understanding how these work will help you more easily navigate the dashboard,
45
+[write new alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or play around
46
+with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
47
+
48
+### Dimensions
49
+
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`.
54
+
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.
57
+
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.
61
+
62
+Dimensions can be [hidden](#show-and-hide-dimensions) to help you focus your attention.
63
+
64
+### Contexts
65
+
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.
67
+
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).
71
+
72
+By default, a chart's type affects where it fits in the menu, while its family creates submenus.
73
+
74
+Netdata also relies on contexts for [alert configuration](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) (the [`on` line](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alert-line-on)).
75
+
76
+### Families
77
+
78
+**Families** are a _single instance_ of a hardware or software resource that needs to be displayed separately from
79
+similar instances.
80
+
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.
84
+
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.
88
+
89
+Given the four example contexts, and two families of `sda` and `sdb`, Netdata will create the following charts and their
90
+names:
91
+
92
+| Context | `sda` family | `sdb` family |
93
+|:---------------|--------------------|--------------------|
94
+| `disk.io` | `disk_io.sda` | `disk_io.sdb` |
95
+| `disk.ops` | `disk_ops.sda` | `disk_ops.sdb` |
96
+| `disk.backlog` | `disk_backlog.sda` | `disk_backlog.sdb` |
97
+| `disk.util` | `disk_util.sda` | `disk_util.sdb` |
98
+
99
## Title bar
100
101
When you start interacting with a chart, you'll notice valuable information on the top bar:
@@ -77,7 +136,6 @@ Each composite chart has a definition bar to provide information and options abo
136
137
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.
138
80
-
139
> You can explore the in-depth infographic, by clicking on this image and opening it in a new tab,
140
> allowing you to zoom in to the different parts of it.
141
>
@@ -85,7 +143,6 @@ To help users instantly understand and validate the data they see on charts, we
143
> <img src="https://user-images.githubusercontent.com/2662304/235475061-44628011-3b1f-4c44-9528-34452018eb89.png" width="400" border="0" align="center"/>
144
> </a>
145
88
-
146
You can rapidly access condensed information for collected metrics, grouped by node, monitored instances, dimension, or any key/value label pair.
147
148
At the Definition bar of each chart, there are a few dropdown menus:
@@ -176,7 +233,6 @@ This menu also presents the contribution of each original dimensions on the char
233
234
<img src="https://user-images.githubusercontent.com/70198089/236138796-08dc6ac6-9a50-4913-a46d-d9bbcedd48f6.png" width="900"/>
235
179
-
236
### Labels dropdown
237
238
In this dropdown, you can view or filter the contributing time-series labels of the chart.
@@ -293,7 +349,6 @@ The available manipulation tools you can select are:
349
- Chart zoom
350
- Reset zoom
351
296
-
352
### Pan
353
354
Drag your mouse/finger to the right to pan backward through time, or drag to the left to pan forward in time. Think of
@@ -340,10 +395,8 @@ Zooming out lets you see metrics within the larger context, such as the last hou
395
396
The bottom legend where you can see the dimensions of the chart can be ordered by:
397
343
-
398
<img src="https://user-images.githubusercontent.com/70198089/236144658-6c3d0e31-9bcb-45f3-bb95-4eafdcbb0a58.png" width="300" />
399
346
-
400
- Dimension name (Ascending or Descending)
401
- Dimension value (Ascending or Descending)
402
- Dimension Anomaly Rate (Ascending or Descending)
docs/dashboard/customize.md
+5
-1
@@ -1,5 +1,9 @@
1
# Customize the standard dashboard
2
3
+> ### Disclaimer
4
+>
5
+> This document is only applicable to the v1 version of the dashboard and doesn't affect the [Netdata Dashboard](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/accessing-netdata-dashboards.md).
6
+
7
While the [Netdata dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md) comes preconfigured with hundreds of charts and
8
thousands of metrics, you may want to alter your experience based on a particular use case or preferences.
9
@@ -69,4 +73,4 @@ the following line to the `[web]` section to tell Netdata where to find your cus
73
custom dashboard_info.js = your_dashboard_info_file.js
74
```
75
72
-Reload your browser tab to see your custom configuration.
76
+Reload your browser tab to see your custom configuration.
\ No newline at end of file
docs/dashboard/dimensions-contexts-families.md
deleted
-69
@@ -1,69 +0,0 @@
1
-# Chart dimensions, contexts, and families
2
-
3
-While Netdata's charts require no configuration and are [easy to interact with](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md),
4
-they have a lot of underlying complexity. To meaningfully organize charts out of the box based on what's happening in
5
-your nodes, Netdata uses the concepts of **dimensions**, **contexts**, and **families**.
6
-
7
-Understanding how these work will help you more easily navigate the dashboard,
8
-[write new alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or play around
9
-with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
10
-
11
-## Dimension
12
-
13
-A **dimension** is a value that gets shown on a chart. The value can be raw data or calculated values, such as the
14
-average (the default), minimum, or maximum. These values can then be given any type of unit. For example, CPU
15
-utilization is represented as a percentage, disk I/O as `MiB/s`, and available RAM as an absolute value in `MiB` or
16
-`GiB`.
17
-
18
-Beneath every chart (or on the right-side if you configure the dashboard) is a legend of dimensions. When there are
19
-multiple dimensions, you'll see a different entry in the legend for each dimension.
20
-
21
-The **Apps CPU Time** chart (with the [context](#context) `apps.cpu`), which visualizes CPU utilization of
22
-different types of processes/services/applications on your node, always provides a vibrant example of a chart with
23
-multiple dimensions.
24
-
25
-
27
-
28
-The chart shows 13 unique dimensions, such as `httpd` for the CPU utilization for web servers, `kernel` for anything
29
-related to the Linux kernel, and so on. In your dashboard, these specific dimensions will almost certainly be different.
30
-
31
-Dimensions can be [hidden](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#show-and-hide-dimensions) to help you focus your
32
-attention.
33
-
34
-## Context
35
-
36
-A **context** is a way of grouping charts by the types of metrics collected and dimensions displayed. It's kind of like
37
-a machine-readable naming and organization scheme.
38
-
39
-For example, the **Apps CPU Time** has the context `apps.cpu`. A little further down on the dashboard is a similar
40
-chart, **Apps Real Memory (w/o shared)** with the context `apps.mem`. The `apps` portion of the context is the **type**,
41
-whereas anything after the `.` is specified either by the chart's developer or by the [**family**](#family).
42
-
43
-By default, a chart's type affects where it fits in the menu, while its family creates submenus.
44
-
45
-Netdata also relies on contexts for [alert configuration](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) (the [`on`
46
-line](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alert-line-on)).
47
-
48
-## Family
49
-
50
-**Families** are a _single instance_ of a hardware or software resource that needs to be displayed separately from
51
-similar instances.
52
-
53
-For example, let's look at the **Disks** section, which contains a number of charts with contexts like `disk.io`,
54
-`disk.ops`, `disk.backlog`, and `disk.util`. If your node has multiple disk drives at `sda` and `sdb`, Netdata creates
55
-a separate family for each.
56
-
57
-Netdata now merges the contexts and families to create charts that are grouped by family, following a
58
-`[context].[family]` naming scheme, so that you can see the `disk.io` and `disk.ops` charts for `sda` right next to each
59
-other.
60
-
61
-Given the four example contexts, and two families of `sda` and `sdb`, Netdata will create the following charts and their
62
-names:
63
-
64
-| Context | `sda` family | `sdb` family |
65
-|:---------------|--------------------|--------------------|
66
-| `disk.io` | `disk_io.sda` | `disk_io.sdb` |
67
-| `disk.ops` | `disk_ops.sda` | `disk_ops.sdb` |
68
-| `disk.backlog` | `disk_backlog.sda` | `disk_backlog.sdb` |
69
-| `disk.util` | `disk_util.sda` | `disk_util.sdb` |
docs/glossary.md
+3
-3
@@ -41,7 +41,7 @@ Use the alphabatized list below to find the answer to your single-term questions
41
42
- [**Composite Charts**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#overview-and-single-node-view): Charts used by the **Overview** tab which aggregate metrics from all the nodes (or a filtered selection) in a given War Room.
43
44
-- [**Context**](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md#context): A way of grouping charts by the types of metrics collected and dimensions displayed. It's kind of like a machine-readable naming and organization scheme.
44
+- [**Context**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#contexts): A way of grouping charts by the types of metrics collected and dimensions displayed. It's kind of like a machine-readable naming and organization scheme.
45
46
- [**Custom dashboards**](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) A dashboard that you can create using simple HTML (no javascript is required for basic dashboards).
47
@@ -51,7 +51,7 @@ Use the alphabatized list below to find the answer to your single-term questions
51
52
- [**Definition Bar**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md): Bar within a composite chart that provides important information and options about the metrics within the chart.
53
54
-- [**Dimension**](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md#dimension): A dimension is a value that gets shown on a chart.
54
+- [**Dimension**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#dimensions): A dimension is a value that gets shown on a chart.
55
56
- [**Distributed Architecture**](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md): The data architecture mindset with which Netdata was built, where all data are collected and stored on the edge, whenever it's possible, creating countless benefits.
57
@@ -61,7 +61,7 @@ Use the alphabatized list below to find the answer to your single-term questions
61
62
## F
63
64
-- [**Family**](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md#family): 1. What we consider our Netdata community of users and engineers. 2. A single instance of a hardware or software resource that needs to be displayed separately from similar instances.
64
+- [**Family**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#families): 1. What we consider our Netdata community of users and engineers. 2. A single instance of a hardware or software resource that needs to be displayed separately from similar instances.
65
66
- [**Flood Protection**](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#flood-protection): If a node has too many state changes like firing too many alerts or going from reachable to unreachable, Netdata Cloud enables flood protection. As long as a node is in flood protection mode, Netdata Cloud does not send notifications about this node
67
web/server/README.md
-10
@@ -1,13 +1,3 @@
1
-<!--
2
-title: "Web server"
3
-description: "The Netdata Agent's local static-threaded web server serves dashboards and real-time visualizations with security and DDoS protection."
4
-type: reference
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/web/server/README.md
6
-sidebar_label: "Web server"
7
-learn_status: "Published"
8
-learn_rel_path: "Configuration"
9
--->
10
-
1
# Web server
2
3
The Netdata web server is `static-threaded`, with a fixed, configurable number of threads.