summaryrefslogtreecommitdiffstats
path: root/docs/dashboards-and-charts/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/dashboards-and-charts/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/dashboards-and-charts/README.md b/docs/dashboards-and-charts/README.md
new file mode 100644
index 000000000..372f2030b
--- /dev/null
+++ b/docs/dashboards-and-charts/README.md
@@ -0,0 +1,40 @@
+# Dashboards and Charts
+
+This guide covers how to access both Agent and Cloud dashboards, along with links to explore specific sections in more detail.
+
+When you access the Netdata dashboard through the Cloud, you'll always have the latest version available.
+
+By default, the Agent dashboard shows the latest version (matching Netdata Cloud). However, there are a few exceptions:
+
+- Without internet access, the Agent can't download the newest dashboards. In this case, it will automatically use the bundled version.
+- 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).
+
+## Main sections
+
+The Netdata dashboard consists of the following main sections:
+
+- [Home tab](/docs/dashboards-and-charts/home-tab.md)
+- [Nodes tab](/docs/dashboards-and-charts/nodes-tab.md)
+- [Netdata charts](/docs/dashboards-and-charts/netdata-charts.md)
+- [Metrics tab and single node tabs](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md)
+- [Top tab](/docs/dashboards-and-charts/top-tab.md)
+- [Logs tab](/docs/dashboards-and-charts/logs-tab.md)
+- [Dashboards tab](/docs/dashboards-and-charts/dashboards-tab.md)
+- [Alerts tab](/docs/dashboards-and-charts/alerts-tab.md)
+- [Events tab](/docs/dashboards-and-charts/events-feed.md)
+
+> **Note**
+>
+> Some sections of the dashboard, when accessed through the agent, may require the user to be signed in to Netdata Cloud or have the Agent claimed to Netdata Cloud for their full functionality. Examples include saving visualization settings on charts or custom dashboards, claiming the node to Netdata Cloud, or executing functions on an Agent.
+
+## How to access the dashboards?
+
+### Netdata Cloud
+
+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.
+
+### Netdata Agent
+
+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.
+
+Documentation for previous Agent dashboard can still be found [here](/src/web/gui/README.md).