summaryrefslogtreecommitdiffstats
path: root/docs/getting-started
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-05-08 16:27:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-05-08 16:27:04 +0000
commita836a244a3d2bdd4da1ee2641e3e957850668cea (patch)
treecb87c75b3677fab7144f868435243f864048a1e6 /docs/getting-started
parentAdding upstream version 1.38.1. (diff)
downloadnetdata-a836a244a3d2bdd4da1ee2641e3e957850668cea.tar.xz
netdata-a836a244a3d2bdd4da1ee2641e3e957850668cea.zip
Adding upstream version 1.39.0.upstream/1.39.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/getting-started')
-rw-r--r--docs/getting-started/integrations.md12
-rw-r--r--docs/getting-started/introduction.md113
2 files changed, 74 insertions, 51 deletions
diff --git a/docs/getting-started/integrations.md b/docs/getting-started/integrations.md
deleted file mode 100644
index 9f38a67d0..000000000
--- a/docs/getting-started/integrations.md
+++ /dev/null
@@ -1,12 +0,0 @@
-<!--
-title: "Integrations"
-sidebar_label: "Integrations"
-custom_edit_url: null
-learn_status: "Published"
-learn_topic_type: "Getting started"
-learn_rel_path: "Getting started"
-learn_docs_purpose: "Present all the Netdata integrations"
-learn_doc_type: "AUTOGENERATED"
--->
-
-This page is autogenerated, this is placeholder document \ No newline at end of file
diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md
index 1ace5e3a6..b164074bd 100644
--- a/docs/getting-started/introduction.md
+++ b/docs/getting-started/introduction.md
@@ -1,13 +1,6 @@
-<!--
-title: "Introduction"
-sidebar_label: "Introduction"
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/getting-started/intro.md"
-learn_status: "Published"
-sidebar_position: "1"
-learn_topic_type: "Getting started"
-learn_rel_path: "Getting started"
-learn_docs_purpose: "Present netdata in a nutshell"
--->
+# Getting started with Netdata
+
+Learn how Netdata can get you monitoring your infrastructure in minutes.
## What is Netdata ?
@@ -21,34 +14,34 @@ Netdata is:
### Simple to deploy
-- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures.
-- **Zero configuration and maintenance** required to collect thousands of metrics, every second, from the underlying
+- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures.
+- **Zero configuration and maintenance** required to collect thousands of metrics, every second, from the underlying
OS and running applications.
-- **Prebuilt charts and alarms** alert you to common anomalies and performance issues without manual configuration.
-- **Distributed storage** to simplify the cost and complexity of storing metrics data from any number of nodes.
+- **Prebuilt charts and alarms** alert you to common anomalies and performance issues without manual configuration.
+- **Distributed storage** to simplify the cost and complexity of storing metrics data from any number of nodes.
### Powerful and scalable
-- **1% CPU utilization, a few MB of RAM, and minimal disk I/O** to run the monitoring Agent on bare metal, virtual
+- **1% CPU utilization, a few MB of RAM, and minimal disk I/O** to run the monitoring Agent on bare metal, virtual
machines, containers, and even IoT devices.
-- **Per-second granularity** for an unlimited number of metrics based on the hardware and applications you're running
+- **Per-second granularity** for an unlimited number of metrics based on the hardware and applications you're running
on your nodes.
-- **Interoperable exporters** let you connect Netdata's per-second metrics with an existing monitoring stack and other
+- **Interoperable exporters** let you connect Netdata's per-second metrics with an existing monitoring stack and other
time-series databases.
### Optimized for troubleshooting
-- **Visual anomaly detection** with a UI/UX that emphasizes the relationships between charts.
-- **Customizable dashboards** to pinpoint correlated metrics, respond to incidents, and help you streamline your
+- **Visual anomaly detection** with a UI/UX that emphasizes the relationships between charts.
+- **Customizable dashboards** to pinpoint correlated metrics, respond to incidents, and help you streamline your
workflows.
-- **Distributed metrics in a centralized interface** to assist users or teams trace complex issues between distributed
+- **Distributed metrics in a centralized interface** to assist users or teams trace complex issues between distributed
nodes.
### Secure by design
-- **Distributed data architecture** so fast and efficient, there’s no limit to the number of metrics you can follow.
-- Because your data is **stored at the edge**, security is ensured.
--
+- **Distributed data architecture** so fast and efficient, there’s no limit to the number of metrics you can follow.
+- Because your data is **stored at the edge**, security is ensured.
+
### Comparison with other monitoring solutions
Netdata offers many benefits over the existing monitoring landscape, whether they're expensive SaaS products or other
@@ -66,21 +59,19 @@ open-source tools.
| **Kills the console** for tracing performance issues | The console is always required for troubleshooting |
| Requires **zero dedicated resources** | Require large dedicated resources |
-
Netdata works with tons of applications, notifications platforms, and other time-series databases:
-- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
+- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
immediately visualize them into meaningful charts designed for troubleshooting. See [everything we
support](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
-- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
+- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
platform](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to inform you of anomalies just seconds
after they affect your node.
-- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
+- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
Cloud-based databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) for best-in-class
interoperability.
-
-## How it works
+## How it works
Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for concurrent operations on the metrics.
@@ -93,9 +84,9 @@ And a higher level diagram in this one.
![Diagram 2 of Netdata's core
functionality](https://user-images.githubusercontent.com/1153921/95367248-5f755980-0889-11eb-827f-9b7aa02a556e.png)
-You can even visit this slightly dated [interactive infographic](https://my-netdata.io/infographic.html) and get lost in a rabbit hole.
+You can even visit this slightly dated [interactive infographic](https://my-netdata.io/infographic.html) and get lost in a rabbit hole.
-But the best way to get under the hood or in the steering wheel of our highly efficient, low-latency system (supporting multiple readers and one writer on each metric) is to read the rest of our docs, or just to jump in and [get started](app.netdata.com). But here's a good breakdown:
+But the best way to get under the hood or in the steering wheel of our highly efficient, low-latency system (supporting multiple readers and one writer on each metric) is to read the rest of our docs, or just to jump in and [get started](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). But here's a good breakdown:
### Netdata Agent
@@ -104,12 +95,56 @@ Netdata's distributed monitoring Agent collects thousands of metrics from system
You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no sudo required.
### Netdata Cloud
+
Netdata Cloud is a web application that gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can view key metrics, insightful charts, and active alarms from all your nodes in a single web interface. When an anomaly strikes, seamlessly navigate to any node to troubleshoot and discover the root cause with the familiar Netdata dashboard.
Netdata Cloud is free! You can add an entire infrastructure of nodes, invite all your colleagues, and visualize any number of metrics, charts, and alarms entirely for free.
While Netdata Cloud offers a centralized method of monitoring your Agents, your metrics data is not stored or centralized in any way. Metrics data remains with your nodes and is only streamed to your browser, through Cloud, when you're viewing the Netdata Cloud interface.
+## Use Netdata standalone or as part of your monitoring stack
+
+Netdata is an extremely powerful monitoring, visualization, and troubleshooting platform. While you can use it as an
+effective standalone tool, we also designed it to be open and interoperable with other tools you might already be using.
+
+Netdata helps you collect everything and scales to infrastructure of any size, but it doesn't lock-in data or force you
+to use specific tools or methodologies. Each feature is extensible and interoperable so they can work in parallel with
+other tools. For example, you can use Netdata to collect metrics, visualize metrics with a second open-source program,
+and centralize your metrics in a cloud-based time-series database solution for long-term storage or further analysis.
+
+You can build a new monitoring stack, including Netdata, or integrate Netdata's metrics with your existing monitoring
+stack. No matter which route you take, Netdata helps you monitor infrastructure of any size.
+
+Here are a few ways to enrich your existing monitoring and troubleshooting stack with Netdata:
+
+### Collect metrics from Prometheus endpoints
+
+Netdata automatically detects 600 popular endpoints and collects per-second metrics from them via the [generic
+Prometheus collector](https://github.com/netdata/go.d.plugin/blob/master/modules/prometheus/README.md). This even
+includes support for Windows 10 via [`windows_exporter`](https://github.com/prometheus-community/windows_exporter).
+
+This collector is installed and enabled on all Agent installations by default, so you don't need to waste time
+configuring Netdata. Netdata will detect these Prometheus metrics endpoints and collect even more granular metrics than
+your existing solutions. You can now use all of Netdata's meaningfully-visualized charts to diagnose issues and
+troubleshoot anomalies.
+
+### Export metrics to external time-series databases
+
+Netdata can send its per-second metrics to external time-series databases, such as InfluxDB, Prometheus, Graphite,
+TimescaleDB, ElasticSearch, AWS Kinesis Data Streams, Google Cloud Pub/Sub Service, and many others.
+
+Once you have Netdata's metrics in a secondary time-series database, you can use them however you'd like, such as
+additional visualization/dashboarding tools or aggregation of data from multiple sources.
+
+### Visualize metrics with Grafana
+
+One popular monitoring stack is Netdata, Prometheus, and Grafana. Netdata acts as the stack's metrics collection
+powerhouse, Prometheus as the time-series database, and Grafana as the visualization platform. You can also use Grafite instead of Prometheus,
+or directly use the [Netdata source plugin for Grafana](https://blog.netdata.cloud/introducing-netdata-source-plugin-for-grafana/)
+
+Of course, just because you export or visualize metrics elsewhere, it doesn't mean Netdata's equivalent features
+disappear. You can always build new dashboards in Netdata Cloud, drill down into per-second metrics using Netdata's
+charts, or use Netdata's health watchdog to send notifications whenever an anomaly strikes.
## Community
@@ -120,14 +155,14 @@ ask questions, find resources, and engage with passionate professionals. The tea
You can also find Netdata on:
-- [Twitter](https://twitter.com/linuxnetdata)
-- [YouTube](https://www.youtube.com/c/Netdata)
-- [Reddit](https://www.reddit.com/r/netdata/)
-- [LinkedIn](https://www.linkedin.com/company/netdata-cloud/)
-- [StackShare](https://stackshare.io/netdata)
-- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/)
-- [Repology](https://repology.org/metapackage/netdata/versions)
-- [Facebook](https://www.facebook.com/linuxnetdata/)
+- [Twitter](https://twitter.com/linuxnetdata)
+- [YouTube](https://www.youtube.com/c/Netdata)
+- [Reddit](https://www.reddit.com/r/netdata/)
+- [LinkedIn](https://www.linkedin.com/company/netdata-cloud/)
+- [StackShare](https://stackshare.io/netdata)
+- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/)
+- [Repology](https://repology.org/metapackage/netdata/versions)
+- [Facebook](https://www.facebook.com/linuxnetdata/)
## Contribute