Collector configuration page edits (#19072)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
Fotis Voutsas committed
Nov 25, 2024 at 11:17 UTC
6917745c9fd71785f78af7122bff4793928e0a9f
6 files changed
+84
-150
docs/glossary.md
-1
@@ -95,7 +95,6 @@ Use the alphabetized list below to find the answer to your single-term questions
95
96
- [**Metrics Streaming Replication**](/docs/observability-centralization-points/README.md): Each node running Netdata can stream the metrics it collects, in real time, to another node. Metric streaming allows you to replicate metrics data across multiple nodes, or centralize all your metrics data into a single time-series database (TSDB).
97
98
-- [**Module**](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module): A type of collector.
98
99
## N
100
docs/netdata-agent/configuration/common-configuration-changes.md
-29
@@ -21,35 +21,6 @@ changes reflected in those visualizations due to the way Netdata Cloud proxies m
21
22
Read our doc on [increasing long-term metrics storage](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md) for details.
23
24
-### Reduce the data collection frequency
25
-
26
-Change `update every` in
27
-the [`[global]` section](/src/daemon/config/README.md#global-section-options)
28
-of `netdata.conf` so
29
-that it is greater than `1`. An `update every` of `5` means the Netdata Agent enforces a _minimum_ collection frequency
30
-of 5 seconds.
31
-
32
-```text
33
-[global]
34
- update every = 5
35
-```
36
-
37
-Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
38
-`python.d.conf` or `charts.d.conf` files, or in individual collector configuration files. If the `update
39
-every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See
40
-the [enable or configure a collector](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
41
-doc for details.
42
-
43
-### Disable a collector or plugin
44
-
45
-Turn off entire plugins in
46
-the [`[plugins]` section](/src/daemon/config/README.md#plugins-section-options)
47
-of
48
-`netdata.conf`.
49
-
50
-To disable specific collectors, open `go.d.conf`, `python.d.conf` or `charts.d.conf` and find the line
51
-for that specific module. Uncomment the line and change its value to `no`.
52
-
24
## Modify alerts and notifications
25
26
Netdata's health monitoring watchdog uses hundreds of pre-configured health entities, with intelligent thresholds, to
docs/netdata-agent/configuration/optimize-the-netdata-agents-performance.md
+1
-1
@@ -201,7 +201,7 @@ collects and visualizes metrics on application resource utilization:
201
update every = 5
202
```
203
204
-To [configure an individual collector](/src/collectors/REFERENCE.md#configure-a-collector),
204
+To configure an individual collector,
205
open its specific configuration file with `edit-config` and look for the `update_every` setting. For example, to reduce
206
the frequency of the `nginx` collector, run `sudo ./edit-config go.d/nginx.conf`:
207
src/collectors/COLLECTORS.md
+1
-1
@@ -3,7 +3,7 @@
3
Netdata uses collectors to help you gather metrics from your favorite applications and services and view them in
4
real-time, interactive charts. The following list includes all the integrations where Netdata can gather metrics from.
5
6
-Learn more about [how collectors work](/src/collectors/README.md), and then learn how to [enable or configure](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module) a specific collector.
6
+Learn more about [how collectors work](/src/collectors/README.md), and then learn how to [enable or configure](/src/collectors/REFERENCE.md#enable-or-disable-collectors-and-plugins) a specific collector.
7
8
> **Note**
9
>
src/collectors/README.md
+3
-4
@@ -11,12 +11,11 @@ If you don't see charts for your application, check our collectors' [configurati
11
12
Netdata's collectors are specialized data collection plugins that gather metrics from various sources. They are divided into two main categories:
13
14
-| Type | Description | Key Features |
15
-|----------|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
16
-| Internal | Native collectors that gather system-level metrics | • Written in `C` for optimal performance<br/>• Run as threads within Netdata daemon<br/>• Zero external dependencies<br/>• Minimal system overhead |
14
+| Type | Description | Key Features |
15
+|----------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
16
+| Internal | Native collectors that gather system-level metrics | • Written in `C` for optimal performance<br/>• Run as threads within Netdata daemon<br/>• Zero external dependencies<br/>• Minimal system overhead |
17
| External | Modular collectors that gather metrics from applications and services | • Support multiple programming languages<br/>• Run as independent processes<br/>• Communicate via pipes with Netdata<br/>• Managed by [plugins.d](/src/plugins.d/README.md)<br/>• Examples: MySQL, Nginx, Redis collectors |
18
19
-
19
## Collector Privileges
20
21
Netdata uses various plugins and helper binaries that require elevated privileges to collect system metrics.
src/collectors/REFERENCE.md
+79
-114
@@ -1,138 +1,103 @@
1
-# Collectors configuration reference
2
-
3
-The list of supported collectors can be found in [the documentation](/src/collectors/COLLECTORS.md),
4
-and on [our website](https://www.netdata.cloud/integrations). The documentation of each collector provides all the
5
-necessary configuration options and prerequisites for that collector. In most cases, either the charts are automatically generated
6
-without any configuration, or you just fulfil those prerequisites and [configure the collector](#configure-a-collector).
7
-
8
-If the application you are interested in monitoring is not listed in our integrations, the collectors list includes
9
-the available options to
10
-[add your application to Netdata](https://github.com/netdata/netdata/edit/master/src/collectors/COLLECTORS.md#add-your-application-to-netdata).
1
+# Collector configuration
2
12
-If we do support your collector but the charts described in the documentation don't appear on your dashboard, the reason will
13
-be one of the following:
3
+Find available collectors in the [Collecting Metrics](/src/collectors/README.md) guide and on our [Integrations page](https://www.netdata.cloud/integrations).
4
15
-- The entire data collection plugin is disabled by default. Read how to [enable and disable plugins](#enable-and-disable-plugins)
5
+Each collector's documentation includes detailed setup instructions and configuration options. Most collectors either work automatically without configuration or require minimal setup to begin collecting data.
6
17
-- The data collection plugin is enabled, but a specific data collection module is disabled. Read how to
18
- [enable and disable a specific collection module](#enable-and-disable-a-specific-collection-module).
7
+> **Info**
8
+>
9
+> Enable and configure Go collectors directly through the UI using the [Dynamic Configuration Manager](/docs/netdata-agent/configuration/dynamic-configuration.md).
10
20
-- Autodetection failed. Read how to [configure](#configure-a-collector) and [troubleshoot](#troubleshoot-a-collector) a collector.
11
+## Enable or disable Collectors and Plugins
12
22
-## Enable and disable plugins
13
+Most collectors and plugins are enabled by default. You can selectively disable them to optimize performance.
14
24
-You can enable or disable individual plugins by opening `netdata.conf` and scrolling down to the `[plugins]` section.
25
-This section features a list of Netdata's plugins, with a boolean setting to enable or disable them. The exception is
26
-`statsd.plugin`, which has its own `[statsd]` section. Your `[plugins]` section should look similar to this:
15
+**To disable plugins**:
16
28
-```text
29
-[plugins]
30
- # timex = yes
31
- # idlejitter = yes
32
- # netdata monitoring = yes
33
- # tc = yes
34
- # diskspace = yes
35
- # proc = yes
36
- # cgroups = yes
37
- # enable running new plugins = yes
38
- # check for new plugins every = 60
39
- # slabinfo = no
40
- # python.d = yes
41
- # perf = yes
42
- # ioping = yes
43
- # fping = yes
44
- # nfacct = yes
45
- # go.d = yes
46
- # apps = yes
47
- # ebpf = yes
48
- # charts.d = yes
49
- # statsd = yes
50
-```
17
+1. Open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config).
18
+2. Navigate to the `[plugins]` section
19
+3. Uncomment the relevant line and set it to `no`
20
52
-By default, most plugins are enabled, so you don't need to enable them explicitly to use their collectors. To enable or
53
-disable any specific plugin, remove the comment (`#`) and change the boolean setting to `yes` or `no`.
21
+ ```text
22
+ [plugins]
23
+ proc = yes
24
+ python.d = no
25
+ ```
26
55
-## Enable and disable a specific collection module
27
+**To disable specific collectors**:
28
57
-You can enable/disable of the collection modules supported by `go.d`, `python.d` or `charts.d` individually, using the
58
-configuration file of that orchestrator. For example, you can change the behavior of the Go orchestrator, or any of its
59
-collectors, by editing `go.d.conf`.
29
+1. Open the corresponding plugin configuration file:
30
+ ```bash
31
+ sudo ./edit-config go.d.conf
32
+ ```
33
+2. Uncomment the collector's line and set it to `no`:
34
+ ```yaml
35
+ modules:
36
+ xyz_collector: no
37
+ ```
38
+3. [Restart](/docs/netdata-agent/start-stop-restart.md) the Agent after making changes.
39
61
-Use `edit-config` from your [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory)
62
-to open the orchestrator primary configuration file:
40
+## Adjust data collection frequency
41
64
-```bash
65
-cd /etc/netdata
66
-sudo ./edit-config go.d.conf
67
-```
42
+You can modify how often collectors gather metrics to optimize CPU usage. This can be done globally or for specific collectors.
43
69
-Within this file, you can either disable the orchestrator entirely (`enabled: yes`), or find a specific collector and
70
-enable/disable it with `yes` and `no` settings. Uncomment any line you change to ensure the Netdata daemon reads it on
71
-start.
44
+### Global
45
73
-After you make your changes, restart the Agent with the [appropriate method](/docs/netdata-agent/start-stop-restart.md) for your system.
46
+1. Open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config).
47
+2. Set the `update every` value (default is `1`, meaning one-second intervals):
48
+ ```text
49
+ [global]
50
+ update every = 2
51
+ ```
52
75
-## Configure a collector
53
+3. [Restart](/docs/netdata-agent/start-stop-restart.md) the Agent after making changes.
54
77
-Most collector modules come with **auto-detection**, configured to work out-of-the-box on popular operating systems with
78
-the default settings.
55
+### Specific Plugin or Collector
56
80
-However, there are cases that auto-detection fails. Usually, the reason is that the applications to be monitored do not
81
-allow Netdata to connect. In most of the cases, allowing the user `netdata` from `localhost` to connect and collect
82
-metrics, will automatically enable data collection for the application in question (it will require a Netdata restart).
57
+**For Plugins**:
58
84
-When Netdata starts up, each collector searches for exposed metrics on the default endpoint established by that service
85
-or application's standard installation procedure. For example,
86
-the [Nginx collector](/src/go/plugin/go.d/modules/nginx/README.md) searches at
87
-`http://127.0.0.1/stub_status` for exposed metrics in the correct format. If an Nginx web server is running and exposes
88
-metrics on that endpoint, the collector begins gathering them.
59
+1. Open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config).
60
+2. Locate the plugin's section and set its frequency:
61
90
-However, not every node or infrastructure uses standard ports, paths, files, or naming conventions. You may need to
91
-enable or configure a collector to gather all available metrics from your systems, containers, or applications.
62
+ ```text
63
+ [plugin:apps]
64
+ update every = 5
65
+ ```
66
+3. [Restart](/docs/netdata-agent/start-stop-restart.md) the Agent after making changes.
67
93
-First, [find the collector](/src/collectors/COLLECTORS.md) you want to edit
94
-and open its documentation. Some software has collectors written in multiple languages. In these cases, you should always
95
-pick the collector written in Go.
68
+**For Collectors**:
69
97
-Use `edit-config` from your
98
-[Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory)
99
-to open a collector's configuration file. For example, edit the Nginx collector with the following:
100
-
101
-```bash
102
-./edit-config go.d/nginx.conf
103
-```
104
-
105
-Each configuration file describes every available option and offers examples to help you tweak Netdata's settings
106
-according to your needs. In addition, every collector's documentation shows the exact command you need to run to
107
-configure that collector. Uncomment any line you change to ensure the collector's orchestrator or the Netdata daemon
108
-read it on start.
109
-
110
-After you make your changes, restart the Agent with the [appropriate method](/docs/netdata-agent/start-stop-restart.md) for your system.
70
+Each collector has its own configuration format and options. Refer to the collector's documentation for specific instructions on adjusting its data collection frequency.
71
72
## Troubleshoot a collector
73
114
-First, navigate to your plugins directory, which is usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case
115
-on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the plugins directory,
116
-switch to the `netdata` user.
117
-
118
-```bash
119
-cd /usr/libexec/netdata/plugins.d/
120
-sudo su -s /bin/bash netdata
121
-```
122
-
123
-The next step is based on the collector's orchestrator.
124
-
125
-```bash
126
-# Go orchestrator (go.d.plugin)
127
-./go.d.plugin -d -m <MODULE_NAME>
128
-
129
-# Python orchestrator (python.d.plugin)
130
-./python.d.plugin <MODULE_NAME> debug trace
131
-
132
-# Bash orchestrator (bash.d.plugin)
133
-./charts.d.plugin debug 1 <MODULE_NAME>
134
-```
135
-
136
-The output from the relevant command will provide valuable troubleshooting information. If you can't figure out how to
137
-enable the collector using the details from this output, feel free to [join our Discord server](https://discord.com/invite/2mEmfW735j),
138
-to get help from our experts.
74
+1. Navigate to the plugins directory. If not found, check the `plugins directory` setting in `netdata.conf`.
75
+ ```bash
76
+ cd /usr/libexec/netdata/plugins.d/
77
+ ```
78
+2. Switch to the netdata user.
79
+ ```bash
80
+ sudo su -s /bin/bash netdata
81
+ ```
82
+3. Run debug mode
83
+
84
+ ```bash
85
+ # Go collectors
86
+ ./go.d.plugin -d -m <MODULE_NAME>
87
+
88
+ # Python collectors
89
+ ./python.d.plugin <MODULE_NAME> debug trace
90
+
91
+ # Bash collectors
92
+ ./charts.d.plugin debug 1 <MODULE_NAME>
93
+ ```
94
+4. Analyze output
95
+
96
+The debug output will show:
97
+
98
+- Configuration issues
99
+- Connection problems
100
+- Permission errors
101
+- Other potential failures
102
+
103
+Need help interpreting the results? Join our [Discord community](https://discord.com/invite/2mEmfW735j) for expert assistance.