archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-06 22:38:55 +00:00
Code Issues Projects Releases Wiki Activity

Collector configuration page edits ()

Browse source 
Co-authored-by: ilyam8 <ilya@netdata.cloud>
This commit is contained in:
Fotis Voutsas 2024-11-25 11:17:23 +02:00 • committed by GitHub
parent 0b575e473b
commit 6917745c9f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 79 additions and 145 deletions

1
docs/glossary.md
View file

@ -95,7 +95,6 @@ Use the alphabetized list below to find the answer to your single-term questions
- [**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).
- [**Module**](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module): A type of collector.
## N

29
docs/netdata-agent/configuration/common-configuration-changes.md
View file

@ -21,35 +21,6 @@ changes reflected in those visualizations due to the way Netdata Cloud proxies m
Read our doc on [increasing long-term metrics storage](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md) for details.
### Reduce the data collection frequency
Change `update every` in
the [`[global]` section](/src/daemon/config/README.md#global-section-options)
of `netdata.conf` so
that it is greater than `1`. An `update every` of `5` means the Netdata Agent enforces a _minimum_ collection frequency
of 5 seconds.
```text
[global]
update every = 5
```
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
`python.d.conf` or `charts.d.conf` files, or in individual collector configuration files. If the `update
every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See
the [enable or configure a collector](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
doc for details.
### Disable a collector or plugin
Turn off entire plugins in
the [`[plugins]` section](/src/daemon/config/README.md#plugins-section-options)
of
`netdata.conf`.
To disable specific collectors, open `go.d.conf`, `python.d.conf` or `charts.d.conf` and find the line
for that specific module. Uncomment the line and change its value to `no`.
## Modify alerts and notifications
Netdata's health monitoring watchdog uses hundreds of pre-configured health entities, with intelligent thresholds, to

2
docs/netdata-agent/configuration/optimize-the-netdata-agents-performance.md
View file

@ -201,7 +201,7 @@ collects and visualizes metrics on application resource utilization:
update every = 5
```
To [configure an individual collector](/src/collectors/REFERENCE.md#configure-a-collector),
To configure an individual collector,
open its specific configuration file with `edit-config` and look for the `update_every` setting. For example, to reduce
the frequency of the `nginx` collector, run `sudo ./edit-config go.d/nginx.conf`:

2
src/collectors/COLLECTORS.md
View file

@ -3,7 +3,7 @@
Netdata uses collectors to help you gather metrics from your favorite applications and services and view them in
real-time, interactive charts. The following list includes all the integrations where Netdata can gather metrics from.
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.
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.
> **Note**
>

7
src/collectors/README.md
View file

@ -11,12 +11,11 @@ If you don't see charts for your application, check our collectors' [configurati
Netdata's collectors are specialized data collection plugins that gather metrics from various sources. They are divided into two main categories:
| Type | Description | Key Features |
|----------|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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 |
| Type | Description | Key Features |
|----------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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 |
| 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 |
## Collector Privileges
Netdata uses various plugins and helper binaries that require elevated privileges to collect system metrics.

183
src/collectors/REFERENCE.md
View file

@ -1,138 +1,103 @@
# Collectors configuration reference
# Collector configuration
The list of supported collectors can be found in [the documentation](/src/collectors/COLLECTORS.md),
and on [our website](https://www.netdata.cloud/integrations). The documentation of each collector provides all the
necessary configuration options and prerequisites for that collector. In most cases, either the charts are automatically generated
without any configuration, or you just fulfil those prerequisites and [configure the collector](#configure-a-collector).
Find available collectors in the [Collecting Metrics](/src/collectors/README.md) guide and on our [Integrations page](https://www.netdata.cloud/integrations).
If the application you are interested in monitoring is not listed in our integrations, the collectors list includes
the available options to
[add your application to Netdata](https://github.com/netdata/netdata/edit/master/src/collectors/COLLECTORS.md#add-your-application-to-netdata).
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.
If we do support your collector but the charts described in the documentation don't appear on your dashboard, the reason will
be one of the following:
> **Info**
>
> Enable and configure Go collectors directly through the UI using the [Dynamic Configuration Manager](/docs/netdata-agent/configuration/dynamic-configuration.md).
- The entire data collection plugin is disabled by default. Read how to [enable and disable plugins](#enable-and-disable-plugins)
## Enable or disable Collectors and Plugins
- The data collection plugin is enabled, but a specific data collection module is disabled. Read how to
[enable and disable a specific collection module](#enable-and-disable-a-specific-collection-module).
Most collectors and plugins are enabled by default. You can selectively disable them to optimize performance.
- Autodetection failed. Read how to [configure](#configure-a-collector) and [troubleshoot](#troubleshoot-a-collector) a collector.
**To disable plugins**:
## Enable and disable plugins
1. Open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config).
2. Navigate to the `[plugins]` section
3. Uncomment the relevant line and set it to `no`
You can enable or disable individual plugins by opening `netdata.conf` and scrolling down to the `[plugins]` section.
This section features a list of Netdata's plugins, with a boolean setting to enable or disable them. The exception is
`statsd.plugin`, which has its own `[statsd]` section. Your `[plugins]` section should look similar to this:
```text
[plugins]
proc = yes
python.d = no
```
```text
[plugins]
# timex = yes
# idlejitter = yes
# netdata monitoring = yes
# tc = yes
# diskspace = yes
# proc = yes
# cgroups = yes
# enable running new plugins = yes
# check for new plugins every = 60
# slabinfo = no
# python.d = yes
# perf = yes
# ioping = yes
# fping = yes
# nfacct = yes
# go.d = yes
# apps = yes
# ebpf = yes
# charts.d = yes
# statsd = yes
```
**To disable specific collectors**:
By default, most plugins are enabled, so you don't need to enable them explicitly to use their collectors. To enable or
disable any specific plugin, remove the comment (`#`) and change the boolean setting to `yes` or `no`.
1. Open the corresponding plugin configuration file:
```bash
sudo ./edit-config go.d.conf
```
2. Uncomment the collector's line and set it to `no`:
```yaml
modules:
xyz_collector: no
```
3. [Restart](/docs/netdata-agent/start-stop-restart.md) the Agent after making changes.
## Enable and disable a specific collection module
## Adjust data collection frequency
You can enable/disable of the collection modules supported by `go.d`, `python.d` or `charts.d` individually, using the
configuration file of that orchestrator. For example, you can change the behavior of the Go orchestrator, or any of its
collectors, by editing `go.d.conf`.
You can modify how often collectors gather metrics to optimize CPU usage. This can be done globally or for specific collectors.
Use `edit-config` from your [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory)
to open the orchestrator primary configuration file:
### Global
```bash
cd /etc/netdata
sudo ./edit-config go.d.conf
```
1. Open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config).
2. Set the `update every` value (default is `1`, meaning one-second intervals):
```text
[global]
update every = 2
```
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.
3. [Restart](/docs/netdata-agent/start-stop-restart.md) the Agent after making changes.
After you make your changes, restart the Agent with the [appropriate method](/docs/netdata-agent/start-stop-restart.md) for your system.
### Specific Plugin or Collector
## Configure a collector
**For Plugins**:
Most collector modules come with **auto-detection**, configured to work out-of-the-box on popular operating systems with
the default settings.
1. Open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config).
2. Locate the plugin's section and set its frequency:
However, there are cases that auto-detection fails. Usually, the reason is that the applications to be monitored do not
allow Netdata to connect. In most of the cases, allowing the user `netdata` from `localhost` to connect and collect
metrics, will automatically enable data collection for the application in question (it will require a Netdata restart).
```text
[plugin:apps]
update every = 5
```
3. [Restart](/docs/netdata-agent/start-stop-restart.md) the Agent after making changes.
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](/src/go/plugin/go.d/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.
**For Collectors**:
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.
First, [find the collector](/src/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](/docs/netdata-agent/configuration/README.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 the [appropriate method](/docs/netdata-agent/start-stop-restart.md) for your system.
Each collector has its own configuration format and options. Refer to the collector's documentation for specific instructions on adjusting its data collection frequency.
## Troubleshoot a collector
First, navigate to your plugins directory, which is usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case
on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the plugins directory,
switch to the `netdata` user.
1. Navigate to the plugins directory. If not found, check the `plugins directory` setting in `netdata.conf`.
```bash
cd /usr/libexec/netdata/plugins.d/
```
2. Switch to the netdata user.
```bash
sudo su -s /bin/bash netdata
```
3. Run debug mode
```bash
cd /usr/libexec/netdata/plugins.d/
sudo su -s /bin/bash netdata
```
```bash
# Go collectors
./go.d.plugin -d -m <MODULE_NAME>
The next step is based on the collector's orchestrator.
# Python collectors
./python.d.plugin <MODULE_NAME> debug trace
# Bash collectors
./charts.d.plugin debug 1 <MODULE_NAME>
```
4. Analyze output
```bash
# Go orchestrator (go.d.plugin)
./go.d.plugin -d -m <MODULE_NAME>
The debug output will show:
# Python orchestrator (python.d.plugin)
./python.d.plugin <MODULE_NAME> debug trace
- Configuration issues
- Connection problems
- Permission errors
- Other potential failures
# Bash orchestrator (bash.d.plugin)
./charts.d.plugin debug 1 <MODULE_NAME>
```
The output from the relevant command will provide valuable troubleshooting information. If you can't figure out how to
enable the collector using the details from this output, feel free to [join our Discord server](https://discord.com/invite/2mEmfW735j),
to get help from our experts.
Need help interpreting the results? Join our [Discord community](https://discord.com/invite/2mEmfW735j) for expert assistance.