0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-06 06:25:32 +00:00

Add markdown files in Learn ()

* 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
This commit is contained in:
Fotis Voutsas 2023-02-08 19:48:19 +02:00 committed by GitHub
parent 3f8806b328
commit 2c60f324ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
109 changed files with 558 additions and 100 deletions
build_external
collectors/python.d.plugin/pandas
contrib
contribution-guidelines.md
database/ram
docs
libnetdata
clocks
onewayalloc
socket
worker_utilization
packaging
parser
streaming
tests/health_mgmtapi
web
README.md
api
badges
exporters
formatters
health
queries

View file

@ -1,7 +1,10 @@
<!--
title: "External build-system"
date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/build_external/README.md
sidebar_label: "External build-system"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers"
-->
# External build-system

View file

@ -1,6 +1,10 @@
<!--
title: "Pandas"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/pandas/README.md
title: "Pandas Netdata Collector"
sidebar_label: "Pandas Netdata Collector"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "References/Collectors references"
-->
# Pandas Netdata Collector

View file

@ -1,6 +1,10 @@
<!--
title: "Netdata contrib"
custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/README.md
sidebar_label: "Netdata contrib"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers"
-->
# Netdata contrib

View file

@ -685,21 +685,11 @@ Some documents, like the Ansible guide and others in the `/docs/guides` folder,
this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of the path to the document in question. End
the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
For example, here is the frontmatter for the guide
about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/ansible.md).
```markdown
<!--
title: Deploy Netdata with Ansible
description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
image: /img/seo/guides/deploy/ansible.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
-->
<img width="751" alt="image" src="https://user-images.githubusercontent.com/43294513/217607958-ef0f270d-7947-4d91-a9a5-56b17b4255ee.png">
# Deploy Netdata with Ansible
...
```
Questions about frontmatter in documentation? [Ask on our community
forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).

View file

@ -2,6 +2,10 @@
title: "RAM database modes"
description: "Netdata's RAM database modes."
custom_edit_url: https://github.com/netdata/netdata/edit/master/database/ram/README.md
sidebar_label: "RAM database modes"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Database"
-->
# RAM modes

View file

@ -1,6 +1,10 @@
<!--
title: "Add more charts to Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-charts-to-netdata.md
sidebar_label: "Add more charts to Netdata"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Add more charts to Netdata

View file

@ -2,6 +2,10 @@
title: "Demo sites"
date: 2020-03-26
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md
sidebar_label: "Demo sites"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Demo sites

View file

@ -1,6 +1,10 @@
<!--
title: "Donations"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Donations-netdata-has-received.md
sidebar_label: "Donations"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Donations

View file

@ -1,6 +1,10 @@
<!--
title: "Read documentation on <https://learn.netdata.cloud>"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/README.md
sidebar_label: "Old welcome to Documentation message doc"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Read documentation on <https://learn.netdata.cloud>

View file

@ -1,6 +1,10 @@
<!--
title: "A GitHub star is important"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/a-github-star-is-important.md
sidebar_label: "A GitHub star is important"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Misc"
-->
# A GitHub star is important

View file

@ -2,6 +2,10 @@
title: "Use the Agent with Netdata Cloud"
date: 2020-05-04
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/agent-cloud.md
sidebar_label: "Use the Agent with Netdata Cloud"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Use the Agent with Netdata Cloud

View file

@ -1,6 +1,10 @@
<!--
title: "Anonymous statistics"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-statistics.md
sidebar_label: "Anonymous statistics"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "References"
-->
# Anonymous statistics

View file

@ -2,6 +2,10 @@
title: "Test the New Cloud Architecture"
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."
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/beta-architecture/new-architecture.md"
sidebar_label: "Test the New Cloud Architecture"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
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

View file

@ -2,6 +2,7 @@
title: "Netdata Cloud"
description: "Netdata Cloud is real-time visibility for entire infrastructures. View key metrics, insightful charts, and active alarms from all your nodes."
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx"
sidebar_label: "Netdata Cloud"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Getting Started"

View file

@ -2,6 +2,10 @@
title: "Contributing to documentation"
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."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md
sidebar_label: "Contributing to documentation"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Contributing to documentation

View file

@ -2,6 +2,10 @@
title: "Netdata style guide"
description: "The Netdata style guide establishes editorial guidelines for all of Netdata's writing, including documentation, blog posts, in-product UX copy, and more."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md
sidebar_label: "Netdata style guide"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Contribute"
-->
# Netdata style guide
@ -374,20 +378,9 @@ this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of th
the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
For example, here is the frontmatter for the guide
about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/ansible.md).
```markdown
<!--
title: Deploy Netdata with Ansible
description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
image: /img/seo/guides/deploy/ansible.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
-->
# Deploy Netdata with Ansible
...
```
<img width="751" alt="image" src="https://user-images.githubusercontent.com/43294513/217607958-ef0f270d-7947-4d91-a9a5-56b17b4255ee.png">
Questions about frontmatter in
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
For example, if you want to link to our node configuration document, link
to `https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md`. To reference
the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`.
the guide for deploying the Netdata Agent with Ansible, link to `/packaging/installer/methods/ansible.md`.
### References to UI elements

View file

@ -3,6 +3,10 @@ title: "Web server reference"
description: "The Netdata Agent's local static-threaded web server serves dashboards and real-time visualizations with security and DDoS protection."
type: reference
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/reference-web-server.mdx
sidebar_label: "Web server reference"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "References"
-->
# Web server reference

View file

@ -1,6 +1,10 @@
<!--
title: "Monitor Nginx or Apache web server log files with Netdata"
sidebar_label: "Monitor Nginx or Apache web server log files with Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-apache-nginx-web-logs.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# Monitor Nginx or Apache web server log files with Netdata

View file

@ -1,7 +1,11 @@
<!--
title: "Monitor Unbound DNS servers with Netdata"
sidebar_label: "Monitor Unbound DNS servers with Netdata"
date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-unbound-metrics.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# Monitor Unbound DNS servers with Netdata

View file

@ -1,8 +1,12 @@
<!--
title: How to optimize the Netdata Agent's performance
title: "How to optimize the Netdata Agent's performance"
sidebar_label: "How to optimize the Netdata Agent's performance"
description: "While the Netdata Agent is designed to monitor a system with only 1% CPU, you can optimize its performance for low-resource systems."
image: /img/seo/guides/configure/performance.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/configure/performance.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# How to optimize the Netdata Agent's performance

View file

@ -1,7 +1,11 @@
<!--
title: Export and visualize Netdata metrics in Graphite
title: "Export and visualize Netdata metrics in Graphite"
sidebar_label: "Export and visualize Netdata metrics in Graphite"
description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis."
image: /img/seo/guides/export/export-netdata-metrics-graphite.png
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'

View file

@ -1,7 +1,11 @@
<!--
title: "Netdata Longer Metrics Retention"
sidebar_label: "Netdata Longer Metrics Retention"
description: ""
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/longer-metrics-storage.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# Netdata Longer Metrics Retention

View file

@ -1,6 +1,10 @@
<!--
title: "Monitor CockroachDB metrics with Netdata"
sidebar_label: "Monitor CockroachDB metrics with Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-cockroachdb.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# Monitor CockroachDB metrics with Netdata
@ -20,9 +24,12 @@ Let's dive in and walk through the process of monitoring CockroachDB metrics wit
## What's in this guide
- [Configure the CockroachDB collector](#configure-the-cockroachdb-collector)
- [Monitor CockroachDB metrics with Netdata](#monitor-cockroachdb-metrics-with-netdata)
- [What's in this guide](#whats-in-this-guide)
- [Configure the CockroachDB collector](#configure-the-cockroachdb-collector)
- [Manual setup for a local CockroachDB database](#manual-setup-for-a-local-cockroachdb-database)
- [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms)
- [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms)
- [What's next?](#whats-next)
## Configure the CockroachDB collector

View file

@ -1,6 +1,10 @@
<!--
title: "Monitor a Hadoop cluster with Netdata"
sidebar_label: "Monitor a Hadoop cluster with Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-hadoop-cluster.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# Monitor a Hadoop cluster with Netdata

View file

@ -1,11 +1,15 @@
<!--
title: "Detect anomalies in systems and applications"
sidebar_label: "Detect anomalies in systems and applications"
description: "Detect anomalies in any system, container, or application in your infrastructure with machine learning and the open-source Netdata Agent."
image: /img/seo/guides/monitor/anomaly-detection.png
author: "Joel Hans"
author_title: "Editorial Director, Technical & Educational Resources"
author_img: "/img/authors/joel-hans.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/anomaly-detection-python.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
# Detect anomalies in systems and applications

View file

@ -1,11 +1,15 @@
<!--
title: "Machine learning (ML) powered anomaly detection"
sidebar_label: "Machine learning (ML) powered anomaly detection"
description: "Detect anomalies in any system, container, or application in your infrastructure with machine learning and the open-source Netdata Agent."
image: /img/seo/guides/monitor/anomaly-detection.png
author: "Andrew Maguire"
author_title: "Analytics & ML Lead"
author_img: "/img/authors/andy-maguire.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/anomaly-detection.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->

View file

@ -1,6 +1,10 @@
<!--
title: "Use dimension templates to create dynamic alarms"
sidebar_label: "Use dimension templates to create dynamic alarms"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/dimension-templates.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
# Use dimension templates to create dynamic alarms

View file

@ -1,11 +1,15 @@
<!--
title: "Kubernetes monitoring with Netdata: Overview and visualizations"
sidebar_label: "Kubernetes monitoring with Netdata: Overview and visualizations"
description: "Learn how to navigate Netdata's Kubernetes monitoring features for visualizing the health and performance of a Kubernetes cluster with per-second granularity."
image: /img/seo/guides/monitor/kubernetes-k8s-netdata.png
author: "Joel Hans"
author_title: "Editorial Director, Technical & Educational Resources"
author_img: "/img/authors/joel-hans.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/kubernetes-k8s-netdata.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
# Kubernetes monitoring with Netdata: Overview and visualizations

View file

@ -1,11 +1,15 @@
<!--
title: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata"
sidebar_label: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata"
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."
image: /img/seo/guides/monitor/lamp-stack.png
author: "Joel Hans"
author_title: "Editorial Director, Technical & Educational Resources"
author_img: "/img/authors/joel-hans.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/lamp-stack.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'

View file

@ -1,8 +1,12 @@
<!--
title: "Monitor Pi-hole (and a Raspberry Pi) with Netdata"
sidebar_label: "Monitor Pi-hole (and a Raspberry Pi) with Netdata"
description: "Monitor Pi-hole metrics, plus Raspberry Pi system metrics, in minutes and completely for free with Netdata's open-source monitoring agent."
image: /img/seo/guides/monitor/netdata-pi-hole-raspberry-pi.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/pi-hole-raspberry-pi.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'

View file

@ -1,8 +1,12 @@
<!--
title: Monitor any process in real-time with Netdata
sidebar_label: Monitor any process in real-time with Netdata
description: "Tap into Netdata's powerful collectors, with per-second utilization metrics for every process, to troubleshoot faster and make data-informed decisions."
image: /img/seo/guides/monitor/process.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/process.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
# Monitor any process in real-time with Netdata

View file

@ -1,11 +1,15 @@
<!--
title: "Unsupervised anomaly detection for Raspberry Pi monitoring"
sidebar_label: "Unsupervised anomaly detection for Raspberry Pi monitoring"
description: "Use a low-overhead machine learning algorithm and an open-source monitoring tool to detect anomalous metrics on a Raspberry Pi."
image: /img/seo/guides/monitor/raspberry-pi-anomaly-detection.png
author: "Andy Maguire"
author_title: "Senior Machine Learning Engineer"
author_img: "/img/authors/andy-maguire.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/raspberry-pi-anomaly-detection.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
We love IoT and edge at Netdata, we also love machine learning. Even better if we can combine the two to ease the pain

View file

@ -1,11 +1,15 @@
<!--
title: How to use any StatsD data source with Netdata
sidebar_label: How to use any StatsD data source with Netdata
description: "Learn how to monitor any custom application instrumented with StatsD with per-second metrics and fully customizable, interactive charts."
image: /img/seo/guides/monitor/statsd.png
author: "Odysseas Lamtzidis"
author_title: "Developer Advocate"
author_img: "/img/authors/odysseas-lamtzidis.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/statsd.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
# StatsD Guide

View file

@ -1,6 +1,10 @@
<!--
title: "Stop notifications for individual alarms"
sidebar_label: "Stop notifications for individual alarms"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/stop-notifications-alarms.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
# Stop notifications for individual alarms

View file

@ -1,11 +1,15 @@
<!--
title: "Monitor and visualize anomalies with Netdata (part 2)"
sidebar_label: "Monitor and visualize anomalies with Netdata (part 2)"
description: "Using unsupervised anomaly detection and machine learning, get notified "
image: /img/seo/guides/monitor/visualize-monitor-anomalies.png
author: "Joel Hans"
author_title: "Editorial Director, Technical & Educational Resources"
author_img: "/img/authors/joel-hans.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/visualize-monitor-anomalies.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Monitor"
-->
Welcome to part 2 of our series of guides on using _unsupervised anomaly detection_ to detect issues with your systems,

View file

@ -1,11 +1,15 @@
<!--
title: "Develop a custom data collector in Python"
sidebar_label: "Develop a custom data collector in Python"
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."
image: /img/seo/guides/python-collector.png
author: "Panagiotis Papaioannou"
author_title: "University of Patras"
author_img: "/img/authors/panagiotis-papaioannou.jpg"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/python-collector.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# Develop a custom data collector in Python

View file

@ -1,7 +1,11 @@
<!--
title: "The step-by-step Netdata guide"
sidebar_label: "The step-by-step Netdata guide"
date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-00.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'

View file

@ -1,6 +1,10 @@
<!--
title: "Step 1. Netdata's building blocks"
sidebar_label: "Step 1. Netdata's building blocks"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-01.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 1. Netdata's building blocks
@ -29,9 +33,16 @@ be)](https://blog.netdata.cloud/posts/redefining-monitoring-netdata/)_.
In the first step of the Netdata guide, you'll learn about:
- [Netdata's core features](#netdatas-core-features)
- [Why you should use Netdata](#why-you-should-use-netdata)
- [How Netdata has complementary systems, not competitors](#how-netdata-has-complementary-systems-not-competitors)
- [Step 1. Netdata's building blocks](#step-1-netdatas-building-blocks)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Netdata's core features](#netdatas-core-features)
- [Why you should use Netdata](#why-you-should-use-netdata)
- [Per-second data collection](#per-second-data-collection)
- [Unlimited metrics](#unlimited-metrics)
- [Meaningful presentation](#meaningful-presentation)
- [Immediate results](#immediate-results)
- [How Netdata has complementary systems, not competitors](#how-netdata-has-complementary-systems-not-competitors)
- [What's next?](#whats-next)
Let's get started!

View file

@ -1,7 +1,11 @@
<!--
title: "Step 2. Get to know Netdata's dashboard"
sidebar_label: "Step 2. Get to know Netdata's dashboard"
date: 2020-05-04
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-02.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 2. Get to know Netdata's dashboard
@ -18,11 +22,18 @@ over here and dig in.
In this step of the Netdata guide, you'll learn how to:
- [Visit and explore the dashboard](#visit-and-explore-the-dashboard)
- [Explore available charts using menus](#explore-available-charts-using-menus)
- [Read the descriptions accompanying charts](#read-the-descriptions-accompanying-charts)
- [Interact with charts](#interact-with-charts)
- [See raised alarms and the alarm log](#see-raised-alarms-and-the-alarm-log)
- [Step 2. Get to know Netdata's dashboard](#step-2-get-to-know-netdatas-dashboard)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Visit and explore the dashboard](#visit-and-explore-the-dashboard)
- [Explore available charts using menus](#explore-available-charts-using-menus)
- [Read the descriptions accompanying charts](#read-the-descriptions-accompanying-charts)
- [Understand charts, dimensions, families, and contexts](#understand-charts-dimensions-families-and-contexts)
- [Interact with charts](#interact-with-charts)
- [Pan, zoom, highlight, and reset charts](#pan-zoom-highlight-and-reset-charts)
- [Show and hide dimensions](#show-and-hide-dimensions)
- [Resize charts](#resize-charts)
- [See raised alarms and the alarm log](#see-raised-alarms-and-the-alarm-log)
- [What's next?](#whats-next)
Let's get started!

View file

@ -1,7 +1,11 @@
<!--
title: "Step 3. Monitor more than one system with Netdata"
sidebar_label: "Step 3. Monitor more than one system with Netdata"
date: 2020-05-01
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-03.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 3. Monitor more than one system with Netdata

View file

@ -1,7 +1,11 @@
<!--
title: "Step 4. The basics of configuring Netdata"
sidebar_label: "Step 4. The basics of configuring Netdata"
date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-04.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 4. The basics of configuring Netdata
@ -17,10 +21,13 @@ Next up: configuration.
We'll talk about Netdata's default configuration, and then you'll learn how to do the following:
- [Find your `netdata.conf` file](#find-your-netdataconf-file)
- [Use edit-config to open `netdata.conf`](#use-edit-config-to-open-netdataconf)
- [Navigate the structure of `netdata.conf`](#the-structure-of-netdataconf)
- [Edit your `netdata.conf` file](#edit-your-netdataconf-file)
- [Step 4. The basics of configuring Netdata](#step-4-the-basics-of-configuring-netdata)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Find your `netdata.conf` file](#find-your-netdataconf-file)
- [Use edit-config to open `netdata.conf`](#use-edit-config-to-open-netdataconf)
- [The structure of `netdata.conf`](#the-structure-of-netdataconf)
- [Edit your `netdata.conf` file](#edit-your-netdataconf-file)
- [What's next?](#whats-next)
## Find your `netdata.conf` file

View file

@ -1,6 +1,10 @@
<!--
title: "Step 5. Health monitoring alarms and notifications"
sidebar_label: "Step 5. Health monitoring alarms and notifications"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-05.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 5. Health monitoring alarms and notifications
@ -20,9 +24,15 @@ Luckily, Netdata's alarm and notification system are incredibly adaptable to you
We'll talk about Netdata's default configuration, and then you'll learn how to do the following:
- [Tune Netdata's pre-configured alarms](#tune-netdatas-pre-configured-alarms)
- [Write your first health entity](#write-your-first-health-entity)
- [Enable Netdata's notification systems](#enable-netdatas-notification-systems)
- [Step 5. Health monitoring alarms and notifications](#step-5-health-monitoring-alarms-and-notifications)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Tune Netdata's pre-configured alarms](#tune-netdatas-pre-configured-alarms)
- [Silence an individual alarm](#silence-an-individual-alarm)
- [Write your first health entity](#write-your-first-health-entity)
- [Enable Netdata's notification systems](#enable-netdatas-notification-systems)
- [Email notifications](#email-notifications)
- [Enable Slack notifications](#enable-slack-notifications)
- [What's next?](#whats-next)
## Tune Netdata's pre-configured alarms

View file

@ -1,6 +1,10 @@
<!--
title: "Step 6. Collect metrics from more services and apps"
sidebar_label: "Step 6. Collect metrics from more services and apps"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-06.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 6. Collect metrics from more services and apps
@ -21,9 +25,12 @@ source you want to monitor.
We'll begin with an overview on Netdata's collector architecture, and then dive into the following:
- [Netdata's collector architecture](#netdatas-collector-architecture)
- [Enable and disable plugins](#enable-and-disable-plugins)
- [Enable the Nginx collector as an example](#example-enable-the-nginx-collector)
- [Step 6. Collect metrics from more services and apps](#step-6-collect-metrics-from-more-services-and-apps)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Netdata's collector architecture](#netdatas-collector-architecture)
- [Enable and disable plugins](#enable-and-disable-plugins)
- [Example: Enable the Nginx collector](#example-enable-the-nginx-collector)
- [What's next?](#whats-next)
## Netdata's collector architecture

View file

@ -1,7 +1,11 @@
<!--
title: "Step 7. Netdata's dashboard in depth"
sidebar_label: "Step 7. Netdata's dashboard in depth"
date: 2020-05-04
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-07.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# 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
In this step of the Netdata guide, you'll learn how to:
- [Change the dashboard's settings](#change-the-dashboards-settings)
- [Check if there's an update to Netdata](#check-if-theres-an-update-to-netdata)
- [Export and import a snapshot](#export-and-import-a-snapshot)
- [Step 7. Netdata's dashboard in depth](#step-7-netdatas-dashboard-in-depth)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Change the dashboard's settings](#change-the-dashboards-settings)
- [Check if there's an update to Netdata](#check-if-theres-an-update-to-netdata)
- [Export and import a snapshot](#export-and-import-a-snapshot)
- [What's next?](#whats-next)
Let's get started!

View file

@ -1,6 +1,10 @@
<!--
title: "Step 8. Build your first custom dashboard"
sidebar_label: "Step 8. Build your first custom dashboard"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-08.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 8. Build your first custom dashboard
@ -14,11 +18,19 @@ really flexible. 🤸
In this step of the Netdata guide, you'll learn:
- [Why you might want a custom dashboard](#why-should-i-create-a-custom-dashboard)
- [How to create and prepare your `custom-dashboard.html` file](#create-and-prepare-your-custom-dashboardhtml-file)
- [Where to add `dashboard.js` to your custom dashboard file](#add-dashboardjs-to-your-custom-dashboard-file)
- [How to add basic styling](#add-some-basic-styling)
- [How to add charts of different types, shapes, and sizes](#creating-your-dashboards-charts)
- [Step 8. Build your first custom dashboard](#step-8-build-your-first-custom-dashboard)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Why should I create a custom dashboard?](#why-should-i-create-a-custom-dashboard)
- [Create and prepare your `custom-dashboard.html` file](#create-and-prepare-your-custom-dashboardhtml-file)
- [Add `dashboard.js` to your custom dashboard file](#add-dashboardjs-to-your-custom-dashboard-file)
- [Add some basic styling](#add-some-basic-styling)
- [Creating your dashboard's charts](#creating-your-dashboards-charts)
- [The chart unique ID (required)](#the-chart-unique-id-required)
- [Set chart duration](#set-chart-duration)
- [Set chart size](#set-chart-size)
- [Final touches](#final-touches)
- [The final `custom-dashboard.html`](#the-final-custom-dashboardhtml)
- [What's next?](#whats-next)
Let's get on with it!

View file

@ -1,6 +1,10 @@
<!--
title: "Step 9. Long-term metrics storage"
sidebar_label: "Step 9. Long-term metrics storage"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-09.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# 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
In this step of the Netdata guide, you'll learn how to:
- [Tweak the database engine's settings](#tweak-the-database-engines-settings)
- [Archive metrics to an external database](#archive-metrics-to-an-external-database)
- [Use the MongoDB database](#archive-metrics-via-the-mongodb-exporting-connector)
- [Step 9. Long-term metrics storage](#step-9-long-term-metrics-storage)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Tweak the database engine's settings](#tweak-the-database-engines-settings)
- [Archive metrics to an external database](#archive-metrics-to-an-external-database)
- [Archive metrics via the MongoDB exporting connector](#archive-metrics-via-the-mongodb-exporting-connector)
- [What's next?](#whats-next)
Let's get started!

View file

@ -1,6 +1,10 @@
<!--
title: "Step 10. Set up a proxy"
sidebar_label: "Step 10. Set up a proxy"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-10.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step 10. Set up a proxy
@ -24,10 +28,17 @@ publicly-accessible remote server.
In this step of the Netdata guide, you'll learn:
- [What a proxy is and the benefits of using one](#wait-whats-a-proxy)
- [How to connect Netdata to Nginx](#connect-netdata-to-nginx)
- [How to enable HTTPS in Nginx](#enable-https-in-nginx)
- [How to secure your Netdata dashboard with a password](#secure-your-netdata-dashboard-with-a-password)
- [Step 10. Set up a proxy](#step-10-set-up-a-proxy)
- [What you'll learn in this step](#what-youll-learn-in-this-step)
- [Wait. What's a proxy?](#wait-whats-a-proxy)
- [Required before you start](#required-before-you-start)
- [Nginx and Certbot](#nginx-and-certbot)
- [Fully qualified domain name](#fully-qualified-domain-name)
- [Subdomain for Netdata](#subdomain-for-netdata)
- [Connect Netdata to Nginx](#connect-netdata-to-nginx)
- [Enable HTTPS in Nginx](#enable-https-in-nginx)
- [Secure your Netdata dashboard with a password](#secure-your-netdata-dashboard-with-a-password)
- [What's next?](#whats-next)
Let's dive in!

View file

@ -1,6 +1,10 @@
<!--
title: "Step ∞. You're finished!"
title: "You're finished"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-99.md
sidebar_label: "You're finished"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Step by step"
-->
# Step ∞. You're finished!

View file

@ -1,8 +1,12 @@
<!--
title: "Monitor, troubleshoot, and debug applications with eBPF metrics"
sidebar_label: "Monitor, troubleshoot, and debug applications with eBPF metrics"
description: "Use Netdata's built-in eBPF metrics collector to monitor, troubleshoot, and debug your custom application using low-level kernel feedback."
image: /img/seo/guides/troubleshoot/monitor-debug-applications-ebpf.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Troubleshoot"
-->
# Monitor, troubleshoot, and debug applications with eBPF metrics

View file

@ -1,7 +1,11 @@
<!--
title: "Troubleshoot Agent-Cloud connectivity issues"
sidebar_label: "Troubleshoot Agent-Cloud connectivity issues"
description: "A simple guide to troubleshoot occurrences where the Agent is showing as offline after claiming."
custom_edit_url: https://github.com/netdata/netdata/edit/master/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides/Troubleshoot"
-->
# Troubleshoot Agent-Cloud connectivity issues
@ -13,9 +17,13 @@ We identified some scenarios that might cause this delay and possible actions yo
The most common explanation for the delay usually falls into one of the following three categories:
- [The claiming process of the kickstart script was unsuccessful](#the-claiming-process-of-the-kickstart-script-was-unsuccessful)
- [Claiming on an older, deprecated version of the Agent](#claiming-on-an-older-deprecated-version-of-the-agent)
- [Network issues while connecting to the Cloud](#network-issues-while-connecting-to-the-cloud)
- [Troubleshoot Agent-Cloud connectivity issues](#troubleshoot-agent-cloud-connectivity-issues)
- [The claiming process of the kickstart script was unsuccessful](#the-claiming-process-of-the-kickstart-script-was-unsuccessful)
- [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)
- [Claiming on an older, deprecated version of the Agent](#claiming-on-an-older-deprecated-version-of-the-agent)
- [Network issues while connecting to the Cloud](#network-issues-while-connecting-to-the-cloud)
- [Verify that your IP is whitelisted from Netdata Cloud](#verify-that-your-ip-is-whitelisted-from-netdata-cloud)
- [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)
## The claiming process of the kickstart script was unsuccessful

View file

@ -1,6 +1,10 @@
<!--
title: "Use host labels to organize systems, metrics, and alarms"
sidebar_label: "Use host labels to organize systems, metrics, and alarms"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/using-host-labels.md
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Guides"
-->
# Use host labels to organize systems, metrics, and alarms

View file

@ -1,6 +1,10 @@
<!--
title: "Netdata for IoT"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-for-IoT.md
sidebar_label: "Netdata for IoT"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Guides"
-->
# Netdata for IoT

View file

@ -1,6 +1,10 @@
<!--
title: "Security design"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-security.md
sidebar_label: "Add more charts to Netdata"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Concepts"
-->
# Security design
@ -9,16 +13,21 @@ We have given special attention to all aspects of Netdata, ensuring that everyth
**Table of Contents**
1. [Your data is safe with Netdata](#your-data-is-safe-with-netdata)
2. [Your systems are safe with Netdata](#your-systems-are-safe-with-netdata)
3. [Netdata is read-only](#netdata-is-read-only)
4. [Netdata viewers authentication](#netdata-viewers-authentication)
* [Why Netdata should be protected](#why-netdata-should-be-protected)
* [Protect Netdata from the internet](#protect-netdata-from-the-internet)
* [Expose Netdata only in a private LAN](#expose-netdata-only-in-a-private-lan)
* [Use an authenticating web server in proxy mode](#use-an-authenticating-web-server-in-proxy-mode)
* [Other methods](#other-methods)
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)
- [Security design](#security-design)
- [Your data is safe with Netdata](#your-data-is-safe-with-netdata)
- [Your systems are safe with Netdata](#your-systems-are-safe-with-netdata)
- [Netdata is read-only](#netdata-is-read-only)
- [Netdata viewers authentication](#netdata-viewers-authentication)
- [Why Netdata should be protected](#why-netdata-should-be-protected)
- [Protect Netdata from the internet](#protect-netdata-from-the-internet)
- [Expose Netdata only in a private LAN](#expose-netdata-only-in-a-private-lan)
- [Fine-grained access control](#fine-grained-access-control)
- [Use an authenticating web server in proxy mode](#use-an-authenticating-web-server-in-proxy-mode)
- [Other methods](#other-methods)
- [Anonymous Statistics](#anonymous-statistics)
- [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)
- [Opt-out of anonymous statistics](#opt-out-of-anonymous-statistics)
- [Netdata directories](#netdata-directories)
## Your data is safe with Netdata

View file

@ -2,6 +2,10 @@
title: "Use Netdata standalone or as part of your monitoring stack"
description: "Netdata can run independently or as part of a larger monitoring stack thanks to its flexibility, interoperable core, and exporting features."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/netdata-monitoring-stack.md
sidebar_label: "Use Netdata standalone or as part of your monitoring stack"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Use Netdata standalone or as part of your monitoring stack

View file

@ -2,6 +2,10 @@
title: "What is Netdata?"
description: "Netdata is distributed, real-time performance and health monitoring for systems and applications on a single node or an entire infrastructure."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/what-is-netdata.md
sidebar_label: "What is Netdata"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Getting started"
-->
# What is Netdata?

View file

@ -2,6 +2,10 @@
title: "Why use Netdata?"
description: "Netdata is simple to deploy, scalable, and optimized for troubleshooting. Cut the complexity and expense out of your monitoring stack."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/why-netdata.md
sidebar_label: "Why use Netdata"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Getting started"
-->
# Why use Netdata?

View file

@ -1,8 +1,11 @@
<!--
title: "Infrastructure monitoring with Netdata"
sidebar_label: "Infrastructure monitoring"
description: "Build a robust, infinitely scalable infrastructure monitoring solution with Netdata. Any number of nodes and every available metric."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/infrastructure.md
sidebar_label: "Infrastructure monitoring with Netdata"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Infrastructure monitoring with Netdata

View file

@ -1,8 +1,11 @@
<!--
title: "Single-node monitoring with Netdata"
sidebar_label: "Single-node monitoring"
description: "Learn dashboard basics, configuring your nodes, and collecting metrics from applications to create a powerful single-node monitoring tool."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/single-node.md
sidebar_label: "Infrastructure monitoring with Netdata"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Possible old, not wanted documents"
-->
# Single-node monitoring with Netdata

View file

@ -2,6 +2,10 @@
title: "Create new dashboards"
description: "Create new dashboards in Netdata Cloud, with any number of metrics from any node on your infrastructure, for targeted troubleshooting."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/create-dashboards.md
sidebar_label: "Create new dashboards"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Operations/Netdata Cloud Visualizations"
-->
# Create new dashboards

View file

@ -2,6 +2,10 @@
title: "Interact with dashboards and charts"
description: "Zoom, highlight, and pan through time on hundreds of real-time, interactive charts to quickly discover the root cause of any anomaly."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/interact-dashboards-charts.md
sidebar_label: "Interact with dashboards and charts"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Operations/Netdata Cloud Visualizations"
-->
# Interact with dashboards and charts

View file

@ -2,6 +2,10 @@
title: "See an overview of your infrastructure"
description: "With Netdata Cloud's War Rooms, you can see real-time metrics, from any number of nodes in your infrastructure, in composite charts."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/overview-infrastructure.md
sidebar_label: "See an overview of your infrastructure"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Operations/Netdata Cloud Visualizations"
-->
# See an overview of your infrastructure

View file

@ -1,6 +1,10 @@
<!--
title: "1s granularity"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/1s-granularity.md
sidebar_label: "1s granularity"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Concepts/Why Netdata"
-->
# 1s granularity

View file

@ -1,6 +1,10 @@
<!--
title: "Why Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/README.md
sidebar_label: "Why Netdata"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Concepts/Why Netdata"
-->
# Why Netdata

View file

@ -1,6 +1,10 @@
<!--
title: "Immediate results"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/immediate-results.md
sidebar_label: "Immediate results"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Concepts/Why Netdata"
-->
# Immediate results

View file

@ -1,6 +1,10 @@
<!--
title: "Meaningful presentation"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/meaningful-presentation.md
sidebar_label: "Meaningful presentation"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Concepts/Why Netdata"
-->
# Meaningful presentation

View file

@ -1,6 +1,10 @@
<!--
title: "Unlimited metrics"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/unlimited-metrics.md
sidebar_label: "Unlimited metrics"
learn_status: "Published"
learn_topic_type: "Concepts"
learn_rel_path: "Concepts/Why Netdata"
-->
# Unlimited metrics

View file

@ -1,5 +1,8 @@
<!--
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/clocks/README.md
custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/clocks/README.md"
title: "Clocks"
sidebar_label: "Clocks"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/libnetdata libraries"
-->

View file

@ -1,6 +1,6 @@
<!--
title: "One Way Allocator"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/onewayalloc/README.md"
sidebar_label: "One way allocator"
learn_status: "Published"
learn_topic_type: "Tasks"

View file

@ -1,5 +1,8 @@
<!--
Title: "Socket"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/socket/README.md
sidebar_label: "Socket"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/libnetdata libraries"
-->

View file

@ -1,6 +1,6 @@
<!--
title: "Worker Utilization"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/worker_utilization/README.md
-->
# Worker Utilization

View file

@ -1,7 +1,11 @@
<!--
title: How to build native (DEB/RPM) packages locally for testing
title: "How to build native (DEB/RPM) packages locally for testing"
sidebar_label: "How to build native (DEB/RPM) packages locally for testing"
description: Instructions for developers who need to build native packages locally for testing.
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/building-native-packages-locally.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Installation"
-->
# How to build native (DEB/RPM) packages locally for testing

View file

@ -1,5 +1,5 @@
<!--
title: Deploy Netdata with Ansible
title: "Deploy Netdata with Ansible"
description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
image: /img/seo/guides/deploy/ansible.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/ansible.md

View file

@ -2,6 +2,10 @@
title: "Install Netdata on cloud providers"
description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/cloud-providers.md
sidebar_label: "Install Netdata on cloud providers"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Installation"
-->
# Install Netdata on cloud providers
@ -18,9 +22,13 @@ aims to document some of those steps for popular cloud providers.
> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request.md)
> with your process and instructions on using the provider's interface to complete the workaround.
- [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
- [Post-installation configuration](#post-installation-configuration)
- [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard)
- [Install Netdata on cloud providers](#install-netdata-on-cloud-providers)
- [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
- [Post-installation configuration](#post-installation-configuration)
- [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard)
- [Google Cloud Platform (GCP)](#google-cloud-platform-gcp)
- [Amazon Web Services (AWS) / EC2](#amazon-web-services-aws--ec2)
- [Azure](#azure)
## Recommended installation methods for cloud providers

View file

@ -2,6 +2,10 @@
title: "Install Netdata on FreeBSD"
description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md
sidebar_label: "Install Netdata on FreeBSD"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Installation"
-->
# Install Netdata on FreeBSD

View file

@ -1,6 +1,10 @@
<!--
title: "Install Netdata on FreeNAS"
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freenas.md
sidebar_label: "Install Netdata on FreeNAS"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Installation"
-->
# Install Netdata on FreeNAS

View file

@ -2,6 +2,10 @@
title: "Install Netdata on pfSense"
description: "Install Netdata on pfSense to monitor the health and performance of firewalls with thousands of real-time, per-second metrics."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md
sidebar_label: "Install Netdata on pfSense"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Installation"
-->
# Install Netdata on pfSense

View file

@ -2,6 +2,10 @@
title: "Install Netdata on Synology"
description: "The Netdata Agent can be installed on AMD64-compatible NAS systems using the 64-bit pre-compiled static binary."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md
sidebar_label: "Install Netdata on Synology"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Installation"
-->
# Install Netdata on Synology

View file

@ -2,6 +2,10 @@
title: "Package Maintainers"
date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/maintainers/README.md
sidebar_label: "Package Maintainers"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers"
-->
# Package Maintainers

View file

@ -2,6 +2,10 @@
title: "Netdata static binary build"
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."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/makeself/README.md
sidebar_label: "Netdata static binary build"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Installation"
-->
# Netdata static binary build

View file

@ -1,6 +1,10 @@
<!--
title: "Parser"
custom_edit_url: https://github.com/netdata/netdata/blob/master/parser/README.md
sidebar_label: "Parser"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Database"
-->

View file

@ -2,6 +2,10 @@
title: "Streaming and replication"
description: "Replicate and mirror Netdata's metrics through real-time streaming from child to parent nodes. Then combine, correlate, and export."
custom_edit_url: https://github.com/netdata/netdata/edit/master/streaming/README.md
sidebar_label: "Streaming and replication"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "References"
-->

View file

@ -1,6 +1,10 @@
<!--
title: "Health command API tester"
custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgmtapi/README.md
sidebar_label: "Health command API tester"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers"
-->
# Health command API tester

View file

@ -2,6 +2,10 @@
title: "Dashboards"
description: "Every Netdata Agent comes bundled with hundreds of interactive, customizable charts designed by monitoring and troubleshooting experts."
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/README.md
sidebar_label: "Dashboards"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web"
-->
# Dashboards

View file

@ -1,6 +1,10 @@
<!--
title: "Netdata badges"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/badges/README.md
sidebar_label: "Netdata badges"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api"
-->
# Netdata badges

View file

@ -1,6 +1,10 @@
<!--
title: "Exporters"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/README.md
sidebar_label: "Exporters"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api"
-->
# Exporters

View file

@ -1,6 +1,10 @@
<!--
title: "Prometheus exporter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/prometheus/README.md
sidebar_label: "Prometheus exporter"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Exporters"
-->
# Prometheus exporter

View file

@ -1,6 +1,10 @@
<!--
title: "shell exporter"
title: "Shell exporter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/shell/README.md
sidebar_label: "Shell exporter"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Exporters"
-->
# shell exporter

View file

@ -1,6 +1,10 @@
<!--
title: "Query formatting"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/README.md
sidebar_label: "Query formatting"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Formatters"
-->
# Query formatting

View file

@ -1,6 +1,10 @@
<!--
title: "CSV formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/csv/README.md
sidebar_label: "CSV formatter"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Formatters"
-->
# CSV formatter

View file

@ -1,6 +1,10 @@
<!--
title: "JSON formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/json/README.md
sidebar_label: "JSON formatter"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Formatters"
-->
# JSON formatter

View file

@ -1,6 +1,10 @@
<!--
title: "SSV formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/ssv/README.md
sidebar_label: "SSV formatter"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Formatters"
-->
# SSV formatter

View file

@ -1,6 +1,10 @@
<!--
title: "Value formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/value/README.md
sidebar_label: "Value formatter"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Formatters"
-->
# Value formatter

View file

@ -2,6 +2,10 @@
title: "Health API Calls"
date: 2020-04-27
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/health/README.md
sidebar_label: "Health API Calls"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api"
-->
# Health API Calls

View file

@ -1,6 +1,10 @@
<!--
title: "Database Queries"
sidebar_label: "Database Queries"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/README.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Queries"
-->
# Database Queries

View file

@ -1,6 +1,10 @@
<!--
title: "Average or Mean"
sidebar_label: "Average or Mean"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/average/README.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Queries"
-->
# Average or Mean

View file

@ -1,6 +1,10 @@
<!--
title: "CountIf"
sidebar_label: "CountIf"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/countif/README.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Queries"
-->
# CountIf

View file

@ -1,6 +1,10 @@
<!--
title: "double exponential smoothing"
sidebar_label: "double exponential smoothing"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/des/README.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Queries"
-->
# double exponential smoothing

View file

@ -1,6 +1,10 @@
<!--
title: "Incremental Sum (`incremental_sum`)"
sidebar_label: "Incremental Sum (`incremental_sum`)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/incremental_sum/README.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Queries"
-->
# Incremental Sum (`incremental_sum`)

View file

@ -1,6 +1,10 @@
<!--
title: "Max"
sidebar_label: "Max"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/max/README.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Queries"
-->
# Max

View file

@ -1,7 +1,11 @@
<!--
title: "Median"
sidebar_label: "Median"
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."
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/median/README.md
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Developers/Web/Api/Queries"
-->
# Median

Some files were not shown because too many files have changed in this diff Show more