@cryptotaxi247 / netdata-1 / commits / 2c60f324e

Add markdown files in Learn (#14466)

* add metadata for learn * first batch of adding metadata to md files * second batch of adding metadata to md files * third batch of adding metadata to md files * test one sidebar_label * add missing sidebar_labels * add missing sidebar_labels to files left behind * test, ansible doc is stubborn * fix * fix * fix * don't use questionmarks in the sidebar label * don't use exclamation marks and symbols in the sidebar label * fix style guide * fixes * fixes

Fotis Voutsas committed Feb 8, 2023 at 19:48 UTC 2c60f324eea8970b25283c62acabaf9ae023dbff
109 files changed +558 -100
build_external/README.md
+4 -1
@@ -1,7 +1,10 @@
1 <!--
2 title: "External build-system"
3 -date: 2020-03-31
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/build_external/README.md
4 +sidebar_label: "External build-system"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers"
8 -->
9
10 # External build-system
collectors/python.d.plugin/pandas/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 -title: "Pandas"
2 custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/pandas/README.md
3 +title: "Pandas Netdata Collector"
4 +sidebar_label: "Pandas Netdata Collector"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References/Collectors references"
8 -->
9
10 # Pandas Netdata Collector
contrib/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Netdata contrib"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/README.md
4 +sidebar_label: "Netdata contrib"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers"
8 -->
9
10 # Netdata contrib
contribution-guidelines.md
+3 -13
@@ -685,21 +685,11 @@ Some documents, like the Ansible guide and others in the `/docs/guides` folder,
685 this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of the path to the document in question. End
686 the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
687
688 -For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
689 -Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
688 +For example, here is the frontmatter for the guide
689 +about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/ansible.md).
690
691 -```markdown
692 -<!--
693 -title: Deploy Netdata with Ansible
694 -description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
695 -image: /img/seo/guides/deploy/ansible.png
696 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
697 --->
698 -
699 -# Deploy Netdata with Ansible
691 +<img width="751" alt="image" src="https://user-images.githubusercontent.com/43294513/217607958-ef0f270d-7947-4d91-a9a5-56b17b4255ee.png">
692
701 -...
702 -```
693
694 Questions about frontmatter in documentation? [Ask on our community
695 forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
database/ram/README.md
+4
@@ -2,6 +2,10 @@
2 title: "RAM database modes"
3 description: "Netdata's RAM database modes."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/database/ram/README.md
5 +sidebar_label: "RAM database modes"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Developers/Database"
9 -->
10
11 # RAM modes
\ No newline at end of file
docs/Add-more-charts-to-netdata.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Add more charts to Netdata"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-charts-to-netdata.md
4 +sidebar_label: "Add more charts to Netdata"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Possible old, not wanted documents"
8 -->
9
10 # Add more charts to Netdata
docs/Demo-Sites.md
+4
@@ -2,6 +2,10 @@
2 title: "Demo sites"
3 date: 2020-03-26
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md
5 +sidebar_label: "Demo sites"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Possible old, not wanted documents"
9 -->
10
11 # Demo sites
docs/Donations-netdata-has-received.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Donations"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Donations-netdata-has-received.md
4 +sidebar_label: "Donations"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Possible old, not wanted documents"
8 -->
9
10 # Donations
docs/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Read documentation on <https://learn.netdata.cloud>"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/README.md
4 +sidebar_label: "Old welcome to Documentation message doc"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Possible old, not wanted documents"
8 -->
9
10 # Read documentation on <https://learn.netdata.cloud>
docs/a-github-star-is-important.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "A GitHub star is important"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/a-github-star-is-important.md
4 +sidebar_label: "A GitHub star is important"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Misc"
8 -->
9
10 # A GitHub star is important
docs/agent-cloud.md
+4
@@ -2,6 +2,10 @@
2 title: "Use the Agent with Netdata Cloud"
3 date: 2020-05-04
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/agent-cloud.md
5 +sidebar_label: "Use the Agent with Netdata Cloud"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Possible old, not wanted documents"
9 -->
10
11 # Use the Agent with Netdata Cloud
docs/anonymous-statistics.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Anonymous statistics"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-statistics.md
4 +sidebar_label: "Anonymous statistics"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "References"
8 -->
9
10 # Anonymous statistics
docs/cloud/beta-architecture/new-architecture.md
+4
@@ -2,6 +2,10 @@
2 title: "Test the New Cloud Architecture"
3 description: "Would you like to be the first to try our new architecture and provide feedback? If so, this guide will help you sign up for our beta testing group."
4 custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/beta-architecture/new-architecture.md"
5 +sidebar_label: "Test the New Cloud Architecture"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Possible old, not wanted documents"
9 -->
10
11 To enhance the stability and reliability of Netdata Cloud, we did extensive work on our backend, and we would like to give you the opportunity
docs/cloud/cloud.mdx
+1
@@ -2,6 +2,7 @@
2 title: "Netdata Cloud"
3 description: "Netdata Cloud is real-time visibility for entire infrastructures. View key metrics, insightful charts, and active alarms from all your nodes."
4 custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx"
5 +sidebar_label: "Netdata Cloud"
6 learn_status: "Published"
7 learn_topic_type: "Concepts"
8 learn_rel_path: "Getting Started"
docs/contributing/contributing-documentation.md
+4
@@ -2,6 +2,10 @@
2 title: "Contributing to documentation"
3 description: "Want to contribute to Netdata's documentation? This guide will set you up with the tools to help others learn about health and performance monitoring."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md
5 +sidebar_label: "Contributing to documentation"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Possible old, not wanted documents"
9 -->
10
11 # Contributing to documentation
docs/contributing/style-guide.md
+7 -14
@@ -2,6 +2,10 @@
2 title: "Netdata style guide"
3 description: "The Netdata style guide establishes editorial guidelines for all of Netdata's writing, including documentation, blog posts, in-product UX copy, and more."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md
5 +sidebar_label: "Netdata style guide"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Contribute"
9 -->
10
11 # Netdata style guide
@@ -374,20 +378,9 @@ this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of th
378 the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
379
380 For example, here is the frontmatter for the guide
377 -about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
381 +about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/ansible.md).
382
379 -```markdown
380 -<!--
381 -title: Deploy Netdata with Ansible
382 -description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
383 -image: /img/seo/guides/deploy/ansible.png
384 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
385 --->
386 -
387 -# Deploy Netdata with Ansible
388 -
389 -...
390 -```
383 +<img width="751" alt="image" src="https://user-images.githubusercontent.com/43294513/217607958-ef0f270d-7947-4d91-a9a5-56b17b4255ee.png">
384
385 Questions about frontmatter in
386 documentation? [Ask on our community forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
@@ -401,7 +394,7 @@ Links should always reference the full path to the document, beginning at the ro
394
395 For example, if you want to link to our node configuration document, link
396 to `https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md`. To reference
404 -the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`.
397 +the guide for deploying the Netdata Agent with Ansible, link to `/packaging/installer/methods/ansible.md`.
398
399 ### References to UI elements
400
docs/dashboard/reference-web-server.mdx
+4
@@ -3,6 +3,10 @@ title: "Web server reference"
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/docs/dashboard/reference-web-server.mdx
6 +sidebar_label: "Web server reference"
7 +learn_status: "Published"
8 +learn_topic_type: "References"
9 +learn_rel_path: "References"
10 -->
11
12 # Web server reference
docs/guides/collect-apache-nginx-web-logs.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Monitor Nginx or Apache web server log files with Netdata"
3 +sidebar_label: "Monitor Nginx or Apache web server log files with Netdata"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-apache-nginx-web-logs.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides"
8 -->
9
10 # Monitor Nginx or Apache web server log files with Netdata
docs/guides/collect-unbound-metrics.md
+4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Monitor Unbound DNS servers with Netdata"
3 +sidebar_label: "Monitor Unbound DNS servers with Netdata"
4 date: 2020-03-31
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-unbound-metrics.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides"
9 -->
10
11 # Monitor Unbound DNS servers with Netdata
docs/guides/configure/performance.md
+5 -1
@@ -1,8 +1,12 @@
1 <!--
2 -title: How to optimize the Netdata Agent's performance
2 +title: "How to optimize the Netdata Agent's performance"
3 +sidebar_label: "How to optimize the Netdata Agent's performance"
4 description: "While the Netdata Agent is designed to monitor a system with only 1% CPU, you can optimize its performance for low-resource systems."
5 image: /img/seo/guides/configure/performance.png
6 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/configure/performance.md
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Guides"
10 -->
11
12 # How to optimize the Netdata Agent's performance
docs/guides/export/export-netdata-metrics-graphite.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 -title: Export and visualize Netdata metrics in Graphite
2 +title: "Export and visualize Netdata metrics in Graphite"
3 +sidebar_label: "Export and visualize Netdata metrics in Graphite"
4 description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis."
5 image: /img/seo/guides/export/export-netdata-metrics-graphite.png
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides"
9 -->
10 import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
11
docs/guides/longer-metrics-storage.md
+4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Netdata Longer Metrics Retention"
3 +sidebar_label: "Netdata Longer Metrics Retention"
4 description: ""
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/longer-metrics-storage.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides"
9 -->
10
11 # Netdata Longer Metrics Retention
docs/guides/monitor-cockroachdb.md
+9 -2
@@ -1,6 +1,10 @@
1 <!--
2 title: "Monitor CockroachDB metrics with Netdata"
3 +sidebar_label: "Monitor CockroachDB metrics with Netdata"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-cockroachdb.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides"
8 -->
9
10 # Monitor CockroachDB metrics with Netdata
@@ -20,9 +24,12 @@ Let's dive in and walk through the process of monitoring CockroachDB metrics wit
24
25 ## What's in this guide
26
23 -- [Configure the CockroachDB collector](#configure-the-cockroachdb-collector)
27 +- [Monitor CockroachDB metrics with Netdata](#monitor-cockroachdb-metrics-with-netdata)
28 + - [What's in this guide](#whats-in-this-guide)
29 + - [Configure the CockroachDB collector](#configure-the-cockroachdb-collector)
30 - [Manual setup for a local CockroachDB database](#manual-setup-for-a-local-cockroachdb-database)
25 -- [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms)
31 + - [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms)
32 + - [What's next?](#whats-next)
33
34 ## Configure the CockroachDB collector
35
docs/guides/monitor-hadoop-cluster.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Monitor a Hadoop cluster with Netdata"
3 +sidebar_label: "Monitor a Hadoop cluster with Netdata"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-hadoop-cluster.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides"
8 -->
9
10 # Monitor a Hadoop cluster with Netdata
docs/guides/monitor/anomaly-detection-python.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: "Detect anomalies in systems and applications"
3 +sidebar_label: "Detect anomalies in systems and applications"
4 description: "Detect anomalies in any system, container, or application in your infrastructure with machine learning and the open-source Netdata Agent."
5 image: /img/seo/guides/monitor/anomaly-detection.png
6 author: "Joel Hans"
7 author_title: "Editorial Director, Technical & Educational Resources"
8 author_img: "/img/authors/joel-hans.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/anomaly-detection-python.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides/Monitor"
13 -->
14
15 # Detect anomalies in systems and applications
docs/guides/monitor/anomaly-detection.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: "Machine learning (ML) powered anomaly detection"
3 +sidebar_label: "Machine learning (ML) powered anomaly detection"
4 description: "Detect anomalies in any system, container, or application in your infrastructure with machine learning and the open-source Netdata Agent."
5 image: /img/seo/guides/monitor/anomaly-detection.png
6 author: "Andrew Maguire"
7 author_title: "Analytics & ML Lead"
8 author_img: "/img/authors/andy-maguire.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/anomaly-detection.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides/Monitor"
13 -->
14
15
docs/guides/monitor/dimension-templates.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Use dimension templates to create dynamic alarms"
3 +sidebar_label: "Use dimension templates to create dynamic alarms"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/dimension-templates.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Monitor"
8 -->
9
10 # Use dimension templates to create dynamic alarms
docs/guides/monitor/kubernetes-k8s-netdata.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: "Kubernetes monitoring with Netdata: Overview and visualizations"
3 +sidebar_label: "Kubernetes monitoring with Netdata: Overview and visualizations"
4 description: "Learn how to navigate Netdata's Kubernetes monitoring features for visualizing the health and performance of a Kubernetes cluster with per-second granularity."
5 image: /img/seo/guides/monitor/kubernetes-k8s-netdata.png
6 author: "Joel Hans"
7 author_title: "Editorial Director, Technical & Educational Resources"
8 author_img: "/img/authors/joel-hans.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/kubernetes-k8s-netdata.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides/Monitor"
13 -->
14
15 # Kubernetes monitoring with Netdata: Overview and visualizations
docs/guides/monitor/lamp-stack.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata"
3 +sidebar_label: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata"
4 description: "Set up robust LAMP stack monitoring (Linux, Apache, MySQL, PHP) in just a few minutes using a free, open-source monitoring tool that collects metrics every second."
5 image: /img/seo/guides/monitor/lamp-stack.png
6 author: "Joel Hans"
7 author_title: "Editorial Director, Technical & Educational Resources"
8 author_img: "/img/authors/joel-hans.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/lamp-stack.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides/Monitor"
13 -->
14 import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
15
docs/guides/monitor/pi-hole-raspberry-pi.md
+4
@@ -1,8 +1,12 @@
1 <!--
2 title: "Monitor Pi-hole (and a Raspberry Pi) with Netdata"
3 +sidebar_label: "Monitor Pi-hole (and a Raspberry Pi) with Netdata"
4 description: "Monitor Pi-hole metrics, plus Raspberry Pi system metrics, in minutes and completely for free with Netdata's open-source monitoring agent."
5 image: /img/seo/guides/monitor/netdata-pi-hole-raspberry-pi.png
6 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/pi-hole-raspberry-pi.md
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Guides/Monitor"
10 -->
11 import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
12
docs/guides/monitor/process.md
+4
@@ -1,8 +1,12 @@
1 <!--
2 title: Monitor any process in real-time with Netdata
3 +sidebar_label: Monitor any process in real-time with Netdata
4 description: "Tap into Netdata's powerful collectors, with per-second utilization metrics for every process, to troubleshoot faster and make data-informed decisions."
5 image: /img/seo/guides/monitor/process.png
6 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/process.md
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Guides/Monitor"
10 -->
11
12 # Monitor any process in real-time with Netdata
docs/guides/monitor/raspberry-pi-anomaly-detection.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: "Unsupervised anomaly detection for Raspberry Pi monitoring"
3 +sidebar_label: "Unsupervised anomaly detection for Raspberry Pi monitoring"
4 description: "Use a low-overhead machine learning algorithm and an open-source monitoring tool to detect anomalous metrics on a Raspberry Pi."
5 image: /img/seo/guides/monitor/raspberry-pi-anomaly-detection.png
6 author: "Andy Maguire"
7 author_title: "Senior Machine Learning Engineer"
8 author_img: "/img/authors/andy-maguire.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/raspberry-pi-anomaly-detection.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides/Monitor"
13 -->
14
15 We love IoT and edge at Netdata, we also love machine learning. Even better if we can combine the two to ease the pain
docs/guides/monitor/statsd.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: How to use any StatsD data source with Netdata
3 +sidebar_label: How to use any StatsD data source with Netdata
4 description: "Learn how to monitor any custom application instrumented with StatsD with per-second metrics and fully customizable, interactive charts."
5 image: /img/seo/guides/monitor/statsd.png
6 author: "Odysseas Lamtzidis"
7 author_title: "Developer Advocate"
8 author_img: "/img/authors/odysseas-lamtzidis.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/statsd.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides/Monitor"
13 -->
14
15 # StatsD Guide
docs/guides/monitor/stop-notifications-alarms.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Stop notifications for individual alarms"
3 +sidebar_label: "Stop notifications for individual alarms"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/stop-notifications-alarms.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Monitor"
8 -->
9
10 # Stop notifications for individual alarms
docs/guides/monitor/visualize-monitor-anomalies.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: "Monitor and visualize anomalies with Netdata (part 2)"
3 +sidebar_label: "Monitor and visualize anomalies with Netdata (part 2)"
4 description: "Using unsupervised anomaly detection and machine learning, get notified "
5 image: /img/seo/guides/monitor/visualize-monitor-anomalies.png
6 author: "Joel Hans"
7 author_title: "Editorial Director, Technical & Educational Resources"
8 author_img: "/img/authors/joel-hans.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/visualize-monitor-anomalies.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides/Monitor"
13 -->
14
15 Welcome to part 2 of our series of guides on using _unsupervised anomaly detection_ to detect issues with your systems,
docs/guides/python-collector.md
+4
@@ -1,11 +1,15 @@
1 <!--
2 title: "Develop a custom data collector in Python"
3 +sidebar_label: "Develop a custom data collector in Python"
4 description: "Learn how write a custom data collector in Python, which you'll use to collect metrics from and monitor any application that isn't supported out of the box."
5 image: /img/seo/guides/python-collector.png
6 author: "Panagiotis Papaioannou"
7 author_title: "University of Patras"
8 author_img: "/img/authors/panagiotis-papaioannou.jpg"
9 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/python-collector.md
10 +learn_status: "Published"
11 +learn_topic_type: "Tasks"
12 +learn_rel_path: "Guides"
13 -->
14
15 # Develop a custom data collector in Python
docs/guides/step-by-step/step-00.md
+4
@@ -1,7 +1,11 @@
1 <!--
2 title: "The step-by-step Netdata guide"
3 +sidebar_label: "The step-by-step Netdata guide"
4 date: 2020-03-31
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-00.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides/Step by step"
9 -->
10 import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
11
docs/guides/step-by-step/step-01.md
+14 -3
@@ -1,6 +1,10 @@
1 <!--
2 title: "Step 1. Netdata's building blocks"
3 +sidebar_label: "Step 1. Netdata's building blocks"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-01.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Step by step"
8 -->
9
10 # Step 1. Netdata's building blocks
@@ -29,9 +33,16 @@ be)](https://blog.netdata.cloud/posts/redefining-monitoring-netdata/)_.
33
34 In the first step of the Netdata guide, you'll learn about:
35
32 -- [Netdata's core features](#netdatas-core-features)
33 -- [Why you should use Netdata](#why-you-should-use-netdata)
34 -- [How Netdata has complementary systems, not competitors](#how-netdata-has-complementary-systems-not-competitors)
36 +- [Step 1. Netdata's building blocks](#step-1-netdatas-building-blocks)
37 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
38 + - [Netdata's core features](#netdatas-core-features)
39 + - [Why you should use Netdata](#why-you-should-use-netdata)
40 + - [Per-second data collection](#per-second-data-collection)
41 + - [Unlimited metrics](#unlimited-metrics)
42 + - [Meaningful presentation](#meaningful-presentation)
43 + - [Immediate results](#immediate-results)
44 + - [How Netdata has complementary systems, not competitors](#how-netdata-has-complementary-systems-not-competitors)
45 + - [What's next?](#whats-next)
46
47 Let's get started!
48
docs/guides/step-by-step/step-02.md
+16 -5
@@ -1,7 +1,11 @@
1 <!--
2 title: "Step 2. Get to know Netdata's dashboard"
3 +sidebar_label: "Step 2. Get to know Netdata's dashboard"
4 date: 2020-05-04
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-02.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides/Step by step"
9 -->
10
11 # Step 2. Get to know Netdata's dashboard
@@ -18,11 +22,18 @@ over here and dig in.
22
23 In this step of the Netdata guide, you'll learn how to:
24
21 -- [Visit and explore the dashboard](#visit-and-explore-the-dashboard)
22 -- [Explore available charts using menus](#explore-available-charts-using-menus)
23 -- [Read the descriptions accompanying charts](#read-the-descriptions-accompanying-charts)
24 -- [Interact with charts](#interact-with-charts)
25 -- [See raised alarms and the alarm log](#see-raised-alarms-and-the-alarm-log)
25 +- [Step 2. Get to know Netdata's dashboard](#step-2-get-to-know-netdatas-dashboard)
26 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
27 + - [Visit and explore the dashboard](#visit-and-explore-the-dashboard)
28 + - [Explore available charts using menus](#explore-available-charts-using-menus)
29 + - [Read the descriptions accompanying charts](#read-the-descriptions-accompanying-charts)
30 + - [Understand charts, dimensions, families, and contexts](#understand-charts-dimensions-families-and-contexts)
31 + - [Interact with charts](#interact-with-charts)
32 + - [Pan, zoom, highlight, and reset charts](#pan-zoom-highlight-and-reset-charts)
33 + - [Show and hide dimensions](#show-and-hide-dimensions)
34 + - [Resize charts](#resize-charts)
35 + - [See raised alarms and the alarm log](#see-raised-alarms-and-the-alarm-log)
36 + - [What's next?](#whats-next)
37
38 Let's get started!
39
docs/guides/step-by-step/step-03.md
+4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Step 3. Monitor more than one system with Netdata"
3 +sidebar_label: "Step 3. Monitor more than one system with Netdata"
4 date: 2020-05-01
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-03.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides/Step by step"
9 -->
10
11 # Step 3. Monitor more than one system with Netdata
docs/guides/step-by-step/step-04.md
+11 -4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Step 4. The basics of configuring Netdata"
3 +sidebar_label: "Step 4. The basics of configuring Netdata"
4 date: 2020-03-31
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-04.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides/Step by step"
9 -->
10
11 # Step 4. The basics of configuring Netdata
@@ -17,10 +21,13 @@ Next up: configuration.
21
22 We'll talk about Netdata's default configuration, and then you'll learn how to do the following:
23
20 -- [Find your `netdata.conf` file](#find-your-netdataconf-file)
21 -- [Use edit-config to open `netdata.conf`](#use-edit-config-to-open-netdataconf)
22 -- [Navigate the structure of `netdata.conf`](#the-structure-of-netdataconf)
23 -- [Edit your `netdata.conf` file](#edit-your-netdataconf-file)
24 +- [Step 4. The basics of configuring Netdata](#step-4-the-basics-of-configuring-netdata)
25 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
26 + - [Find your `netdata.conf` file](#find-your-netdataconf-file)
27 + - [Use edit-config to open `netdata.conf`](#use-edit-config-to-open-netdataconf)
28 + - [The structure of `netdata.conf`](#the-structure-of-netdataconf)
29 + - [Edit your `netdata.conf` file](#edit-your-netdataconf-file)
30 + - [What's next?](#whats-next)
31
32 ## Find your `netdata.conf` file
33
docs/guides/step-by-step/step-05.md
+13 -3
@@ -1,6 +1,10 @@
1 <!--
2 title: "Step 5. Health monitoring alarms and notifications"
3 +sidebar_label: "Step 5. Health monitoring alarms and notifications"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-05.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Step by step"
8 -->
9
10 # Step 5. Health monitoring alarms and notifications
@@ -20,9 +24,15 @@ Luckily, Netdata's alarm and notification system are incredibly adaptable to you
24
25 We'll talk about Netdata's default configuration, and then you'll learn how to do the following:
26
23 -- [Tune Netdata's pre-configured alarms](#tune-netdatas-pre-configured-alarms)
24 -- [Write your first health entity](#write-your-first-health-entity)
25 -- [Enable Netdata's notification systems](#enable-netdatas-notification-systems)
27 +- [Step 5. Health monitoring alarms and notifications](#step-5-health-monitoring-alarms-and-notifications)
28 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
29 + - [Tune Netdata's pre-configured alarms](#tune-netdatas-pre-configured-alarms)
30 + - [Silence an individual alarm](#silence-an-individual-alarm)
31 + - [Write your first health entity](#write-your-first-health-entity)
32 + - [Enable Netdata's notification systems](#enable-netdatas-notification-systems)
33 + - [Email notifications](#email-notifications)
34 + - [Enable Slack notifications](#enable-slack-notifications)
35 + - [What's next?](#whats-next)
36
37 ## Tune Netdata's pre-configured alarms
38
docs/guides/step-by-step/step-06.md
+10 -3
@@ -1,6 +1,10 @@
1 <!--
2 title: "Step 6. Collect metrics from more services and apps"
3 +sidebar_label: "Step 6. Collect metrics from more services and apps"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-06.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Step by step"
8 -->
9
10 # Step 6. Collect metrics from more services and apps
@@ -21,9 +25,12 @@ source you want to monitor.
25
26 We'll begin with an overview on Netdata's collector architecture, and then dive into the following:
27
24 -- [Netdata's collector architecture](#netdatas-collector-architecture)
25 -- [Enable and disable plugins](#enable-and-disable-plugins)
26 -- [Enable the Nginx collector as an example](#example-enable-the-nginx-collector)
28 +- [Step 6. Collect metrics from more services and apps](#step-6-collect-metrics-from-more-services-and-apps)
29 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
30 + - [Netdata's collector architecture](#netdatas-collector-architecture)
31 + - [Enable and disable plugins](#enable-and-disable-plugins)
32 + - [Example: Enable the Nginx collector](#example-enable-the-nginx-collector)
33 + - [What's next?](#whats-next)
34
35 ## Netdata's collector architecture
36
docs/guides/step-by-step/step-07.md
+10 -3
@@ -1,7 +1,11 @@
1 <!--
2 title: "Step 7. Netdata's dashboard in depth"
3 +sidebar_label: "Step 7. Netdata's dashboard in depth"
4 date: 2020-05-04
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-07.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides/Step by step"
9 -->
10
11 # Step 7. Netdata's dashboard in depth
@@ -15,9 +19,12 @@ This step of the guide aims to get you more familiar with the features of the da
19
20 In this step of the Netdata guide, you'll learn how to:
21
18 -- [Change the dashboard's settings](#change-the-dashboards-settings)
19 -- [Check if there's an update to Netdata](#check-if-theres-an-update-to-netdata)
20 -- [Export and import a snapshot](#export-and-import-a-snapshot)
22 +- [Step 7. Netdata's dashboard in depth](#step-7-netdatas-dashboard-in-depth)
23 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
24 + - [Change the dashboard's settings](#change-the-dashboards-settings)
25 + - [Check if there's an update to Netdata](#check-if-theres-an-update-to-netdata)
26 + - [Export and import a snapshot](#export-and-import-a-snapshot)
27 + - [What's next?](#whats-next)
28
29 Let's get started!
30
docs/guides/step-by-step/step-08.md
+17 -5
@@ -1,6 +1,10 @@
1 <!--
2 title: "Step 8. Build your first custom dashboard"
3 +sidebar_label: "Step 8. Build your first custom dashboard"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-08.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Step by step"
8 -->
9
10 # Step 8. Build your first custom dashboard
@@ -14,11 +18,19 @@ really flexible. 🤸
18
19 In this step of the Netdata guide, you'll learn:
20
17 -- [Why you might want a custom dashboard](#why-should-i-create-a-custom-dashboard)
18 -- [How to create and prepare your `custom-dashboard.html` file](#create-and-prepare-your-custom-dashboardhtml-file)
19 -- [Where to add `dashboard.js` to your custom dashboard file](#add-dashboardjs-to-your-custom-dashboard-file)
20 -- [How to add basic styling](#add-some-basic-styling)
21 -- [How to add charts of different types, shapes, and sizes](#creating-your-dashboards-charts)
21 +- [Step 8. Build your first custom dashboard](#step-8-build-your-first-custom-dashboard)
22 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
23 + - [Why should I create a custom dashboard?](#why-should-i-create-a-custom-dashboard)
24 + - [Create and prepare your `custom-dashboard.html` file](#create-and-prepare-your-custom-dashboardhtml-file)
25 + - [Add `dashboard.js` to your custom dashboard file](#add-dashboardjs-to-your-custom-dashboard-file)
26 + - [Add some basic styling](#add-some-basic-styling)
27 + - [Creating your dashboard's charts](#creating-your-dashboards-charts)
28 + - [The chart unique ID (required)](#the-chart-unique-id-required)
29 + - [Set chart duration](#set-chart-duration)
30 + - [Set chart size](#set-chart-size)
31 + - [Final touches](#final-touches)
32 + - [The final `custom-dashboard.html`](#the-final-custom-dashboardhtml)
33 + - [What's next?](#whats-next)
34
35 Let's get on with it!
36
docs/guides/step-by-step/step-09.md
+10 -3
@@ -1,6 +1,10 @@
1 <!--
2 title: "Step 9. Long-term metrics storage"
3 +sidebar_label: "Step 9. Long-term metrics storage"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-09.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Step by step"
8 -->
9
10 # Step 9. Long-term metrics storage
@@ -22,9 +26,12 @@ or disk it uses. Second, you can archive metrics to an external database. For th
26
27 In this step of the Netdata guide, you'll learn how to:
28
25 -- [Tweak the database engine's settings](#tweak-the-database-engines-settings)
26 -- [Archive metrics to an external database](#archive-metrics-to-an-external-database)
27 - - [Use the MongoDB database](#archive-metrics-via-the-mongodb-exporting-connector)
29 +- [Step 9. Long-term metrics storage](#step-9-long-term-metrics-storage)
30 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
31 + - [Tweak the database engine's settings](#tweak-the-database-engines-settings)
32 + - [Archive metrics to an external database](#archive-metrics-to-an-external-database)
33 + - [Archive metrics via the MongoDB exporting connector](#archive-metrics-via-the-mongodb-exporting-connector)
34 + - [What's next?](#whats-next)
35
36 Let's get started!
37
docs/guides/step-by-step/step-10.md
+15 -4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Step 10. Set up a proxy"
3 +sidebar_label: "Step 10. Set up a proxy"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-10.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Step by step"
8 -->
9
10 # Step 10. Set up a proxy
@@ -24,10 +28,17 @@ publicly-accessible remote server.
28
29 In this step of the Netdata guide, you'll learn:
30
27 -- [What a proxy is and the benefits of using one](#wait-whats-a-proxy)
28 -- [How to connect Netdata to Nginx](#connect-netdata-to-nginx)
29 -- [How to enable HTTPS in Nginx](#enable-https-in-nginx)
30 -- [How to secure your Netdata dashboard with a password](#secure-your-netdata-dashboard-with-a-password)
31 +- [Step 10. Set up a proxy](#step-10-set-up-a-proxy)
32 + - [What you'll learn in this step](#what-youll-learn-in-this-step)
33 + - [Wait. What's a proxy?](#wait-whats-a-proxy)
34 + - [Required before you start](#required-before-you-start)
35 + - [Nginx and Certbot](#nginx-and-certbot)
36 + - [Fully qualified domain name](#fully-qualified-domain-name)
37 + - [Subdomain for Netdata](#subdomain-for-netdata)
38 + - [Connect Netdata to Nginx](#connect-netdata-to-nginx)
39 + - [Enable HTTPS in Nginx](#enable-https-in-nginx)
40 + - [Secure your Netdata dashboard with a password](#secure-your-netdata-dashboard-with-a-password)
41 + - [What's next?](#whats-next)
42
43 Let's dive in!
44
docs/guides/step-by-step/step-99.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 -title: "Step ∞. You're finished!"
2 +title: "You're finished"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-99.md
4 +sidebar_label: "You're finished"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides/Step by step"
8 -->
9
10 # Step ∞. You're finished!
docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
+4
@@ -1,8 +1,12 @@
1 <!--
2 title: "Monitor, troubleshoot, and debug applications with eBPF metrics"
3 +sidebar_label: "Monitor, troubleshoot, and debug applications with eBPF metrics"
4 description: "Use Netdata's built-in eBPF metrics collector to monitor, troubleshoot, and debug your custom application using low-level kernel feedback."
5 image: /img/seo/guides/troubleshoot/monitor-debug-applications-ebpf.png
6 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
7 +learn_status: "Published"
8 +learn_topic_type: "Tasks"
9 +learn_rel_path: "Guides/Troubleshoot"
10 -->
11
12 # Monitor, troubleshoot, and debug applications with eBPF metrics
docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
+12 -4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Troubleshoot Agent-Cloud connectivity issues"
3 +sidebar_label: "Troubleshoot Agent-Cloud connectivity issues"
4 description: "A simple guide to troubleshoot occurrences where the Agent is showing as offline after claiming."
4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
5 +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Guides/Troubleshoot"
9 -->
10
11 # Troubleshoot Agent-Cloud connectivity issues
@@ -13,9 +17,13 @@ We identified some scenarios that might cause this delay and possible actions yo
17
18 The most common explanation for the delay usually falls into one of the following three categories:
19
16 -- [The claiming process of the kickstart script was unsuccessful](#the-claiming-process-of-the-kickstart-script-was-unsuccessful)
17 -- [Claiming on an older, deprecated version of the Agent](#claiming-on-an-older-deprecated-version-of-the-agent)
18 -- [Network issues while connecting to the Cloud](#network-issues-while-connecting-to-the-cloud)
20 +- [Troubleshoot Agent-Cloud connectivity issues](#troubleshoot-agent-cloud-connectivity-issues)
21 + - [The claiming process of the kickstart script was unsuccessful](#the-claiming-process-of-the-kickstart-script-was-unsuccessful)
22 + - [The kickstart script auto-claimed the Agent but there was no error message displayed](#the-kickstart-script-auto-claimed-the-agent-but-there-was-no-error-message-displayed)
23 + - [Claiming on an older, deprecated version of the Agent](#claiming-on-an-older-deprecated-version-of-the-agent)
24 + - [Network issues while connecting to the Cloud](#network-issues-while-connecting-to-the-cloud)
25 + - [Verify that your IP is whitelisted from Netdata Cloud](#verify-that-your-ip-is-whitelisted-from-netdata-cloud)
26 + - [Make sure that your node has internet connectivity and can resolve network domains](#make-sure-that-your-node-has-internet-connectivity-and-can-resolve-network-domains)
27
28 ## The claiming process of the kickstart script was unsuccessful
29
docs/guides/using-host-labels.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Use host labels to organize systems, metrics, and alarms"
3 +sidebar_label: "Use host labels to organize systems, metrics, and alarms"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/using-host-labels.md
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Guides"
8 -->
9
10 # Use host labels to organize systems, metrics, and alarms
docs/netdata-for-IoT.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Netdata for IoT"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-for-IoT.md
4 +sidebar_label: "Netdata for IoT"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Guides"
8 -->
9
10 # Netdata for IoT
docs/netdata-security.md
+19 -10
@@ -1,6 +1,10 @@
1 <!--
2 title: "Security design"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-security.md
4 +sidebar_label: "Add more charts to Netdata"
5 +learn_status: "Published"
6 +learn_topic_type: "Concepts"
7 +learn_rel_path: "Concepts"
8 -->
9
10 # Security design
@@ -9,16 +13,21 @@ We have given special attention to all aspects of Netdata, ensuring that everyth
13
14 **Table of Contents**
15
12 -1. [Your data is safe with Netdata](#your-data-is-safe-with-netdata)
13 -2. [Your systems are safe with Netdata](#your-systems-are-safe-with-netdata)
14 -3. [Netdata is read-only](#netdata-is-read-only)
15 -4. [Netdata viewers authentication](#netdata-viewers-authentication)
16 - * [Why Netdata should be protected](#why-netdata-should-be-protected)
17 - * [Protect Netdata from the internet](#protect-netdata-from-the-internet)
18 - * [Expose Netdata only in a private LAN](#expose-netdata-only-in-a-private-lan)
19 - * [Use an authenticating web server in proxy mode](#use-an-authenticating-web-server-in-proxy-mode)
20 - * [Other methods](#other-methods)
21 -5. [Registry or how to not send any information to a third party server](#registry-or-how-to-not-send-any-information-to-a-third-party-server)
16 +- [Security design](#security-design)
17 + - [Your data is safe with Netdata](#your-data-is-safe-with-netdata)
18 + - [Your systems are safe with Netdata](#your-systems-are-safe-with-netdata)
19 + - [Netdata is read-only](#netdata-is-read-only)
20 + - [Netdata viewers authentication](#netdata-viewers-authentication)
21 + - [Why Netdata should be protected](#why-netdata-should-be-protected)
22 + - [Protect Netdata from the internet](#protect-netdata-from-the-internet)
23 + - [Expose Netdata only in a private LAN](#expose-netdata-only-in-a-private-lan)
24 + - [Fine-grained access control](#fine-grained-access-control)
25 + - [Use an authenticating web server in proxy mode](#use-an-authenticating-web-server-in-proxy-mode)
26 + - [Other methods](#other-methods)
27 + - [Anonymous Statistics](#anonymous-statistics)
28 + - [Registry or how to not send any information to a third party server](#registry-or-how-to-not-send-any-information-to-a-third-party-server)
29 + - [Opt-out of anonymous statistics](#opt-out-of-anonymous-statistics)
30 + - [Netdata directories](#netdata-directories)
31
32 ## Your data is safe with Netdata
33
docs/overview/netdata-monitoring-stack.md
+4
@@ -2,6 +2,10 @@
2 title: "Use Netdata standalone or as part of your monitoring stack"
3 description: "Netdata can run independently or as part of a larger monitoring stack thanks to its flexibility, interoperable core, and exporting features."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/netdata-monitoring-stack.md
5 +sidebar_label: "Use Netdata standalone or as part of your monitoring stack"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Possible old, not wanted documents"
9 -->
10
11 # Use Netdata standalone or as part of your monitoring stack
docs/overview/what-is-netdata.md
+4
@@ -2,6 +2,10 @@
2 title: "What is Netdata?"
3 description: "Netdata is distributed, real-time performance and health monitoring for systems and applications on a single node or an entire infrastructure."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/what-is-netdata.md
5 +sidebar_label: "What is Netdata"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Getting started"
9 -->
10
11 # What is Netdata?
docs/overview/why-netdata.md
+4
@@ -2,6 +2,10 @@
2 title: "Why use Netdata?"
3 description: "Netdata is simple to deploy, scalable, and optimized for troubleshooting. Cut the complexity and expense out of your monitoring stack."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/why-netdata.md
5 +sidebar_label: "Why use Netdata"
6 +learn_status: "Published"
7 +learn_topic_type: "Concepts"
8 +learn_rel_path: "Getting started"
9 -->
10
11 # Why use Netdata?
docs/quickstart/infrastructure.md
+4 -1
@@ -1,8 +1,11 @@
1 <!--
2 title: "Infrastructure monitoring with Netdata"
3 -sidebar_label: "Infrastructure monitoring"
3 description: "Build a robust, infinitely scalable infrastructure monitoring solution with Netdata. Any number of nodes and every available metric."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/infrastructure.md
5 +sidebar_label: "Infrastructure monitoring with Netdata"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Possible old, not wanted documents"
9 -->
10
11 # Infrastructure monitoring with Netdata
docs/quickstart/single-node.md
+4 -1
@@ -1,8 +1,11 @@
1 <!--
2 title: "Single-node monitoring with Netdata"
3 -sidebar_label: "Single-node monitoring"
3 description: "Learn dashboard basics, configuring your nodes, and collecting metrics from applications to create a powerful single-node monitoring tool."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/single-node.md
5 +sidebar_label: "Infrastructure monitoring with Netdata"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Possible old, not wanted documents"
9 -->
10
11 # Single-node monitoring with Netdata
docs/visualize/create-dashboards.md
+4
@@ -2,6 +2,10 @@
2 title: "Create new dashboards"
3 description: "Create new dashboards in Netdata Cloud, with any number of metrics from any node on your infrastructure, for targeted troubleshooting."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/create-dashboards.md
5 +sidebar_label: "Create new dashboards"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations/Netdata Cloud Visualizations"
9 -->
10
11 # Create new dashboards
docs/visualize/interact-dashboards-charts.md
+4
@@ -2,6 +2,10 @@
2 title: "Interact with dashboards and charts"
3 description: "Zoom, highlight, and pan through time on hundreds of real-time, interactive charts to quickly discover the root cause of any anomaly."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/interact-dashboards-charts.md
5 +sidebar_label: "Interact with dashboards and charts"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations/Netdata Cloud Visualizations"
9 -->
10
11 # Interact with dashboards and charts
docs/visualize/overview-infrastructure.md
+4
@@ -2,6 +2,10 @@
2 title: "See an overview of your infrastructure"
3 description: "With Netdata Cloud's War Rooms, you can see real-time metrics, from any number of nodes in your infrastructure, in composite charts."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/overview-infrastructure.md
5 +sidebar_label: "See an overview of your infrastructure"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Operations/Netdata Cloud Visualizations"
9 -->
10
11 # See an overview of your infrastructure
docs/why-netdata/1s-granularity.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "1s granularity"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/1s-granularity.md
4 +sidebar_label: "1s granularity"
5 +learn_status: "Published"
6 +learn_topic_type: "Concepts"
7 +learn_rel_path: "Concepts/Why Netdata"
8 -->
9
10 # 1s granularity
docs/why-netdata/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Why Netdata"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/README.md
4 +sidebar_label: "Why Netdata"
5 +learn_status: "Published"
6 +learn_topic_type: "Concepts"
7 +learn_rel_path: "Concepts/Why Netdata"
8 -->
9
10 # Why Netdata
docs/why-netdata/immediate-results.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Immediate results"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/immediate-results.md
4 +sidebar_label: "Immediate results"
5 +learn_status: "Published"
6 +learn_topic_type: "Concepts"
7 +learn_rel_path: "Concepts/Why Netdata"
8 -->
9
10 # Immediate results
docs/why-netdata/meaningful-presentation.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Meaningful presentation"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/meaningful-presentation.md
4 +sidebar_label: "Meaningful presentation"
5 +learn_status: "Published"
6 +learn_topic_type: "Concepts"
7 +learn_rel_path: "Concepts/Why Netdata"
8 -->
9
10 # Meaningful presentation
docs/why-netdata/unlimited-metrics.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Unlimited metrics"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/unlimited-metrics.md
4 +sidebar_label: "Unlimited metrics"
5 +learn_status: "Published"
6 +learn_topic_type: "Concepts"
7 +learn_rel_path: "Concepts/Why Netdata"
8 -->
9
10 # Unlimited metrics
libnetdata/clocks/README.md
+6 -3
@@ -1,5 +1,8 @@
1 <!--
2 -custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/clocks/README.md
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/clocks/README.md"
3 +title: "Clocks"
4 +sidebar_label: "Clocks"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/libnetdata libraries"
8 -->
4 -
5 -
libnetdata/onewayalloc/README.md
+1 -1
@@ -1,6 +1,6 @@
1 <!--
2 title: "One Way Allocator"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
3 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/onewayalloc/README.md"
4 sidebar_label: "One way allocator"
5 learn_status: "Published"
6 learn_topic_type: "Tasks"
libnetdata/socket/README.md
+5 -2
@@ -1,5 +1,8 @@
1 <!--
2 +Title: "Socket"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/socket/README.md
4 +sidebar_label: "Socket"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/libnetdata libraries"
8 -->
4 -
5 -
libnetdata/worker_utilization/README.md
+1 -1
@@ -1,6 +1,6 @@
1 <!--
2 title: "Worker Utilization"
3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
3 +custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/worker_utilization/README.md
4 -->
5
6 # Worker Utilization
packaging/building-native-packages-locally.md
+5 -1
@@ -1,7 +1,11 @@
1 <!--
2 -title: How to build native (DEB/RPM) packages locally for testing
2 +title: "How to build native (DEB/RPM) packages locally for testing"
3 +sidebar_label: "How to build native (DEB/RPM) packages locally for testing"
4 description: Instructions for developers who need to build native packages locally for testing.
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/building-native-packages-locally.md
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Installation"
9 -->
10
11 # How to build native (DEB/RPM) packages locally for testing
packaging/installer/methods/ansible.md
+1 -1
@@ -1,5 +1,5 @@
1 <!--
2 -title: Deploy Netdata with Ansible
2 +title: "Deploy Netdata with Ansible"
3 description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
4 image: /img/seo/guides/deploy/ansible.png
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/ansible.md
packaging/installer/methods/cloud-providers.md
+11 -3
@@ -2,6 +2,10 @@
2 title: "Install Netdata on cloud providers"
3 description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/cloud-providers.md
5 +sidebar_label: "Install Netdata on cloud providers"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Install Netdata on cloud providers
@@ -18,9 +22,13 @@ aims to document some of those steps for popular cloud providers.
22 > issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request.md)
23 > with your process and instructions on using the provider's interface to complete the workaround.
24
21 -- [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
22 -- [Post-installation configuration](#post-installation-configuration)
23 - - [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard)
25 +- [Install Netdata on cloud providers](#install-netdata-on-cloud-providers)
26 + - [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
27 + - [Post-installation configuration](#post-installation-configuration)
28 + - [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard)
29 + - [Google Cloud Platform (GCP)](#google-cloud-platform-gcp)
30 + - [Amazon Web Services (AWS) / EC2](#amazon-web-services-aws--ec2)
31 + - [Azure](#azure)
32
33 ## Recommended installation methods for cloud providers
34
packaging/installer/methods/freebsd.md
+4
@@ -2,6 +2,10 @@
2 title: "Install Netdata on FreeBSD"
3 description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md
5 +sidebar_label: "Install Netdata on FreeBSD"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Install Netdata on FreeBSD
packaging/installer/methods/freenas.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Install Netdata on FreeNAS"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freenas.md
4 +sidebar_label: "Install Netdata on FreeNAS"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Installation"
8 -->
9
10 # Install Netdata on FreeNAS
packaging/installer/methods/pfsense.md
+4
@@ -2,6 +2,10 @@
2 title: "Install Netdata on pfSense"
3 description: "Install Netdata on pfSense to monitor the health and performance of firewalls with thousands of real-time, per-second metrics."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md
5 +sidebar_label: "Install Netdata on pfSense"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Install Netdata on pfSense
packaging/installer/methods/synology.md
+4
@@ -2,6 +2,10 @@
2 title: "Install Netdata on Synology"
3 description: "The Netdata Agent can be installed on AMD64-compatible NAS systems using the 64-bit pre-compiled static binary."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md
5 +sidebar_label: "Install Netdata on Synology"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Install Netdata on Synology
packaging/maintainers/README.md
+4
@@ -2,6 +2,10 @@
2 title: "Package Maintainers"
3 date: 2020-03-31
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/maintainers/README.md
5 +sidebar_label: "Package Maintainers"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Developers"
9 -->
10
11 # Package Maintainers
packaging/makeself/README.md
+4
@@ -2,6 +2,10 @@
2 title: "Netdata static binary build"
3 description: "Users can build the static 64-bit binary package that we ship with every release of the open-source Netdata Agent for debugging or specialize purposes."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/makeself/README.md
5 +sidebar_label: "Netdata static binary build"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Installation"
9 -->
10
11 # Netdata static binary build
parser/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Parser"
3 custom_edit_url: https://github.com/netdata/netdata/blob/master/parser/README.md
4 +sidebar_label: "Parser"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Database"
8 -->
9
10
streaming/README.md
+4
@@ -2,6 +2,10 @@
2 title: "Streaming and replication"
3 description: "Replicate and mirror Netdata's metrics through real-time streaming from child to parent nodes. Then combine, correlate, and export."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/streaming/README.md
5 +sidebar_label: "Streaming and replication"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References"
9 -->
10
11
tests/health_mgmtapi/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Health command API tester"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgmtapi/README.md
4 +sidebar_label: "Health command API tester"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers"
8 -->
9
10 # Health command API tester
web/README.md
+4
@@ -2,6 +2,10 @@
2 title: "Dashboards"
3 description: "Every Netdata Agent comes bundled with hundreds of interactive, customizable charts designed by monitoring and troubleshooting experts."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/README.md
5 +sidebar_label: "Dashboards"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Developers/Web"
9 -->
10
11 # Dashboards
web/api/badges/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Netdata badges"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/badges/README.md
4 +sidebar_label: "Netdata badges"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api"
8 -->
9
10 # Netdata badges
web/api/exporters/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Exporters"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/README.md
4 +sidebar_label: "Exporters"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api"
8 -->
9
10 # Exporters
web/api/exporters/prometheus/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Prometheus exporter"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/prometheus/README.md
4 +sidebar_label: "Prometheus exporter"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Exporters"
8 -->
9
10 # Prometheus exporter
web/api/exporters/shell/README.md
+5 -1
@@ -1,6 +1,10 @@
1 <!--
2 -title: "shell exporter"
2 +title: "Shell exporter"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/shell/README.md
4 +sidebar_label: "Shell exporter"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Exporters"
8 -->
9
10 # shell exporter
web/api/formatters/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Query formatting"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/README.md
4 +sidebar_label: "Query formatting"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Formatters"
8 -->
9
10 # Query formatting
web/api/formatters/csv/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "CSV formatter"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/csv/README.md
4 +sidebar_label: "CSV formatter"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Formatters"
8 -->
9
10 # CSV formatter
web/api/formatters/json/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "JSON formatter"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/json/README.md
4 +sidebar_label: "JSON formatter"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Formatters"
8 -->
9
10 # JSON formatter
web/api/formatters/ssv/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "SSV formatter"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/ssv/README.md
4 +sidebar_label: "SSV formatter"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Formatters"
8 -->
9
10 # SSV formatter
web/api/formatters/value/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Value formatter"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/value/README.md
4 +sidebar_label: "Value formatter"
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Formatters"
8 -->
9
10 # Value formatter
web/api/health/README.md
+4
@@ -2,6 +2,10 @@
2 title: "Health API Calls"
3 date: 2020-04-27
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/health/README.md
5 +sidebar_label: "Health API Calls"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Developers/Web/Api"
9 -->
10
11 # Health API Calls
web/api/queries/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Database Queries"
3 +sidebar_label: "Database Queries"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # Database Queries
web/api/queries/average/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Average or Mean"
3 +sidebar_label: "Average or Mean"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/average/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # Average or Mean
web/api/queries/countif/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "CountIf"
3 +sidebar_label: "CountIf"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/countif/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # CountIf
web/api/queries/des/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "double exponential smoothing"
3 +sidebar_label: "double exponential smoothing"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/des/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # double exponential smoothing
web/api/queries/incremental_sum/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Incremental Sum (`incremental_sum`)"
3 +sidebar_label: "Incremental Sum (`incremental_sum`)"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/incremental_sum/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # Incremental Sum (`incremental_sum`)
web/api/queries/max/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Max"
3 +sidebar_label: "Max"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/max/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # Max
web/api/queries/median/README.md
+4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Median"
3 +sidebar_label: "Median"
4 description: "Use median in API queries and health entities to find the 'middle' value from a sample, eliminating any unwanted spikes in the returned metrics."
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/median/README.md
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Developers/Web/Api/Queries"
9 -->
10
11 # Median
web/api/queries/min/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Min"
3 +sidebar_label: "Min"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/min/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # Min
web/api/queries/percentile/README.md
+4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Percentile"
3 +sidebar_label: "Percentile"
4 description: "Use percentile in API queries and health entities to find the 'percentile' value from a sample, eliminating any unwanted spikes in the returned metrics."
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/percentile/README.md
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Developers/Web/Api/Queries"
9 -->
10
11 # Percentile
web/api/queries/ses/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Single (or Simple) Exponential Smoothing (`ses`)"
3 +sidebar_label: "Single (or Simple) Exponential Smoothing (`ses`)"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/ses/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # Single (or Simple) Exponential Smoothing (`ses`)
web/api/queries/stddev/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "standard deviation (`stddev`)"
3 +sidebar_label: "standard deviation (`stddev`)"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/stddev/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # standard deviation (`stddev`)
web/api/queries/sum/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Sum"
3 +sidebar_label: "Sum"
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/sum/README.md
5 +learn_status: "Published"
6 +learn_topic_type: "References"
7 +learn_rel_path: "Developers/Web/Api/Queries"
8 -->
9
10 # Sum
web/api/queries/trimmed_mean/README.md
+4
@@ -1,7 +1,11 @@
1 <!--
2 title: "Trimmed Mean"
3 +sidebar_label: "Trimmed Mean"
4 description: "Use trimmed-mean in API queries and health entities to find the average value from a sample, eliminating any unwanted spikes in the returned metrics."
5 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/trimmed_mean/README.md
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "Developers/Web/Api/Queries"
9 -->
10
11 # Trimmed Mean
web/gui/README.md
+12 -4
@@ -2,6 +2,10 @@
2 title: "Local Agent dashboard"
3 description: "The local Netdata Agent dashboard is the heart of health monitoring and performance troubleshooting, with hundreds of real-time charts."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/README.md
5 +sidebar_label: "Local Agent dashboard"
6 +learn_status: "Published"
7 +learn_topic_type: "References"
8 +learn_rel_path: "References"
9 -->
10
11 # Local Agent dashboard
@@ -28,10 +32,14 @@ behind an [Nginx proxy](https://github.com/netdata/netdata/blob/master/docs/Runn
32
33 Beyond charts, the local dashboard can be broken down into three key areas:
34
31 -1. [**Sections**](#sections)
32 -2. [**Time & date picker**](#time--date-picker)
33 -3. [**Metrics menus/submenus**](#metrics-menus)
34 -4. [**Netdata Cloud menus: Spaces, War Rooms, and Visited nodes)**](#cloud-menus-spaces-war-rooms-and-visited-nodes)
35 +- [Local Agent dashboard](#local-agent-dashboard)
36 + - [Navigating the local dashboard](#navigating-the-local-dashboard)
37 + - [Sections](#sections)
38 + - [Time \& date picker](#time--date-picker)
39 + - [Metrics menus](#metrics-menus)
40 + - [Cloud menus (Spaces, War Rooms, and Visited nodes)](#cloud-menus-spaces-war-rooms-and-visited-nodes)
41 + - [Customizing the local dashboard](#customizing-the-local-dashboard)
42 + - [Custom dashboards](#custom-dashboards)
43
44 ![Annotated screenshot of the local Agent
45 dashboard](https://user-images.githubusercontent.com/1153921/101509403-f7e59400-3935-11eb-9abd-cbecfa3ee49a.png)
web/gui/confluence/README.md
+4
@@ -1,6 +1,10 @@
1 <!--
2 title: "Atlassian Confluence dashboards"
3 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/confluence/README.md
4 +sidebar_label: "Atlassian Confluence dashboards"
5 +learn_status: "Published"
6 +learn_topic_type: "Tasks"
7 +learn_rel_path: "Developers/Web"
8 -->
9
10 # Atlassian Confluence dashboards
web/server/static/README.md
+4
@@ -2,6 +2,10 @@
2 title: "`static-threaded` web server"
3 description: "The Netdata Agent's static-threaded web server spawns a fixed number of threads that listen to web requests and uses non-blocking I/O."
4 custom_edit_url: https://github.com/netdata/netdata/edit/master/web/server/static/README.md
5 +sidebar_label: "`static-threaded` web server"
6 +learn_status: "Published"
7 +learn_topic_type: "Tasks"
8 +learn_rel_path: "Developers/Web"
9 -->
10
11 # `static-threaded` web server