summaryrefslogtreecommitdiffstats
path: root/docs/collect
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/collect
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/collect')
-rw-r--r--docs/collect/application-metrics.md5
-rw-r--r--docs/collect/container-metrics.md3
-rw-r--r--docs/collect/enable-configure.md72
-rw-r--r--docs/collect/how-collectors-work.md82
-rw-r--r--docs/collect/system-metrics.md13
5 files changed, 9 insertions, 166 deletions
diff --git a/docs/collect/application-metrics.md b/docs/collect/application-metrics.md
index 454ed95ad..ec73cefe3 100644
--- a/docs/collect/application-metrics.md
+++ b/docs/collect/application-metrics.md
@@ -51,11 +51,10 @@ application metrics collectors, including those for containers/k8s clusters.
## Collect metrics from applications running on Windows
Netdata is fully capable of collecting and visualizing metrics from applications running on Windows systems. The only
-caveat is that you must [install Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) on a separate system or a compatible VM because there
+caveat is that you must [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) on a separate system or a compatible VM because there
is no native Windows version of the Netdata Agent.
-Once you have Netdata running on that separate system, you can follow the [enable and configure
-doc](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) to tell the collector to look for exposed metrics on the Windows system's IP
+Once you have Netdata running on that separate system, you can follow the [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) documentation to tell the collector to look for exposed metrics on the Windows system's IP
address or hostname, plus the applicable port.
For example, you have a MySQL database with a root password of `my-secret-pw` running on a Windows system with the IP
diff --git a/docs/collect/container-metrics.md b/docs/collect/container-metrics.md
index b6b6a432c..cde541839 100644
--- a/docs/collect/container-metrics.md
+++ b/docs/collect/container-metrics.md
@@ -55,8 +55,7 @@ metrics](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README
### Collect metrics from applications running in Docker containers
-You could use this technique to monitor an entire infrastructure of Docker containers. The same [enable and
-configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) procedures apply whether an application runs on the host system or inside
+You could use this technique to monitor an entire infrastructure of Docker containers. The same [enable and configure](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) procedures apply whether an application runs on the host system or inside
a container. You may need to configure the target endpoint if it's not the application's default.
Netdata can even [run in a Docker container](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md) itself, and then collect metrics about the
diff --git a/docs/collect/enable-configure.md b/docs/collect/enable-configure.md
deleted file mode 100644
index cd8960ac1..000000000
--- a/docs/collect/enable-configure.md
+++ /dev/null
@@ -1,72 +0,0 @@
-<!--
-title: "Enable or configure a collector"
-description: "Every collector is highly configurable, allowing them to collect metrics from any node and any infrastructure."
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/collect/enable-configure.md"
-sidebar_label: "Enable or configure a collector"
-learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Setup"
--->
-
-# Enable or configure a collector
-
-When Netdata starts up, each collector searches for exposed metrics on the default endpoint established by that service
-or application's standard installation procedure. For example, the [Nginx
-collector](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md) searches at
-`http://127.0.0.1/stub_status` for exposed metrics in the correct format. If an Nginx web server is running and exposes
-metrics on that endpoint, the collector begins gathering them.
-
-However, not every node or infrastructure uses standard ports, paths, files, or naming conventions. You may need to
-enable or configure a collector to gather all available metrics from your systems, containers, or applications.
-
-## Enable a collector or its orchestrator
-
-You can enable/disable collectors individually, or enable/disable entire orchestrators, using their configuration files.
-For example, you can change the behavior of the Go orchestrator, or any of its collectors, by editing `go.d.conf`.
-
-Use `edit-config` from your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) to open
-the orchestrator primary configuration file:
-
-```bash
-cd /etc/netdata
-sudo ./edit-config go.d.conf
-```
-
-Within this file, you can either disable the orchestrator entirely (`enabled: yes`), or find a specific collector and
-enable/disable it with `yes` and `no` settings. Uncomment any line you change to ensure the Netdata daemon reads it on
-start.
-
-After you make your changes, restart the Agent with `sudo systemctl restart netdata`, or the [appropriate
-method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
-
-## Configure a collector
-
-First, [find the collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) you want to edit and open its documentation. Some software has
-collectors written in multiple languages. In these cases, you should always pick the collector written in Go.
-
-Use `edit-config` from your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) to open a
-collector's configuration file. For example, edit the Nginx collector with the following:
-
-```bash
-./edit-config go.d/nginx.conf
-```
-
-Each configuration file describes every available option and offers examples to help you tweak Netdata's settings
-according to your needs. In addition, every collector's documentation shows the exact command you need to run to
-configure that collector. Uncomment any line you change to ensure the collector's orchestrator or the Netdata daemon
-read it on start.
-
-After you make your changes, restart the Agent with `sudo systemctl restart netdata`, or the [appropriate
-method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system.
-
-## What's next?
-
-Read high-level overviews on how Netdata collects [system metrics](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md), [container
-metrics](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md), and [application metrics](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md).
-
-If you're already collecting all metrics from your systems, containers, and applications, it's time to move into
-Netdata's visualization features. [See an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md)
-using Netdata Cloud, or learn how to [interact with dashboards and
-charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md).
-
-
diff --git a/docs/collect/how-collectors-work.md b/docs/collect/how-collectors-work.md
deleted file mode 100644
index 382d4ccc6..000000000
--- a/docs/collect/how-collectors-work.md
+++ /dev/null
@@ -1,82 +0,0 @@
-<!--
-title: "How Netdata's metrics collectors work"
-description: "When Netdata starts, and with zero configuration, it auto-detects thousands of data sources and immediately collects per-second metrics."
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/collect/how-collectors-work.md"
-sidebar_label: "How Netdata's metrics collectors work"
-learn_status: "Published"
-learn_topic_type: "Concepts"
-learn_rel_path: "Concepts"
--->
-
-# How Netdata's metrics collectors work
-
-When Netdata starts, and with zero configuration, it auto-detects thousands of data sources and immediately collects
-per-second metrics.
-
-Netdata can immediately collect metrics from these endpoints thanks to 300+ **collectors**, which all come pre-installed
-when you [install Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
-
-Every collector has two primary jobs:
-
-- Look for exposed metrics at a pre- or user-defined endpoint.
-- Gather exposed metrics and use additional logic to build meaningful, interactive visualizations.
-
-If the collector finds compatible metrics exposed on the configured endpoint, it begins a per-second collection job. The
-Netdata Agent gathers these metrics, sends them to the [database engine for
-storage](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md), and immediately [visualizes them
-meaningfully](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md) on dashboards.
-
-Each collector comes with a pre-defined configuration that matches the default setup for that application. This endpoint
-can be a URL and port, a socket, a file, a web page, and more.
-
-For example, the [Nginx collector](https://github.com/netdata/go.d.plugin/blob/master/modules/nginx/README.md) searches
-at `http://127.0.0.1/stub_status`, which is the default endpoint for exposing Nginx metrics. The [web log collector for
-Nginx or Apache](https://github.com/netdata/go.d.plugin/blob/master/README.mdmodules/weblog) searches at
-`/var/log/nginx/access.log` and `/var/log/apache2/access.log`, respectively, both of which are standard locations for
-access log files on Linux systems.
-
-The endpoint is user-configurable, as are many other specifics of what a given collector does.
-
-## What can Netdata collect?
-
-To quickly find your answer, see our [list of supported collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
-
-Generally, Netdata's collectors can be grouped into three types:
-
-- [Systems](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md): Monitor CPU, memory, disk, networking, systemd, eBPF, and much more.
- Every metric exposed by `/proc`, `/sys`, and other Linux kernel sources.
-- [Containers](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md): Gather metrics from container agents, like `dockerd` or `kubectl`,
- along with the resource usage of containers and the applications they run.
-- [Applications](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md): Collect per-second metrics from web servers, databases, logs,
- message brokers, APM tools, email servers, and much more.
-
-## Collector architecture and terminology
-
-**Collector** is a catch-all term for any Netdata process that gathers metrics from an endpoint.
-
-While we use _collector_ most often in documentation, release notes, and educational content, you may encounter other
-terms related to collecting metrics.
-
-- **Modules** are a type of collector.
-- **Orchestrators** are external plugins that run and manage one or more modules. They run as independent processes.
- The Go orchestrator is in active development.
- - [go.d.plugin](https://github.com/netdata/go.d.plugin/blob/master/README.md): An orchestrator for data
- collection modules written in `go`.
- - [python.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/README.md): An orchestrator for data collection modules written in
- `python` v2/v3.
- - [charts.d.plugin](https://github.com/netdata/netdata/blob/master/collectors/charts.d.plugin/README.md): An orchestrator for data collection modules written in
- `bash` v4+.
-- **External plugins** gather metrics from external processes, such as a webserver or database, and run as independent
- processes that communicate with the Netdata daemon via pipes.
-- **Internal plugins** gather metrics from `/proc`, `/sys`, and other Linux kernel sources. They are written in `C`,
- and run as threads within the Netdata daemon.
-
-## What's next?
-
-[Enable or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) if the default settings are not compatible with
-your infrastructure.
-
-See our [collectors reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) for detailed information on Netdata's collector architecture,
-troubleshooting a collector, developing a custom collector, and more.
-
-
diff --git a/docs/collect/system-metrics.md b/docs/collect/system-metrics.md
index 442b13823..daaf61d72 100644
--- a/docs/collect/system-metrics.md
+++ b/docs/collect/system-metrics.md
@@ -37,15 +37,14 @@ can find all system collectors in our [supported collectors list](https://github
## Collect Windows system metrics
-Netdata is also capable of monitoring Windows systems. The [WMI
-collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md) integrates with
+Netdata is also capable of monitoring Windows systems. The [Windows
+collector](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md) integrates with
[windows_exporter](https://github.com/prometheus-community/windows_exporter), a small Go-based binary that you can run
-on Windows systems. The WMI collector then gathers metrics from an endpoint created by windows_exporter, for more
-details see [the requirements](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#requirements).
+on Windows systems. The Windows collector then gathers metrics from an endpoint created by windows_exporter, for more
+details see [the requirements](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md#requirements).
-Next, [configure the WMI
-collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#configuration) to point to the URL
-and port of your exposed endpoint. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
+Next, [configure](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md#configuration) the Windows
+collector to point to the URL and port of your exposed endpoint. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. You'll start seeing Windows system metrics, such as CPU
utilization, memory, bandwidth per NIC, number of processes, and much more.