archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-05-05 09:40:18 +00:00
Code Issues Projects Releases Wiki Activity

Have one documentation page about Netdata Charts ()

Browse source
This commit is contained in:
Fotis Voutsas 2023-10-03 13:37:52 +03:00 • committed by GitHub
parent 2da22320ef
commit ed980aea2b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 68 additions and 90 deletions

6
docs/dashboard/customize.md
View file

@ -1,5 +1,9 @@
# Customize the standard dashboard
> ### Disclaimer
>
> 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).
While the [Netdata dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md) comes preconfigured with hundreds of charts and
thousands of metrics, you may want to alter your experience based on a particular use case or preferences.
@ -69,4 +73,4 @@ the following line to the `[web]` section to tell Netdata where to find your cus
custom dashboard_info.js = your_dashboard_info_file.js
```
Reload your browser tab to see your custom configuration.
Reload your browser tab to see your custom configuration.

69
docs/dashboard/dimensions-contexts-families.md
View file

@ -1,69 +0,0 @@
# Chart dimensions, contexts, and families
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),
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**, **contexts**, and **families**.
Understanding how these work will help you more easily navigate the dashboard,
[write new alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or play around
with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
## Dimension
A **dimension** is a value that gets shown on a chart. The value can be raw data or calculated values, such as the
average (the default), minimum, or maximum. These values can then be given any type of unit. For example, CPU
utilization is represented as a percentage, disk I/O as `MiB/s`, and available RAM as an absolute value in `MiB` or
`GiB`.
Beneath every chart (or on the right-side if you configure the dashboard) is a legend of dimensions. When there are
multiple dimensions, you'll see a different entry in the legend for each dimension.
The **Apps CPU Time** chart (with the [context](#context) `apps.cpu`), which visualizes CPU utilization of
different types of processes/services/applications on your node, always provides a vibrant example of a chart with
multiple dimensions.
![An example apps.cpu chart with many
dimensions](https://user-images.githubusercontent.com/1153921/114207816-a5cb7400-9911-11eb-8800-06f60b745f9c.png)
The chart shows 13 unique dimensions, such as `httpd` for the CPU utilization for web servers, `kernel` for anything
related to the Linux kernel, and so on. In your dashboard, these specific dimensions will almost certainly be different.
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
attention.
## Context
A **context** is 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.
For example, the **Apps CPU Time** has the context `apps.cpu`. A little further down on the dashboard is a similar
chart, **Apps Real Memory (w/o shared)** with the context `apps.mem`. The `apps` portion of the context is the **type**,
whereas anything after the `.` is specified either by the chart's developer or by the [**family**](#family).
By default, a chart's type affects where it fits in the menu, while its family creates submenus.
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)).
## Family
**Families** are a _single instance_ of a hardware or software resource that needs to be displayed separately from
similar instances.
For example, let's look at the **Disks** section, which contains a number of charts with contexts like `disk.io`,
`disk.ops`, `disk.backlog`, and `disk.util`. If your node has multiple disk drives at `sda` and `sdb`, Netdata creates
a separate family for each.
Netdata now merges the contexts and families to create charts that are grouped by family, following a
`[context].[family]` naming scheme, so that you can see the `disk.io` and `disk.ops` charts for `sda` right next to each
other.
Given the four example contexts, and two families of `sda` and `sdb`, Netdata will create the following charts and their
names:
| Context | `sda` family | `sdb` family |
|:---------------|--------------------|--------------------|
| `disk.io` | `disk_io.sda` | `disk_io.sdb` |
| `disk.ops` | `disk_ops.sda` | `disk_ops.sdb` |
| `disk.backlog` | `disk_backlog.sda` | `disk_backlog.sdb` |
| `disk.util` | `disk_util.sda` | `disk_util.sdb` |