Fix links to chart interactions (#14609)
Chris Akritidis committed
Feb 25, 2023 at 08:57 UTC
753fabbc6acddb9cf59bfbca44a55f63d35a39a8
12 files changed
+33
-128
collectors/README.md
+1
-1
@@ -34,7 +34,7 @@ If the collector finds compatible metrics exposed on the configured endpoint, it
34
Netdata Agent gathers these metrics, sends them to the
35
[database engine for storage](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md)
36
, and immediately
37
-[visualizes them meaningfully](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
37
+[visualizes them meaningfully](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
38
on dashboards.
39
40
Each collector comes with a pre-defined configuration that matches the default setup for that application. This endpoint
docs/cloud/alerts-notifications/view-active-alerts.md
+2
-29
@@ -1,15 +1,4 @@
1
-<!--
2
-title: "View active alerts"
3
-description: >-
4
- "Track the health of your infrastructure in one place by taking advantage of the powerful health monitoring
5
- watchdog running on every node."
6
-type: "how-to"
7
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.md"
8
-sidebar_label: "View active alerts"
9
-learn_status: "Published"
10
-learn_topic_type: "Tasks"
11
-learn_rel_path: "Integrations/Notify/Cloud alert notifications"
12
--->
1
+# View active alerts
2
3
Netdata Cloud receives information about active alerts on individual nodes in your infrastructure and updates the
4
interface based on those status changes.
@@ -50,7 +39,7 @@ moment your node triggered this alert.
39
40
41
You can
53
-then [select this area](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md#select)
42
+then [highlight this area](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#highlight)
43
with `Alt/⌘ + mouse selection` to highlight the alerted timeframe while you explore other charts for root cause
44
analysis.
45
@@ -58,19 +47,3 @@ Or, select the area and
47
run [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to
48
filter the single-node
49
dashboard to only those charts most likely to be connected to the alert.
61
-
62
-## What's next?
63
-
64
-Learn more about the features of the Smartboard in
65
-its [reference](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/smartboard.md)
66
-doc. To stay notified of active alerts,
67
-enable [centralized alert notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
68
-from Netdata Cloud.
69
-
70
-If you're through with setting up alerts, it might be time
71
-to [invite your team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md).
72
-
73
-Check out our recommendations on organizing and
74
-using [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md) and
75
-[War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md) to streamline your processes once
76
-you find an alert in Netdata Cloud.
docs/cloud/war-rooms.md
+1
-1
@@ -69,7 +69,7 @@ can always come right back to your preferred setup.
69
70
A War Room has three different states: playing, paused, and force playing. The default playing state refreshes charts
71
every second as long as the browser tab is in
72
-focus. [Interacting with a chart](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
72
+focus. [Interacting with a chart](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
73
pauses
74
the War Room. Once the tab loses focus, charts pause automatically.
75
docs/dashboard/customize.md
+4
-18
@@ -18,8 +18,8 @@ thousands of metrics, you may want to alter your experience based on a particula
18
19
## Dashboard settings
20
21
-To change dashboard settings, click the on the **settings** icon 
21
+To change dashboard settings, click the on the **settings** icon
22
+
23
in the top panel.
24
25
These settings only affect how the dashboard behaves in your browser. They take effect immediately and are permanently
@@ -30,7 +30,8 @@ Here are a few popular settings:
30
31
### Change chart legend position
32
33
-Find this setting under the **Visual** tab. By default, Netdata places the [legend of dimensions](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md#dimension) _below_ charts.
33
+Find this setting under the **Visual** tab. By default, Netdata places the
34
+[legend of dimensions](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md#dimension) _below_ charts.
35
Click this toggle to move the legend to the _right_ of charts.
36
37
@@ -82,18 +83,3 @@ the following line to the `[web]` section to tell Netdata where to find your cus
83
```
84
85
Reload your browser tab to see your custom configuration.
85
-
86
-## What's next?
87
-
88
-If you're keen on continuing to customize your Netdata experience, check out our docs on [building new custom
89
-dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) with HTML, CSS, and JavaScript.
90
-
91
-### Further reading & related information
92
-
93
-- Dashboard
94
- - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md)
95
- - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
96
- - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md)
97
- - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md)
98
- - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md)
99
- - **[Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md)**
docs/dashboard/dimensions-contexts-families.md
+5
-29
@@ -1,26 +1,12 @@
1
-<!--
2
-title: "Chart dimensions, contexts, and families"
3
-description: >-
4
- "Netdata organizes charts into dimensions, contexts, and families to automatically
5
- and meaningfully organize thousands of metrics into interactive charts."
6
-type: "explanation"
7
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md"
8
-sidebar_label: "Chart dimensions, contexts, and families"
9
-learn_status: "Published"
10
-learn_topic_type: "Concepts"
11
-learn_rel_path: "Concepts"
12
--->
13
-
1
# Chart dimensions, contexts, and families
2
16
-While Netdata's charts require no configuration and are [easy to interact with](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md),
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
20
-Understanding how these work will help you more easily navigate the dashboard, [write new
21
-alarms](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).
22
-
23
-For a refresher on the anatomy of a chart, see [dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md).
7
+Understanding how these work will help you more easily navigate the dashboard,
8
+[write new alarms](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
@@ -42,7 +28,7 @@ dimensions](https://user-images.githubusercontent.com/1153921/114207816-a5cb7400
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
45
-Dimensions can be [hidden](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md#show-and-hide-dimensions) to help you focus your
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
@@ -90,13 +76,3 @@ dashboard. We recommend looking into [using the timeframe selector](https://gith
76
If you feel comfortable with the [dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md) and interacting with charts, we
77
recommend learning about [configuration](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md). While Netdata doesn't _require_ a complicated setup
78
process or a query language to create charts, there are a lot of ways to tweak the experience to match your needs.
93
-
94
-### Further reading & related information
95
-
96
-- Dashboard
97
- - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md)
98
- - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
99
- - **[Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md)**
100
- - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md)
101
- - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md)
102
- - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md)
docs/dashboard/how-dashboard-works.md
+2
-2
@@ -54,7 +54,7 @@ submenus](https://user-images.githubusercontent.com/1153921/80832425-7c528600-8b
54
55
## Charts
56
57
-Every **chart** in the Netdata dashboard is [fully interactive](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md). Netdata
57
+Every **chart** in the Netdata dashboard is fully interactive. Netdata
58
synchronizes your interactions to help you understand exactly how a node behaved in any timeframe, whether that's
59
seconds or days.
60
@@ -76,7 +76,7 @@ like pushing the current timeframe off the screen to see what came before or aft
76
77
To zoom, press and hold `Shift`, then use your mouse's scroll wheel, or a two-finger pinch if you're using a touchpad.
78
79
-See [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md) for all the possible ways to interact with the charts on
79
+See [interact with charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) for all the possible ways to interact with the charts on
80
your dashboard.
81
82
## Alarms
docs/dashboard/import-export-print-snapshot.md
-16
@@ -72,19 +72,3 @@ in the top panel.
72
73
When you click **Print**, Netdata opens a new window to render every chart. This might take some time. When finished,
74
Netdata opens a browser print dialog for you to save to PDF or print.
75
-
76
-## What's next?
77
-
78
-Now that you understand snapshots, now is a good time to delve deeper into some of the dashboard's lesser-known
79
-features, such as [customization](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md) or [building new, custom
80
-dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md).
81
-
82
-### Further reading & related information
83
-
84
-- Dashboard
85
- - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md)
86
- - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
87
- - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md)
88
- - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md)
89
- - **[Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md)**
90
- - [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md)
\ No newline at end of file
docs/dashboard/visualization-date-and-time-controls.md
+2
-2
@@ -15,7 +15,7 @@ learn_rel_path: "Concepts"
15
16
### Pick timeframes to visualize
17
18
-While [panning through time and zooming in/out](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md) from charts it is helpful when
18
+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
19
you're looking a recent history, or want to do granular troubleshooting, what if you want to see metrics from 6 hours
20
ago? Or 6 days?
21
@@ -119,7 +119,7 @@ the theme to editing the text that accompanies every section of charts.
119
120
- Dashboard
121
- [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md)
122
- - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
122
+ - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
123
- [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md)
124
- [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md)
125
- [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md)
docs/guides/monitor/lamp-stack.md
+2
-3
@@ -171,10 +171,9 @@ If the Netdata Agent isn't already open in your browser, open a new tab and navi
171
Netdata automatically organizes all metrics and charts onto a single page for easy navigation. Peek at gauges to see
172
overall system performance, then scroll down to see more. Click-and-drag with your mouse to pan _all_ charts back and
173
forth through different time intervals, or hold `SHIFT` and use the scrollwheel (or two-finger scroll) to zoom in and
174
-out. Check out our doc on [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md) for all the details.
174
+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.
175
176
-
176
+
177
178
The **System Overview** section, which you can also see in the right-hand menu, contains key hardware monitoring charts,
179
including CPU utilization, memory page faults, network monitoring, and much more. The **Applications** section shows you
docs/metrics-storage-management/how-streaming-works.md
+6
-20
@@ -1,32 +1,18 @@
1
-<!--
2
-title: "How metrics streaming works"
3
-description: >-
4
- "Netdata's real-time streaming allows you to replicate metrics data
5
- across multiple nodes, or centralize all your metrics data into a single
6
- time-series database (TSDB)."
7
-type: "explanation"
8
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md"
9
-sidebar_label: "How metrics streaming works"
10
-learn_status: "Published"
11
-learn_topic_type: "Concepts"
12
-learn_rel_path: "Concepts"
13
--->
14
-
1
# How metrics streaming works
2
3
Each node running Netdata can stream the metrics it collects, in real time, to another node. Streaming allows you to
4
replicate metrics data across multiple nodes, or centralize all your metrics data into a single time-series database
5
(TSDB).
6
21
-When one node streams metrics to another, the node receiving metrics can visualize them on the
22
-[dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md), run health checks to [trigger
23
-alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) and [send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md), and
7
+When one node streams metrics to another, the node receiving metrics can visualize them on the dashboard, run health checks to
8
+[trigger alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) and
9
+[send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md), and
10
[export](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) all metrics to an external TSDB. When Netdata streams metrics to another
11
Netdata, the receiving one is able to perform everything a Netdata instance is capable of.
12
13
Streaming lets you decide exactly how you want to store and maintain metrics data. While we believe Netdata's
28
-[distributed architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) is ideal for speed and scale, streaming
29
-provides centralization options for those who want to maintain only a single TSDB instance.
14
+[distributed architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) is
15
+ideal for speed and scale, streaming provides centralization options and high data availability.
16
17
## Streaming basics
18
@@ -96,4 +82,4 @@ Take your streaming setup even further by [exporting metrics](https://github.com
82
- Streaming
83
- **[How Netdata streams metrics](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/how-streaming-works.md)**
84
- [Enable streaming between nodes](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/enable-streaming.md)
99
- - [Streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.md)
\ No newline at end of file
85
+ - [Streaming reference](https://github.com/netdata/netdata/blob/master/docs/metrics-storage-management/reference-streaming.md)
packaging/installer/README.md
+7
-6
@@ -23,20 +23,21 @@ To install Netdata in minutes on your platform:
23
2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
24
3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
25
26
-Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md).
26
+Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts
27
+in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md).
28
29
Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting,
30
but we have some hints on what you might want to do next.
31
32
### What's next?
33
33
-Explore our [general advanced installation options and troubleshooting](#advanced-installation-options-and-troubleshooting), specific options for the [single line installer](#install-on-linux-with-one-line-installer), or [other installation methods](#other-installation-methods).
34
+Explore our [general advanced installation options and troubleshooting](#advanced-installation-options-and-troubleshooting), specific options
35
+for the [single line installer](#install-on-linux-with-one-line-installer), or [other installation methods](#other-installation-methods).
36
37
#### Agent user interface
38
39
To access the UI provided by the locally installed agent, open a browser and navigate to `http://NODE:19999`, replacing `NODE` with either `localhost` or
38
-the hostname/IP address of the remote node. You can also read more about [how the agent dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md), or dive directly into the many ways
39
-to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md).
40
+the hostname/IP address of the remote node. You can also read more about [how the agent dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md).
41
42
#### Configuration
43
@@ -59,8 +60,8 @@ community, but you may want to [edit alarms](https://github.com/netdata/netdata/
60
61
#### Make your deployment production ready
62
62
-Both [securing Netdata](https://github.com/netdata/netdata/blob/master/docs/netdata-security.md) and [setting up replication](https://github.com/netdata/netdata/blob/master/streaming/README.md) are strongly recommended.
63
-
63
+Go through our [deployment strategies](https://github.com/netdata/netdata/edit/master/docs/category-overview-pages/deployment-strategies.md),
64
+for suggested configuration changes for production deployments.
65
66
## Install on Linux with one-line installer
67
web/server/README.md
+1
-1
@@ -48,7 +48,7 @@ Scroll down to the `[web]` section to find the following settings.
48
| `accept a streaming request every seconds` | `0` | Can be used to set a limit on how often a parent node will accept streaming requests from child nodes in a [streaming and replication setup](https://github.com/netdata/netdata/blob/master/streaming/README.md). |
49
| `respect do not track policy` | `no` | If set to `yes`, Netdata will respect the user's browser preferences for [Do Not Track](https://www.eff.org/issues/do-not-track) (DNT) and storing cookies. If DNT is _enabled_ in the browser, and this option is set to `yes`, users will not be able to sign in to Netdata Cloud via their local Agent dashboard, and their node will not connect to any [registry](https://github.com/netdata/netdata/blob/master/registry/README.md). For certain browsers, users must disable DNT and change this option to `yes` for full functionality. |
50
| `x-frame-options response header` | ` ` | Avoid [clickjacking attacks](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options), by ensuring that the content is not embedded into other sites. |
51
-| `allow connections from` | `localhost *` | Declare which IP addresses or full-qualified domain names (FQDNs) are allowed to connect to the web server, including the [dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md) or [HTTP API](https://github.com/netdata/netdata/blob/master/web/api/README.md). This is a global setting with higher priority to any of the ones below. |
51
+| `allow connections from` | `localhost *` | Declare which IP addresses or full-qualified domain names (FQDNs) are allowed to connect to the web server, including the [dashboard](https://github.com/netdata/netdata/blob/master/web/gui/README.md) or [HTTP API](https://github.com/netdata/netdata/blob/master/web/api/README.md). This is a global setting with higher priority to any of the ones below. |
52
| `allow connections by dns` | `heuristic` | See the [access list examples](#access-lists) for details on using `allow` settings. |
53
| `allow dashboard from` | `localhost *` | |
54
| `allow dashboard by dns` | `heuristic` | |