move netdata charts documentation to proper folder (#17486)
Fotis Voutsas committed
Apr 23, 2024 at 10:09 UTC
34336e833a0b155b366ceed06b2be450ae6faa4d
13 files changed
+23
-23
docs/category-overview-pages/accessing-netdata-dashboards.md
+1
-1
@@ -12,7 +12,7 @@ was shipped with the agent.
12
## Main sections
13
14
The Netdata dashboard consists of the following main sections:
15
-* [Netdata charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
15
+* [Netdata charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md)
16
* [Infrastructure Overview](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md)
17
* [Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
18
* [Custom dashboards](https://learn.netdata.cloud/docs/visualizations/custom-dashboards)
docs/cloud/visualize/kubernetes.md
+2
-2
@@ -2,7 +2,7 @@
2
3
The Netdata dashboards feature enhanced visualizations for the resource utilization of Kubernetes (k8s) clusters, embedded in the default [Metrics tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/metrics-tab-and-single-node-tabs.md) dashboard.
4
5
-These visualizations include a health map for viewing the status of k8s pods/containers, in addition to [Netdata charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) for viewing per-second CPU, memory, disk, and networking metrics from k8s nodes.
5
+These visualizations include a health map for viewing the status of k8s pods/containers, in addition to [Netdata charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md) for viewing per-second CPU, memory, disk, and networking metrics from k8s nodes.
6
7
See our [Kubernetes deployment instructions](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md) for details on deploying Netdata on your Kubernetes cluster.
8
@@ -35,7 +35,7 @@ their associated pods.
35
36
At the top of the Kubernetes containers section there is a map, that with a given context colorizes the containers in terms of their utilization.
37
38
-The filtering of this map is controlled by using the [NIDL framework](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#nidl-framework) from the definition bar of the chart.
38
+The filtering of this map is controlled by using the [NIDL framework](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#nidl-framework) from the definition bar of the chart.
39
40
### Detailed information
41
docs/dashboard/dashboards-tab.md
+3
-3
@@ -12,7 +12,7 @@ In the modal, give your custom dashboard a name, and click **+ Add**.
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.
14
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](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md), meaning you can configure all the aspects of the [NIDL framework](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#nidl-framework) of the chart and more in detail, you can:
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](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md), meaning you can configure all the aspects of the [NIDL framework](https://github.com/netdata/netdata/blob/master/docs/dashboard/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
@@ -21,7 +21,7 @@ In the modal, give your custom dashboard a name, and click **+ Add**.
21
- select labels
22
- select the aggregation function over time
23
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](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#title-bar), and select which of the final dimensions you want to be visible and in what order, from the [Dimensions bar](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#dimensions-bar).
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](https://github.com/netdata/netdata/blob/master/docs/dashboard/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](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#dimensions-bar).
25
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.
27
@@ -35,7 +35,7 @@ Dashboards are designed to be interactive and flexible so you can design them to
35
36
### Charts
37
38
-The charts you add to any dashboard are [fully interactive](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md), just like any other Netdata chart. You can zoom in and out, highlight timeframes, and more.
38
+The charts you add to any dashboard are [fully interactive](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md), just like any other Netdata chart. You can zoom in and out, highlight timeframes, and more.
39
40
Charts also synchronize as you interact with them, even across contexts _or_ nodes.
41
docs/dashboard/metrics-tab-and-single-node-tabs.md
+2
-2
@@ -1,6 +1,6 @@
1
# Metrics tab and single node tabs
2
3
-The Metrics tab is where all the time series [charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) for all the nodes of a War Room are located.
3
+The Metrics tab is where all the time series [charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md) for all the nodes of a War Room are located.
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.
6
@@ -8,7 +8,7 @@ From this tab, a user can also reach the Integrations tab and run [Metric Correl
8
9
## Dashboard structure
10
11
-The dashboard consists of various charts presented in different chart types. They are categorized based on their [context](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-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.
11
+The dashboard consists of various charts presented in different chart types. They are categorized based on their [context](https://github.com/netdata/netdata/blob/master/docs/dashboard/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
13
## Chart navigation Menu
14
docs/dashboard/netdata-charts.md
renamed
docs/dashboard/visualization-date-and-time-controls.md
+1
-1
@@ -27,7 +27,7 @@ The date and time selector allows you to change the visible timeframe and change
27
28
### Pick timeframes to visualize
29
30
-While [panning through time and zooming in/out](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) from charts it is helpful when you're looking a recent history, or want to do granular troubleshooting, what if you want to see metrics from 6 hours ago? Or 6 days?
30
+While [panning through time and zooming in/out](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md) from charts it is helpful when you're looking a recent history, or want to do granular troubleshooting, what if you want to see metrics from 6 hours ago? Or 6 days?
31
32
Netdata's dashboard features a **timeframe selector** to help you visualize specific timeframes in a few helpful ways.
33
By default, it shows a certain number of minutes of historical metrics based on the your browser's viewport to ensure it's always showing per-second granularity.
docs/glossary.md
+6
-6
@@ -17,7 +17,7 @@ Use the alphabatized list below to find the answer to your single-term questions
17
18
- [**Agent-cloud link** or **ACLK**](https://github.com/netdata/netdata/blob/master/src/aclk/README.md): The Agent-Cloud link (ACLK) is the mechanism responsible for securely connecting a Netdata Agent to your web browser through Netdata Cloud.
19
20
-- [**Aggregate Function**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#aggregate-functions-over-time): A function applied When the granularity of the data collected is higher than the plotted points on the chart.
20
+- [**Aggregate Function**](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#aggregate-functions-over-time): A function applied When the granularity of the data collected is higher than the plotted points on the chart.
21
22
- [**Alerts** (formerly **Alarms**)](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md): With the information that appears on Netdata Cloud and the local dashboard about active alerts, you can configure alerts to match your infrastructure's needs or your team's goals.
23
@@ -39,7 +39,7 @@ Use the alphabatized list below to find the answer to your single-term questions
39
40
- [**Community**](https://community.netdata.cloud/): As a company with a passion and genesis in open-source, we are not just very proud of our community, but we consider our users, fans, and chatters to be an imperative part of the Netdata experience and culture.
41
42
-- [**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.
42
+- [**Context**](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-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.
43
44
- [**Custom dashboards**](https://github.com/netdata/netdata/blob/master/src/web/gui/custom/README.md) A dashboard that you can create using simple HTML (no javascript is required for basic dashboards).
45
@@ -47,9 +47,9 @@ Use the alphabatized list below to find the answer to your single-term questions
47
48
- [**Dashboard**](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/accessing-netdata-dashboards.md): Out-of-the-box visual representation of metrics to provide insight into your infrastructure, its health and performance.
49
50
-- [**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.
50
+- [**Definition Bar**](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md): Bar within a composite chart that provides important information and options about the metrics within the chart.
51
52
-- [**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.
52
+- [**Dimension**](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#dimensions): A dimension is a value that gets shown on a chart.
53
54
## E
55
@@ -57,7 +57,7 @@ Use the alphabatized list below to find the answer to your single-term questions
57
58
## F
59
60
-- [**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.
60
+- [**Family**](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-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.
61
62
- [**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
63
@@ -67,7 +67,7 @@ Use the alphabatized list below to find the answer to your single-term questions
67
68
- [**Guided Troubleshooting**](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/troubleshooting-overview.md): Troubleshooting with our Machine-Learning-powered tools designed to give you a cutting edge advantage in your troubleshooting battles.
69
70
-- [**Group by**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#group-by-dimension-node-or-chart): The drop-down on the dimension bar of a composite chart that allows you to group metrics by dimension, node, or chart.
70
+- [**Group by**](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#group-by-dimension-node-or-chart): The drop-down on the dimension bar of a composite chart that allows you to group metrics by dimension, node, or chart.
71
72
## H
73
docs/guides/monitor/kubernetes-k8s-netdata.md
+1
-1
@@ -156,7 +156,7 @@ different namespaces.
156
158
159
-Each composite chart has a [definition bar](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#definition-bar)
159
+Each composite chart has a [definition bar](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#definition-bar)
160
for complete customization. For example, grouping the top chart by `k8s_container_name` reveals new information.
161
162
docs/guides/monitor/lamp-stack.md
+1
-1
@@ -164,7 +164,7 @@ If the Netdata Agent isn't already open in your browser, open a new tab and navi
164
Netdata automatically organizes all metrics and charts onto a single page for easy navigation. Peek at gauges to see
165
overall system performance, then scroll down to see more. Click-and-drag with your mouse to pan _all_ charts back and
166
forth through different time intervals, or hold `SHIFT` and use the scrollwheel (or two-finger scroll) to zoom in and
167
-out. Check out our doc on [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) for all the details.
167
+out. Check out our doc on [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md) for all the details.
168
169
170
docs/quickstart/infrastructure.md
+1
-1
@@ -100,7 +100,7 @@ single-node dashboards in Netdata Cloud to drill down on specific issues, scrub
100
historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
101
102
Learn more about [interacting with
103
-dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) to get the most from all of Netdata's real-time
103
+dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md) to get the most from all of Netdata's real-time
104
metrics.
105
106
### Create new dashboards
src/collectors/README.md
+1
-1
@@ -25,7 +25,7 @@ If the collector finds compatible metrics exposed on the configured endpoint, it
25
Netdata Agent gathers these metrics, sends them to the
26
[database engine for storage](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md)
27
, and immediately
28
-[visualizes them meaningfully](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
28
+[visualizes them meaningfully](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md)
29
on dashboards.
30
31
Each collector comes with a pre-defined configuration that matches the default setup for that application. This endpoint
src/collectors/python.d.plugin/pandas/integrations/pandas.md
+2
-2
@@ -136,8 +136,8 @@ Every configuration JOB starts with a `job_name` value which will appear in the
136
| chart_configs | an array of chart configuration dictionaries | [] | yes |
137
| chart_configs.name | name of the chart to be displayed in the dashboard. | None | yes |
138
| chart_configs.title | title of the chart to be displayed in the dashboard. | None | yes |
139
-| chart_configs.family | [family](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#families) of the chart to be displayed in the dashboard. | None | yes |
140
-| chart_configs.context | [context](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#contexts) of the chart to be displayed in the dashboard. | None | yes |
139
+| chart_configs.family | [family](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#families) of the chart to be displayed in the dashboard. | None | yes |
140
+| chart_configs.context | [context](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#contexts) of the chart to be displayed in the dashboard. | None | yes |
141
| chart_configs.type | the type of the chart to be displayed in the dashboard. | None | yes |
142
| chart_configs.units | the units of the chart to be displayed in the dashboard. | None | yes |
143
| chart_configs.df_steps | a series of pandas operations (one per line) that each returns a dataframe. | None | yes |
src/collectors/python.d.plugin/pandas/metadata.yaml
+2
-2
@@ -90,11 +90,11 @@ modules:
90
default_value: None
91
required: true
92
- name: chart_configs.family
93
- description: "[family](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#families) of the chart to be displayed in the dashboard."
93
+ description: "[family](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#families) of the chart to be displayed in the dashboard."
94
default_value: None
95
required: true
96
- name: chart_configs.context
97
- description: "[context](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#contexts) of the chart to be displayed in the dashboard."
97
+ description: "[context](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md#contexts) of the chart to be displayed in the dashboard."
98
default_value: None
99
required: true
100
- name: chart_configs.type