opensourcemirror
/
netdata
mirror of https://github.com/netdata/netdata.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Docs: Standardize links between documentation (#8638) 

* Trying out some absolute-ish links

* Try one out on installer

* Testing logic

* Trying out some more links

* Fixing links

* Fix links in python collectors

* Changed a bunch more links

* Fix build errors

* Another push of links

* Fix build error and add more links

* Complete first pass

* Fix final broken links

* Fix links to files

* Fix for Netlify

* Two more fixes
This commit is contained in:
Joel Hans 2020-04-14 10:26:13 -07:00 committed by GitHub
parent 59916b01b8
commit e99692f145
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
155 changed files with 949 additions and 708 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
README.md
View File

@ -102,7 +102,7 @@ We provide Docker images for the most common architectures. These are statistics
### Registry
When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata
registry](registry/README.md). This is a web browser feature and it allows us to count the number of unique users and
registry](/registry/README.md). This is a web browser feature and it allows us to count the number of unique users and
unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
[![User
@ -136,19 +136,20 @@ bash <(curl -Ss https://my-netdata.io/kickstart.sh)
```
Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read
about the information collected, and learn how to-opt, on our [anonymous statistics](docs/anonymous-statistics.md) page.
about the information collected, and learn how to-opt, on our [anonymous statistics](/docs/anonymous-statistics.md) page.
The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for
_actively_ contributing to Netdata's future.
To learn more about the pros and cons of using _nightly_ vs. _stable_ releases, see our [notice about the two options](packaging/installer/README.md#nightly-vs-stable-releases).
To learn more about the pros and cons of using _nightly_ vs. _stable_ releases, see our [notice about the two options](/packaging/installer/README.md#nightly-vs-stable-releases).
The above command will:
- Install any required packages on your system (it will ask you to confirm before doing so)
- Compile it, install it, and start it.
More installation methods and additional options can be found at the [installation page](packaging/installer/).
More installation methods and additional options can be found at the [installation
page](/packaging/installer/README.md).
To try Netdata in a Docker container, run this:
@ -165,7 +166,7 @@ docker run -d --name=netdata \
netdata/netdata
```
For more information about running Netdata in Docker, check the [docker installation page](packaging/docker/).
For more information about running Netdata in Docker, check the [docker installation page](/packaging/docker/README.md).
![image](https://user-images.githubusercontent.com/2662304/48304090-fd384080-e51b-11e8-80ae-eecb03118dda.png)
@ -242,12 +243,12 @@ This is how it works:
| Function | Description | Documentation |
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |
| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](collectors/README.md) |
| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](database/README.md) |
| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](health/README.md) |
| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](streaming/README.md) |
| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`backends`](backends/README.md) |
| **Query** | Multiple independent workers are attached to the [internal web server](web/server/README.md), servicing API requests, including [data queries](web/api/queries/README.md). | [`web/api`](web/api/README.md) |
| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) |
| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) |
| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) |
| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) |
| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`backends`](/backends/README.md) |
| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) |
The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric.
@ -287,17 +288,17 @@ This is what you should expect from Netdata:
- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic
thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more.
- **Notifications**: [alerta.io](health/notifications/alerta/), [amazon sns](health/notifications/awssns/),
[discordapp.com](health/notifications/discord/), [email](health/notifications/email/),
[flock.com](health/notifications/flock/), [hangouts](health/notifications/hangouts/),
[irc](health/notifications/irc/), [kavenegar.com](health/notifications/kavenegar/),
[messagebird.com](health/notifications/messagebird/), [pagerduty.com](health/notifications/pagerduty/),
[prowl](health/notifications/prowl/), [pushbullet.com](health/notifications/pushbullet/),
[pushover.net](health/notifications/pushover/), [rocket.chat](health/notifications/rocketchat/),
[slack.com](health/notifications/slack/), [smstools3](health/notifications/smstools3/),
[syslog](health/notifications/syslog/), [telegram.org](health/notifications/telegram/),
[twilio.com](health/notifications/twilio/), [web](health/notifications/web/) and [custom
notifications](health/notifications/custom/).
- **Notifications**: [alerta.io](/health/notifications/alerta/), [amazon sns](/health/notifications/awssns/),
[discordapp.com](/health/notifications/discord/), [email](/health/notifications/email/),
[flock.com](/health/notifications/flock/), [hangouts](/health/notifications/hangouts/),
[irc](/health/notifications/irc/), [kavenegar.com](/health/notifications/kavenegar/),
[messagebird.com](/health/notifications/messagebird/), [pagerduty.com](/health/notifications/pagerduty/),
[prowl](health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/),
[pushover.net](health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/),
[slack.com](/health/notifications/slack/), [smstools3](/health/notifications/smstools3/),
[syslog](/health/notifications/syslog/), [telegram.org](/health/notifications/telegram/),
[twilio.com](/health/notifications/twilio/), [web](/health/notifications/web/) and [custom
notifications](/health/notifications/custom/).
### Integrations
@ -317,7 +318,7 @@ This is what you should expect from Netdata:
- **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect
anomalies visually.
- **Embeddable** - Charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence
as a monitoring dashboard](web/gui/confluence/).
as a monitoring dashboard](/web/gui/confluence/README.md).
- **Customizable** - You can build custom dashboards using simple HTML. No JavaScript needed!
### Positive and negative values
@ -350,7 +351,7 @@ _Charts are panned by dragging them with the mouse. Charts can be zoomed in/out
mouse pointer is over a chart._
> The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server when navigating via the
> [My nodes menu](registry/README.md).
> [My nodes menu](/registry/README.md).
### Highlighted time-frame
@ -363,21 +364,22 @@ _A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on
same range on all charts._
> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [My nodes
> menu](registry/README.md).
> menu](/registry/README.md).
## What Netdata monitors
Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics
jocs, such as CPU, memory, disks, filesystems, networking, and more. We call these **collectors**, and they're managed
by [**plugins**](collectors/plugins.d/), which support a variety of programming languages, including Go and Python.
by [**plugins**](/collectors/plugins.d/README.md), which support a variety of programming languages, including Go and
Python.
Popular collectors include **Nginx**, **Apache**, **MySQL**, **statsd**, **cgroups** (containers, Docker, Kubernetes,
LXC, and more), **Traefik**, **web server `access.log` files**, and much more.
See the **full list of [supported collectors](collectors/COLLECTORS.md)**.
See the **full list of [supported collectors](/collectors/COLLECTORS.md)**.
Netdata's data collection is **extensible**, which means you can monitor anything you can get a metric for. You can even
write a collector for your custom application using our [plugin API](collectors/plugins.d/README.md).
write a collector for your custom application using our [plugin API](/collectors/plugins.d/README.md).
## Documentation
@ -386,25 +388,25 @@ repository itself in Markdown (`.md`) files. You can find all our documentation
Here is a quick list of notable documents:
| Directory | Description |
| :------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------- |
| [`installer`](packaging/installer/) | Instructions to install Netdata on your systems. |
| [`docker`](packaging/docker/) | Instructions to install Netdata using docker. |
| [`daemon`](daemon/) | Information about the Netdata daemon and its configuration. |
| [`collectors`](collectors/) | Information about data collection plugins. |
| [`health`](health/) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. |
| [`streaming`](streaming/) | How to build hierarchies of Netdata servers, by streaming metrics between them. |
| [`backends`](backends/) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
| [`web/api`](web/api/) | Learn how to query the Netdata API and the queries it supports. |
| [`web/api/badges`](web/api/badges/) | Learn how to generate badges (SVG images) from live data. |
| [`web/gui/custom`](web/gui/custom/) | Learn how to create custom Netdata dashboards. |
| [`web/gui/confluence`](web/gui/confluence/) | Learn how to create Netdata dashboards on Atlassian's Confluence. |
| Directory | Description |
| :---------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- |
| [`installer`](/packaging/installer/README.md) | Instructions to install Netdata on your systems. |
| [`docker`](/packaging/docker/README.md) | Instructions to install Netdata using docker. |
| [`daemon`](/daemon/README.md) | Information about the Netdata daemon and its configuration. |
| [`collectors`](/collectors/README.md) | Information about data collection plugins. |
| [`health`](/health/README.md) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. |
| [`streaming`](/streaming/README.md) | How to build hierarchies of Netdata servers, by streaming metrics between them. |
| [`backends`](/backends/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
| [`web/api`](/web/api/README.md) | Learn how to query the Netdata API and the queries it supports. |
| [`web/api/badges`](/web/api/badges/README.md) | Learn how to generate badges (SVG images) from live data. |
| [`web/gui/custom`](/web/gui/custom/README.md) | Learn how to create custom Netdata dashboards. |
| [`web/gui/confluence`](/web/gui/confluence/README.md) | Learn how to create Netdata dashboards on Atlassian's Confluence. |
You can also check all the other directories. Most of them have plenty of documentation.
## Community
We welcome [contributions](CONTRIBUTING.md). Feel free to join the team!
We welcome [contributions](/CONTRIBUTING.md). Feel free to join the team!
To report bugs or get help, use [GitHub's issues](https://github.com/netdata/netdata/issues).
@ -413,15 +415,14 @@ You can also find Netdata on:
- [Facebook](https://www.facebook.com/linuxnetdata/)
- [Twitter](https://twitter.com/linuxnetdata)
- [StackShare](https://stackshare.io/netdata)
- [LinkedIn](https://www.linkedin.com/company/my-netdata.io/)
- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/)
- [Repology](https://repology.org/metapackage/netdata/versions)
## License
Netdata is [GPLv3+](LICENSE).
Netdata is [GPLv3+](/LICENSE).
Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](REDISTRIBUTED.md).
Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](/REDISTRIBUTED.md).
## Is it any good?

4
REDISTRIBUTED.md
View File

@ -10,7 +10,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/REDISTRIBUTED.md
Netdata copyright info:
Copyright 2016-2018, Costa Tsaousis.
Copyright 2018, Netdata Inc.
Released under [GPL v3 or later](LICENSE).
Released under [GPL v3 or later](https://raw.githubusercontent.com/netdata/netdata/master/LICENSE).
Netdata uses SPDX license tags to identify the license for its files.
Individual licenses referenced in the tags are available on the [SPDX project site](http://spdx.org/licenses/).
@ -163,7 +163,7 @@ connectivity is not available.
Copyright (c) 2014 Lucas Garron
[MIT License](https://github.com/lgarron/clipboard-polyfill/blob/master/LICENSE.md)
- [Utilities for writing code that runs on Python 2 and 3](collectors/python.d.plugin/python_modules/urllib3/packages/six.py)
- [Utilities for writing code that runs on Python 2 and 3](https://raw.githubusercontent.com/netdata/netdata/master/collectors/python.d.plugin/python_modules/urllib3/packages/six.py)
Copyright (c) 2010-2015 Benjamin Peterson
[MIT License](https://github.com/benjaminp/six/blob/master/LICENSE)

15
backends/README.md
View File

@ -36,7 +36,8 @@ So, although Netdata collects metrics every second, it can send to the backend s
metrics are sent to a document db, `JSON` formatted.
- **prometheus** is described at [prometheus page](prometheus/) since it pulls data from Netdata.
- **prometheus** is described at [prometheus page](/backends/prometheus/README.md) since it pulls data from
Netdata.
- **prometheus remote write** (a binary snappy-compressed protocol buffer encoding over HTTP used by
**Elasticsearch**, **Gnocchi**, **Graphite**, **InfluxDB**, **Kafka**, **OpenTSDB**, **PostgreSQL/TimescaleDB**,
@ -44,10 +45,10 @@ So, although Netdata collects metrics every second, it can send to the backend s
providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage))
metrics are labeled in the format, which is used by Netdata for the [plaintext prometheus
protocol](prometheus/). Notes on using the remote write backend are [here](prometheus/remote_write/).
protocol](/backends/prometheus/README.md). Notes on using the remote write backend are [here](/backends/prometheus/remote_write/README.md).
- **TimescaleDB** via [community-built connector](TIMESCALE.md) that takes JSON streams from a Netdata client
and writes them to a TimescaleDB table.
- **TimescaleDB** via [community-built connector](/backends/TIMESCALE.md) that takes JSON streams from a Netdata
client and writes them to a TimescaleDB table.
- **AWS Kinesis Data Streams**
@ -143,14 +144,14 @@ from your Netdata):
When multiple servers are defined, Netdata will try the next one when the first one fails. This allows you to
load-balance different servers: give your backend servers in different order on each Netdata.
Netdata also ships [`nc-backend.sh`](nc-backend.sh), a script that can be used as a fallback backend to save the
Netdata also ships `nc-backend.sh`, a script that can be used as a fallback backend to save the
metrics to disk and push them to the time-series database when it becomes available again. It can also be used to
monitor / trace / debug the metrics Netdata generates.
For kinesis backend `destination` should be set to an AWS region (for example, `us-east-1`).
The MongoDB backend doesn't use the `destination` option for its configuration. It uses the `mongodb.conf`
[configuration file](../backends/mongodb/) instead.
[configuration file](/backends/mongodb/README.md) instead.
- `data source = as collected`, or `data source = average`, or `data source = sum`, selects the kind of data that will
be sent to the backend.
@ -222,8 +223,6 @@ Netdata provides 5 charts:
## alarms
The latest version of the alarms configuration for monitoring the backend is [here](../health/health.d/backend.conf)
Netdata adds 4 alarms:
1. `backend_last_buffering`, number of seconds since the last successful buffering of backend data

2
backends/opentsdb/README.md
View File

@ -24,7 +24,7 @@ change the `destination = localhost:4242` line accordingly.
As of [v1.16.0](https://github.com/netdata/netdata/releases/tag/v1.16.0), Netdata can send metrics to OpenTSDB using
TLS/SSL. Unfortunately, OpenTDSB does not support encrypted connections, so you will have to configure a reverse proxy
to enable HTTPS communication between Netdata and OpenTSBD. You can set up a reverse proxy with
[Nginx](../../docs/Running-behind-nginx.md).
[Nginx](/docs/Running-behind-nginx.md).
After your proxy is configured, make the following changes to `netdata.conf`:

2
backends/prometheus/README.md
View File

@ -19,7 +19,7 @@ are starting at a fresh ubuntu shell (whether you'd like to follow along in a VM
### Installing Netdata
There are number of ways to install Netdata according to [Installation](../../packaging/installer/). The suggested way
There are number of ways to install Netdata according to [Installation](/packaging/installer/README.md). The suggested way
of installing the latest Netdata and keep it upgrade automatically. Using one line installation:
```sh

2
cli/README.md
View File

@ -30,6 +30,6 @@ reload-claiming-state
Reload agent claiming state from disk.
```
Those commands are the same that can be sent to netdata via [signals](../daemon/README.md#command-line-options).
Those commands are the same that can be sent to netdata via [signals](/daemon/README.md#command-line-options).
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcli%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

6
collectors/COLLECTORS.md
View File

@ -12,9 +12,9 @@ Netdata uses collectors to help you gather metrics from your favorite applicatio
real-time, interactive charts. The following list includes collectors for both internal system metrics, and external
apps/services metrics.
Read more about collectors and how to enable them in our [collectors documentation](README.md), or use the [collector
quickstart](QUICKSTART.md) to figure out how to collect metrics from your favorite app/service with auto-detection and
minimal configuration.
Read more about collectors and how to enable them in our [collectors documentation](/collectors/README.md), or use the
[collector quickstart](/collectors/QUICKSTART.md) to figure out how to collect metrics from your favorite app/service
with auto-detection and minimal configuration.
If you don't see the app/service you'd like to monitor here, check out our [GitHub
issues](https://github.com/netdata/netdata/issues). Use the search bar to look for previous discussions about that

7
collectors/QUICKSTART.md
View File

@ -115,8 +115,9 @@ entry in the menu and new interactive charts!
Collector not working? Learn about collector troubleshooting in our [collector
reference](REFERENCE.md#troubleshoot-a-collector).
View our [collectors tutorials](README.md#tutorials) to get specific instructions on enabling new and popular
collectors.
View our [collectors tutorials](/collectors/README.md#tutorials) to get specific instructions on enabling new and
popular collectors.
Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our
[internal plugin API](REFERENCE.md#internal-plugins-api) or our [external plugin docs](plugins.d/README.md).
[internal plugin API](/collectors/REFERENCE.md#internal-plugins-api) or our [external plugin
docs](/collectors/plugins.d/README.md).

33
collectors/README.md
View File

@ -9,45 +9,46 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/READM
Netdata can collect metrics from hundreds of different sources, be they internal data created by the system itself, or
external data created by services or applications. To see _all_ of the sources Netdata collects from, view our [list of
supported collectors](COLLECTORS.md), and then view our [quickstart guide](QUICKSTART.md) to get up-and-running.
supported collectors](/collectors/COLLECTORS.md), and then view our [quickstart guide](/collectors/QUICKSTART.md) to get
up-and-running.
There are two essential points to understand about how collecting metrics works in Netdata:
- All collectors are **installed by default** with every installation of Netdata. You do not need to install
collectors manually to collect metrics from new sources.
- Upon startup, Netdata will **auto-detect** any application or service that has a [collector](COLLECTORS.md), as long
as both the collector and the app/service are configured correctly.
- Upon startup, Netdata will **auto-detect** any application or service that has a
[collector](/collectors/COLLECTORS.md), as long as both the collector and the app/service are configured correctly.
Most users will want to enable a new Netdata collector for their app/service. For those details, see our [quickstart
guide](QUICKSTART.md).
guide](/collectors/QUICKSTART.md).
## Take your next steps with collectors
[Collectors quickstart](QUICKSTART.md)
[Collectors quickstart](/collectors/QUICKSTART.md)
[Supported collectors list](COLLECTORS.md)
[Supported collectors list](/collectors/COLLECTORS.md)
[Collectors configuration reference](REFERENCE.md)
[Collectors configuration reference](/collectors/REFERENCE.md)
## Tutorials
[Monitor Nginx or Apache web server log files with Netdata](../docs/tutorials/collect-apache-nginx-web-logs.md)
[Monitor Nginx or Apache web server log files with Netdata](/docs/tutorials/collect-apache-nginx-web-logs.md)
[Monitor CockroadchDB metrics with Netdata](../docs/tutorials/monitor-cockroachdb.md)
[Monitor CockroadchDB metrics with Netdata](/docs/tutorials/monitor-cockroachdb.md)
[Monitor Unbound DNS servers with Netdata](../docs/tutorials/collect-unbound-metrics.md)
[Monitor Unbound DNS servers with Netdata](/docs/tutorials/collect-unbound-metrics.md)
[Monitor a Hadoop cluster with Netdata](../docs/tutorials/monitor-hadoop-cluster.md)
[Monitor a Hadoop cluster with Netdata](/docs/tutorials/monitor-hadoop-cluster.md)
## Related features
**[Dashboards](../web/README.md)**: Vizualize your newly-collect metrics in real-time using Netdata's [built-in
dashboard](../web/gui/README.md).
**[Dashboards](/web/README.md)**: Vizualize your newly-collect metrics in real-time using Netdata's [built-in
dashboard](/web/gui/README.md).
**[Backends](../backends/README.md)**: Extend our built-in [database engine](), which supports long-term metrics
storage, by archiving metrics to like Graphite, Prometheus, MongoDB, TimescaleDB, and more.
**[Backends](/backends/README.md)**: Extend our built-in [database engine](/database/engine/README.md), which supports
long-term metrics storage, by archiving metrics to like Graphite, Prometheus, MongoDB, TimescaleDB, and more.
**[Exporting](../exporting/README.md)**: An experimental refactoring of our backends system with a modular system and
**[Exporting](/exporting/README.md)**: An experimental refactoring of our backends system with a modular system and
support for exporting metrics to multiple systems simultaneously.
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

8
collectors/REFERENCE.md
View File

@ -35,8 +35,8 @@ independent processes in a variety of programming languages based on their purpo
MySQL database, among many others.
For most users, enabling individual collectors for the application/service you're interested in is far more important
than knowing which plugin it uses. See our [collectors list](COLLECTORS.md) to see whether your favorite app/service has
a collector, and then read the [collectors quickstart](QUICKSTART.md) and the documentation for that specific collector
than knowing which plugin it uses. See our [collectors list](/collectors/COLLECTORS.md) to see whether your favorite app/service has
a collector, and then read the [collectors quickstart](/collectors/QUICKSTART.md) and the documentation for that specific collector
to figure out how to enable it.
There are three types of plugins:
@ -48,7 +48,7 @@ There are three types of plugins:
independent processes. They communicate with the daemon via pipes.
- **Plugin orchestrators**, which are external plugins that instead support a number of **modules**. Modules are a
type of collector. We have a few plugin orchestrators available for those who want to develop their own collectors,
but focus most of our efforts on the [Go plugin](go.d.plugin/README.md).
but focus most of our efforts on the [Go plugin](/collectors/go.d.plugin/README.md).
## Enable, configure, and disable modules
@ -59,7 +59,7 @@ However, there are cases that auto-detection fails. Usually, the reason is that
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).
View our [collectors quickstart](QUICKSTART.md) for explict details on enabling and configuring collector modules.
View our [collectors quickstart](/collectors/QUICKSTART.md) for explict details on enabling and configuring collector modules.
## Troubleshoot a collector

22
collectors/apps.plugin/README.md
View File

@ -14,7 +14,7 @@ for every process found running.
Since Netdata needs to present this information in charts and track them through time,
instead of presenting a `top` like list, `apps.plugin` uses a pre-defined list of **process groups**
to which it assigns all running processes. This list is [customizable](apps_groups.conf) and Netdata
to which it assigns all running processes. This list is customizable via `apps_groups.conf`, and Netdata
ships with a good default for most cases (to edit it on your system run `/etc/netdata/edit-config apps_groups.conf`).
So, `apps.plugin` builds a process tree (much like `ps fax` does in Linux), and groups
@ -22,7 +22,7 @@ processes together (evaluating both child and parent processes) so that the resu
a predefined set of members (of course, only process groups found running are reported).
> If you find that `apps.plugin` categorizes standard applications as `other`, we would be
> glad to accept pull requests improving the [defaults](apps_groups.conf) shipped with Netdata.
> glad to accept pull requests improving the defaults shipped with Netdata in `apps_groups.conf`.
Unlike traditional process monitoring tools (like `top`), `apps.plugin` is able to account the resource
utilization of exit processes. Their utilization is accounted at their currently running parents.
@ -67,7 +67,7 @@ Each of these sections provides the same number of charts:
The above are reported:
- For **Applications** per [target configured](apps_groups.conf).
- For **Applications** per target configured.
- For **Users** per username or UID (when the username is not available).
- For **User Groups** per groupname or GID (when groupname is not available).
@ -97,8 +97,7 @@ its CPU resources will be cut in half, and data collection will be once every 2
## Configuration
The configuration file is `/etc/netdata/apps_groups.conf` (the default is [here](apps_groups.conf)).
To edit it on your system run `/etc/netdata/edit-config apps_groups.conf`.
The configuration file is `/etc/netdata/apps_groups.conf`. To edit it on your system, run `/etc/netdata/edit-config apps_groups.conf`.
The configuration file works accepts multiple lines, each having this format:
@ -224,7 +223,7 @@ Examples below for process group `sql`:
- Open Pipes ![image](https://registry.my-netdata.io/api/v1/badge.svg?chart=apps.pipes&dimensions=sql&value_color=green=0%7Cred)
- Open Sockets ![image](https://registry.my-netdata.io/api/v1/badge.svg?chart=apps.sockets&dimensions=sql&value_color=green%3E=3%7Cred)
For more information about badges check [Generating Badges](../../web/api/badges)
For more information about badges check [Generating Badges](/web/api/badges/README.md)
## Comparison with console tools
@ -358,9 +357,7 @@ So, the `ssh` session is using 95% CPU time.
Why `ssh`?
`apps.plugin` groups all processes based on its configuration file
[`/etc/netdata/apps_groups.conf`](apps_groups.conf)
(to edit it on your system run `/etc/netdata/edit-config apps_groups.conf`).
`apps.plugin` groups all processes based on its configuration file.
The default configuration has nothing for `bash`, but it has for `sshd`, so Netdata accumulates
all ssh sessions to a dimension on the charts, called `ssh`. This includes all the processes in
the process tree of `sshd`, **including the exited children**.
@ -375,10 +372,9 @@ the process tree of `sshd`, **including the exited children**.
Netdata reads `/proc/<pid>/stat` for all processes, once per second and extracts `utime` and
`stime` (user and system cpu utilization), much like all the console tools do.
But it [also extracts `cutime` and `cstime`](https://github.com/netdata/netdata/blob/62596cc6b906b1564657510ca9135c08f6d4cdda/src/apps_plugin.c#L636-L642)
that account the user and system time of the exit children of each process. By keeping a map in
memory of the whole process tree, it is capable of assigning the right time to every process,
taking into account all its exited children.
But it also extracts `cutime` and `cstime` that account the user and system time of the exit children of each process.
By keeping a map in memory of the whole process tree, it is capable of assigning the right time to every process, taking
into account all its exited children.
It is tricky, since a process may be running for 1 hour and once it exits, its parent should not
receive the whole 1 hour of cpu time in just 1 second - you have to subtract the cpu time that has

2
collectors/cgroups.plugin/README.md
View File

@ -105,7 +105,7 @@ For this mapping Netdata provides 2 configuration options:
The whole point for the additional pattern list, is to limit the number of times the script will be called. Without this pattern list, the script might be called thousands of times, depending on the number of cgroups available in the system.
The above pattern list is matched against the path of the cgroup. For matched cgroups, Netdata calls the script [cgroup-name.sh](cgroup-name.sh.in) to get its name. This script queries `docker`, or applies heuristics to find give a name for the cgroup.
The above pattern list is matched against the path of the cgroup. For matched cgroups, Netdata calls the script [cgroup-name.sh](https://raw.githubusercontent.com/netdata/netdata/master/collectors/cgroups.plugin/cgroup-name.sh.in) to get its name. This script queries `docker`, or applies heuristics to find give a name for the cgroup.
### charts with zero metrics

10
collectors/charts.d.plugin/README.md
View File

@ -62,11 +62,11 @@ For a module called `X`, the following criteria must be met:
the collector cannot be used).
- `X_create()` - creates the Netdata charts, following the standard Netdata plugin guides as described in
**[External Plugins](../plugins.d/)** (commands `CHART` and `DIMENSION`).
**[External Plugins](/collectors/plugins.d/README.md)** (commands `CHART` and `DIMENSION`).
The return value does matter: 0 = OK, 1 = FAILED.
- `X_update()` - collects the values for the defined charts, following the standard Netdata plugin guides
as described in **[External Plugins](../plugins.d/)** (commands `BEGIN`, `SET`, `END`).
as described in **[External Plugins](/collectors/plugins.d/README.md)** (commands `BEGIN`, `SET`, `END`).
The return value also matters: 0 = OK, 1 = FAILED.
5. The following global variables are available to be set:
@ -74,7 +74,7 @@ For a module called `X`, the following criteria must be met:
The module script may use more functions or variables. But all of them must begin with `X_`.
The standard Netdata plugin variables are also available (check **[External Plugins](../plugins.d/)**).
The standard Netdata plugin variables are also available (check **[External Plugins](/collectors/plugins.d/README.md)**).
### X_check()
@ -88,7 +88,7 @@ connect to a local mysql database to find out if it can read the values it needs
### X_create()
The purpose of the BASH function `X_create()` is to create the charts and dimensions using the standard Netdata
plugin guides (**[External Plugins](../plugins.d/)**).
plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**).
`X_create()` will be called just once and only after `X_check()` was successful.
You can however call it yourself when there is need for it (for example to add a new dimension to an existing chart).
@ -98,7 +98,7 @@ A non-zero return value will disable the collector.
### X_update()
`X_update()` will be called repeatedly every `X_update_every` seconds, to collect new values and send them to Netdata,
following the Netdata plugin guides (**[External Plugins](../plugins.d/)**).
following the Netdata plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**).
The function will be called with one parameter: microseconds since the last time it was run. This value should be
appended to the `BEGIN` statement of every chart updated by the collector script.

2
collectors/charts.d.plugin/ap/README.md
View File

@ -84,7 +84,7 @@ Station 40:b8:37:5a:ed:5e (on wlan0)
## Configuration
Edit the `charts.d/ap.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/charts.d.plugin/apcupsd/README.md
View File

@ -12,7 +12,7 @@ Monitors different APC UPS models and retrieves status information using `apcacc
## Configuration
Edit the `charts.d/apcupsd.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/charts.d.plugin/libreswan/README.md
View File

@ -23,7 +23,7 @@ The following charts are created, **per tunnel**:
## Configuration
Edit the `charts.d/libreswan.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/charts.d.plugin/nut/README.md
View File

@ -52,7 +52,7 @@ The following charts will be created:
## Configuration
Edit the `charts.d/nut.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/charts.d.plugin/opensips/README.md
View File

@ -10,7 +10,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/chart
## Configuration
Edit the `charts.d/opensips.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

4
collectors/charts.d.plugin/sensors/README.md
View File

@ -8,7 +8,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/chart
# Linux machine sensors monitoring with Netdata
> THIS MODULE IS OBSOLETE.
> USE [THE PYTHON ONE](../../python.d.plugin/sensors) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
> USE [THE PYTHON ONE](/collectors/python.d.plugin/sensors) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT
>
> Unlike the python one, this module can collect temperature on RPi.
@ -34,7 +34,7 @@ One chart for every sensor chip found and each of the above will be created.
## Configuration
Edit the `charts.d/sensors.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/diskspace.plugin/README.md
View File

@ -39,6 +39,6 @@ Charts can be enabled/disabled for every mount separately:
# inodes usage = auto
```
> for disks performance monitoring, see the `proc` plugin, [here](../proc.plugin/#monitoring-disks)
> for disks performance monitoring, see the `proc` plugin, [here](/collectors/proc.plugin/README.md#monitoring-disks)
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fdiskspace.plugin%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

12
collectors/ebpf_process.plugin/README.md
View File

@ -71,9 +71,9 @@ commands. You can also configure your system's `/etc/fstab` configuration to mou
eBPF collection is only enabled if you install Netdata with the `--enable-ebpf` option.
If you installed via the [one-line installation script](../../packaging/installer/README.md), [64-bit
binary](../../packaging/installer/methods/kickstart-64.md), or [manually](../../packaging/installer/methods/manual.md),
you can append the `--enable-ebpf` option when you reinstall.
If you installed via the [one-line installation script](/packaging/installer/README.md), [64-bit
binary](/packaging/installer/methods/kickstart-64.md), or [manually](/packaging/installer/methods/manual.md), you can
append the `--enable-ebpf` option when you reinstall.
For example, if you used the one-line installation script, you can reinstall Netdata with the following:
@ -214,6 +214,6 @@ Because eBPF monitoring is complex, we are evaluating the performance of this ne
conditions, across various system loads, and when monitoring complex applications.
Our [initial testing](https://github.com/netdata/netdata/issues/8195) shows the performance of the eBPF collector is
nearly identical to our [apps.plugin collector](../apps.plugin/), despite collecting and displaying much more
sophisticated metrics. You can now use the eBPF to gather deeper insights without affecting the performance of your
complex applications at any load.
nearly identical to our [apps.plugin collector](/collectors/apps.plugin/README.md), despite collecting and displaying
much more sophisticated metrics. You can now use the eBPF to gather deeper insights without affecting the performance of
your complex applications at any load.

2
collectors/fping.plugin/README.md
View File

@ -44,7 +44,7 @@ fping_opts="-R -b 56 -i 1 -r 0 -t 5000"
## alarms
Netdata will automatically attach a few alarms for each host.
Check the [latest versions of the fping alarms](../../health/health.d/fping.conf)
Check the [latest versions of the fping alarms](https://raw.githubusercontent.com/netdata/netdata/master/health/health.d/fping.conf)
## Additional Tips

2
collectors/ioping.plugin/README.md
View File

@ -44,7 +44,7 @@ ioping_opts="-T 1000000 -R"
## alarms
Netdata will automatically attach a few alarms for each host.
Check the [latest versions of the ioping alarms](../../health/health.d/ioping.conf)
Check the [latest versions of the ioping alarms](https://raw.githubusercontent.com/netdata/netdata/master/health/health.d/ioping.conf)
## Multiple ioping Plugins With Different Settings

7
collectors/node.d.plugin/README.md
View File

@ -40,19 +40,18 @@ collectors in node.js. It also manages all its data collectors (placed in `/usr/
instance of node, thus lowering the memory footprint of data collection.
Of course, there can be independent plugins written in node.js (placed in `/usr/libexec/netdata/plugins`).
These will have to be developed using the guidelines of **[External Plugins](../plugins.d/)**.
These will have to be developed using the guidelines of **[External Plugins](/collectors/plugins.d/README.md)**.
To run `node.js` plugins you need to have `node` installed in your system.
In some older systems, the package named `node` is not node.js. It is a terminal emulation program called `ax25-node`.
In this case the node.js package may be referred as `nodejs`. Once you install `nodejs`, we suggest to link
`/usr/bin/nodejs` to `/usr/bin/node`, so that typing `node` in your terminal, opens node.js.
For more information check the **\[[Installation]]** guide.
## configuring `node.d.plugin`
`node.d.plugin` can work even without any configuration. Its default configuration file is
[/etc/netdata/node.d.conf](node.d.conf) (to edit it on your system run `/etc/netdata/edit-config node.d.conf`).
`node.d.conf`. To edit it on your system, run `/etc/netdata/edit-config node.d.conf`.
## configuring `node.d.plugin` modules
@ -234,6 +233,6 @@ The `service` object defines a set of functions to allow you send information to
---
_FIXME: document an operational node.d.plugin data collector - the best example is the
[snmp collector](snmp/snmp.node.js)_
[snmp collector](https://raw.githubusercontent.com/netdata/netdata/master/collectors/node.d.plugin/snmp/snmp.node.js)_
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fnode.d.plugin%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

35
collectors/plugins.d/README.md
View File

@ -14,18 +14,18 @@ from external processes, thus allowing Netdata to use **external plugins**.
|plugin|language|O/S|description|
|:----:|:------:|:-:|:----------|
|[apps.plugin](../apps.plugin/)|`C`|linux, freebsd|monitors the whole process tree on Linux and FreeBSD and breaks down system resource usage by **process**, **user** and **user group**.|
|[charts.d.plugin](../charts.d.plugin/)|`BASH`|all|a **plugin orchestrator** for data collection modules written in `BASH` v4+.|
|[cups.plugin](../cups.plugin/)|`C`|all|monitors **CUPS**|
|[fping.plugin](../fping.plugin/)|`C`|all|measures network latency, jitter and packet loss between the monitored node and any number of remote network end points.|
|[ioping.plugin](../ioping.plugin/)|`C`|all|measures disk latency.|
|[freeipmi.plugin](../freeipmi.plugin/)|`C`|linux|collects metrics from enterprise hardware sensors, on Linux servers.|
|[nfacct.plugin](../nfacct.plugin/)|`C`|linux|collects netfilter firewall, connection tracker and accounting metrics using `libmnl` and `libnetfilter_acct`.|
|[xenstat.plugin](../xenstat.plugin/)|`C`|linux|collects XenServer and XCP-ng metrics using `lxenstat`.|
|[perf.plugin](../perf.plugin/)|`C`|linux|collects CPU performance metrics using performance monitoring units (PMU).|
|[node.d.plugin](../node.d.plugin/)|`node.js`|all|a **plugin orchestrator** for data collection modules written in `node.js`.|
|[python.d.plugin](../python.d.plugin/)|`python`|all|a **plugin orchestrator** for data collection modules written in `python` v2 or v3 (both are supported).|
|[slabinfo.plugin](../slabinfo.plugin/)|`C`|linux|collects kernel internal cache objects (SLAB) metrics.|
|[apps.plugin](/collectors/apps.plugin/README.md)|`C`|linux, freebsd|monitors the whole process tree on Linux and FreeBSD and breaks down system resource usage by **process**, **user** and **user group**.|
|[charts.d.plugin](/collectors/charts.d.plugin/README.md)|`BASH`|all|a **plugin orchestrator** for data collection modules written in `BASH` v4+.|
|[cups.plugin](/collectors/cups.plugin/README.md)|`C`|all|monitors **CUPS**|
|[fping.plugin](/collectors/fping.plugin/README.md)|`C`|all|measures network latency, jitter and packet loss between the monitored node and any number of remote network end points.|
|[ioping.plugin](/collectors/ioping.plugin/README.md)|`C`|all|measures disk latency.|
|[freeipmi.plugin](/collectors/freeipmi.plugin/README.md)|`C`|linux|collects metrics from enterprise hardware sensors, on Linux servers.|
|[nfacct.plugin](/collectors/nfacct.plugin/README.md)|`C`|linux|collects netfilter firewall, connection tracker and accounting metrics using `libmnl` and `libnetfilter_acct`.|
|[xenstat.plugin](/collectors/xenstat.plugin/README.md)|`C`|linux|collects XenServer and XCP-ng metrics using `lxenstat`.|
|[perf.plugin](/collectors/perf.plugin/README.md)|`C`|linux|collects CPU performance metrics using performance monitoring units (PMU).|
|[node.d.plugin](/collectors/node.d.plugin/README.md)|`node.js`|all|a **plugin orchestrator** for data collection modules written in `node.js`.|
|[python.d.plugin](/collectors/python.d.plugin/README.md)|`python`|all|a **plugin orchestrator** for data collection modules written in `python` v2 or v3 (both are supported).|
|[slabinfo.plugin](/collectors/slabinfo.plugin/README.md)|`C`|linux|collects kernel internal cache objects (SLAB) metrics.|
Plugin orchestrators may also be described as **modular plugins**. They are modular since they accept custom made modules to be included. Writing modules for these plugins is easier than accessing the native Netdata API directly. You will find modules already available for each orchestrator under the directory of the particular modular plugin (e.g. under python.d.plugin for the python orchestrator).
Each of these modular plugins has each own methods for defining modules. Please check the examples and their documentation.
@ -64,7 +64,7 @@ Plugins can create any number of charts with any number of dimensions each. Each
Netdata will supply the environment variables `NETDATA_USER_CONFIG_DIR` (for user supplied) and `NETDATA_STOCK_CONFIG_DIR` (for Netdata supplied) configuration files to identify the directory where configuration files are stored. It is up to the plugin to read the configuration it needs.
The `netdata.conf` section [plugins] section contains a list of all the plugins found at the system where Netdata runs, with a boolean setting to enable them or not.
The `netdata.conf` section `[plugins]` section contains a list of all the plugins found at the system where Netdata runs, with a boolean setting to enable them or not.
Example:
@ -385,15 +385,18 @@ or do not output the line at all.
## Modular Plugins
1. **python**, use `python.d.plugin`, there are many examples in the [python.d directory](../python.d.plugin/)
1. **python**, use `python.d.plugin`, there are many examples in the [python.d
directory](/collectors/python.d.plugin/README.md)
python is ideal for Netdata plugins. It is a simple, yet powerful way to collect data, it has a very small memory footprint, although it is not the most CPU efficient way to do it.
2. **node.js**, use `node.d.plugin`, there are a few examples in the [node.d directory](../node.d.plugin/)
2. **node.js**, use `node.d.plugin`, there are a few examples in the [node.d
directory](/collectors/node.d.plugin/README.md)
node.js is the fastest scripting language for collecting data. If your plugin needs to do a lot of work, compute values, etc, node.js is probably the best choice before moving to compiled code. Keep in mind though that node.js is not memory efficient; it will probably need more RAM compared to python.
3. **BASH**, use `charts.d.plugin`, there are many examples in the [charts.d directory](../charts.d.plugin/)
3. **BASH**, use `charts.d.plugin`, there are many examples in the [charts.d
directory](/collectors/charts.d.plugin/README.md)
BASH is the simplest scripting language for collecting values. It is the less efficient though in terms of CPU resources. You can use it to collect data quickly, but extensive use of it might use a lot of system resources.

2
collectors/proc.plugin/README.md
View File

@ -307,7 +307,7 @@ By default Netdata will enable monitoring metrics only when they are not zero. I
There are several alarms defined in `health.d/net.conf`.
The tricky ones are `inbound packets dropped` and `inbound packets dropped ratio`. They have quite a strict policy so that they warn users about possible issues. These alarms can be annoying for some network configurations. It is especially true for some bonding configurations if an interface is a slave or a bonding interface itself. If it is expected to have a certain number of drops on an interface for a certain network configuration, a separate alarm with different triggering thresholds can be created or the existing one can be disabled for this specific interface. It can be done with the help of the [families](../../health/REFERENCE.md#alarm-line-families) line in the alarm configuration. For example, if you want to disable the `inbound packets dropped` alarm for `eth0`, set `families: !eth0 *` in the alarm definition for `template: inbound_packets_dropped`.
The tricky ones are `inbound packets dropped` and `inbound packets dropped ratio`. They have quite a strict policy so that they warn users about possible issues. These alarms can be annoying for some network configurations. It is especially true for some bonding configurations if an interface is a slave or a bonding interface itself. If it is expected to have a certain number of drops on an interface for a certain network configuration, a separate alarm with different triggering thresholds can be created or the existing one can be disabled for this specific interface. It can be done with the help of the [families](/health/REFERENCE.md#alarm-line-families) line in the alarm configuration. For example, if you want to disable the `inbound packets dropped` alarm for `eth0`, set `families: !eth0 *` in the alarm definition for `template: inbound_packets_dropped`.
#### configuration

6
collectors/python.d.plugin/README.md
View File

@ -81,7 +81,8 @@ Writing new python module is simple. You just need to remember to include 5 majo
If you plan to submit the module in a PR, make sure and go through the [PR checklist for new modules](#pull-request-checklist-for-python-plugins) beforehand to make sure you have updated all the files you need to.
For a quick start, you can look at the [example plugin](example/example.chart.py).
For a quick start, you can look at the [example
plugin](https://raw.githubusercontent.com/netdata/netdata/master/collectors/python.d.plugin/example/example.chart.py).
### Global variables `ORDER` and `CHART`
@ -204,7 +205,8 @@ For additional security it uses python `subprocess.Popen` (without `shell=True`
_Examples: `apache`, `nginx`, `tomcat`_
_Multiple Endpoints (urls) Examples: [`rabbitmq`](rabbitmq/README.md) (simpler) , [`elasticsearch`](elasticsearch/README.md) (threaded)_
_Multiple Endpoints (urls) Examples: [`rabbitmq`](/collectors/python.d.plugin/rabbitmq/README.md) (simpler) ,
[`elasticsearch`](/collectors/python.d.plugin/elasticsearch/README.md) (threaded)_
_Variables from config file_: `url`, `user`, `pass`.

2
collectors/python.d.plugin/adaptec_raid/README.md
View File

@ -45,7 +45,7 @@ adaptec_raid: yes
```
Edit the `python.d/adaptec_raid.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/am2320/README.md
View File

@ -22,7 +22,7 @@ It produces the following charts:
## Configuration
Edit the `python.d/am2320.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/apache/README.md
View File

@ -53,7 +53,7 @@ It produces the following charts:
## Configuration
Edit the `python.d/apache.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/beanstalk/README.md
View File

@ -113,7 +113,7 @@ Provides server and tube-level statistics.
## Configuration
Edit the `python.d/beanstalk.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/bind_rndc/README.md
View File

@ -59,7 +59,7 @@ It produces:
## Configuration
Edit the `python.d/bind_rndc.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/boinc/README.md
View File

@ -14,7 +14,7 @@ It provides charts tracking the total number of tasks and active tasks, as well
## Configuration
Edit the `python.d/boinc.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/ceph/README.md
View File

@ -29,7 +29,7 @@ Monitors the ceph cluster usage and consumption data of a server, and produces:
## Configuration
Edit the `python.d/ceph.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/chrony/README.md
View File

@ -24,7 +24,7 @@ Verify that user Netdata can execute `chronyc tracking`. If necessary, update `/
## Configuration
Edit the `python.d/chrony.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different

2
collectors/python.d.plugin/couchdb/README.md
View File

@ -21,7 +21,7 @@ Monitors vital statistics of a local Apache CouchDB 2.x server, including:
## Configuration
Edit the `python.d/couchdb.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/dns_query_time/README.md
View File

@ -18,7 +18,7 @@ It produces one aggregate chart or one chart per DNS server, showing the query t
## Configuration
Edit the `python.d/dns_query_time.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different

2
collectors/python.d.plugin/dnsdist/README.md
View File

@ -53,7 +53,7 @@ Collects load-balancer performance and health metrics, and draws the following c
## Configuration
Edit the `python.d/dnsdist.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different

2
collectors/python.d.plugin/dockerd/README.md
View File

@ -30,7 +30,7 @@ Following charts are drawn:
## Configuration
Edit the `python.d/dockerd.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different

2
collectors/python.d.plugin/dovecot/README.md
View File

@ -79,7 +79,7 @@ Module gives information with following charts:
## Configuration
Edit the `python.d/dovecot.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different

2
collectors/python.d.plugin/elasticsearch/README.md
View File

@ -68,7 +68,7 @@ It produces:
## Configuration
Edit the `python.d/elasticsearch.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different

2
collectors/python.d.plugin/energid/README.md
View File

@ -50,7 +50,7 @@ long daemon startup.
## Configuration
Edit the `python.d/energid.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different, if different

2
collectors/python.d.plugin/fail2ban/README.md
View File

@ -18,7 +18,7 @@ It produces one chart with multiple lines (one line per jail)
## Configuration
Edit the `python.d/fail2ban.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/freeradius/README.md
View File

@ -54,7 +54,7 @@ It produces:
## Configuration
Edit the `python.d/freeradius.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/gearman/README.md
View File

@ -28,7 +28,7 @@ It produces:
## Configuration
Edit the `python.d/gearman.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

20
collectors/python.d.plugin/go_expvar/README.md
View File

@ -116,9 +116,8 @@ the use of `netdata`s `go_expvar` module.
### Using Netdata go_expvar module
The `go_expvar` module is disabled by default. To enable it, edit [`python.d.conf`](../python.d.conf)
(to edit it on your system run `/etc/netdata/edit-config python.d.conf`), and change the `go_expvar`
variable to `yes`:
The `go_expvar` module is disabled by default. To enable it, edit `python.d.conf` (to edit it on your system run
`/etc/netdata/edit-config python.d.conf`), and change the `go_expvar` variable to `yes`:
```
# Enable / Disable python.d.plugin modules
@ -134,10 +133,9 @@ go_expvar: yes
...
```
Next, we need to edit the module configuration file (found at [`/etc/netdata/python.d/go_expvar.conf`](go_expvar.conf) by default)
(to edit it on your system run `/etc/netdata/edit-config python.d/go_expvar.conf`).
The module configuration consists of jobs, where each job can be used to monitor a separate Go application.
Let's see a sample job configuration:
Next, we need to edit the module configuration file (found at `/etc/netdata/python.d/go_expvar.conf` by default) (to
edit it on your system run `/etc/netdata/edit-config python.d/go_expvar.conf`). The module configuration consists of
jobs, where each job can be used to monitor a separate Go application. Let's see a sample job configuration:
```
# /etc/netdata/python.d/go_expvar.conf
@ -212,8 +210,8 @@ See [this issue](https://github.com/netdata/netdata/pull/1902#issuecomment-28449
Please see these two links to the official Netdata documentation for more information about the values:
- [External plugins - charts](../../plugins.d/#chart)
- [Chart variables](../#global-variables-order-and-chart)
- [External plugins - charts](/collectors/plugins.d/README.md#chart)
- [Chart variables](/collectors/python.d.plugin/README.md#global-variables-order-and-chart)
**Line definitions**
@ -236,7 +234,7 @@ hidden: False
```
Please see the following link for more information about the options and their default values:
[External plugins - dimensions](../../plugins.d/#dimension)
[External plugins - dimensions](/collectors/plugins.d/README.md#dimension)
Apart from top-level expvars, this plugin can also parse expvars stored in a multi-level map;
All dicts in the resulting JSON document are then flattened to one level.
@ -258,7 +256,7 @@ the first defined key wins and all subsequent keys with the same name are ignore
## Configuration
Edit the `python.d/go_expvar.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/haproxy/README.md
View File

@ -38,7 +38,7 @@ It produces:
## Configuration
Edit the `python.d/hapxory.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/hddtemp/README.md
View File

@ -17,7 +17,7 @@ It produces one chart **Temperature** with dynamic number of dimensions (one per
## Configuration
Edit the `python.d/hddtemp.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/hpssa/README.md
View File

@ -40,7 +40,7 @@ hpssa: yes
```
Edit the `python.d/hpssa.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/httpcheck/README.md
View File

@ -27,7 +27,7 @@ Following charts are drawn per job:
## Configuration
Edit the `python.d/httpcheck.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/icecast/README.md
View File

@ -22,7 +22,7 @@ It produces the following charts:
## Configuration
Edit the `python.d/icecast.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/ipfs/README.md
View File

@ -21,7 +21,7 @@ Collects [IPFS](https://ipfs.io) basic information like file system bandwidth, p
## Configuration
Edit the `python.d/ipfs.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/isc_dhcpd/README.md
View File

@ -31,7 +31,7 @@ It produces:
## Configuration
Edit the `python.d/isc_dhcpd.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/litespeed/README.md
View File

@ -54,7 +54,7 @@ It produces:
## Configuration
Edit the `python.d/litespeed.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/logind/README.md
View File

@ -43,7 +43,7 @@ command: '/path/to/other/command'
```
Edit the `python.d/logind.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/megacli/README.md
View File

@ -50,7 +50,7 @@ megacli: yes
```
Edit the `python.d/megacli.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/memcached/README.md
View File

@ -77,7 +77,7 @@ Collects memory-caching system performance metrics. It reads server response to
## Configuration
Edit the `python.d/memcached.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/mongodb/README.md
View File

@ -185,7 +185,7 @@ db.createUser({
## Configuration
Edit the `python.d/mongodb.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/monit/README.md
View File

@ -29,7 +29,7 @@ Monit monitoring module. Data is grabbed from stats XML interface (exists for a
## Configuration
Edit the `python.d/monit.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/mysql/README.md
View File

@ -338,7 +338,7 @@ This module will produce following charts (if data is available):
## Configuration
Edit the `python.d/mysql.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/nginx/README.md
View File

@ -40,7 +40,7 @@ It produces following charts:
## Configuration
Edit the `python.d/nginx.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/nginx_plus/README.md
View File

@ -143,7 +143,7 @@ For every cache:
## Configuration
Edit the `python.d/nginx_plus.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/ntpd/README.md
View File

@ -51,7 +51,7 @@ It produces:
## Configuration
Edit the `python.d/ntpd.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/nvidia_smi/README.md
View File

@ -44,7 +44,7 @@ It produces:
## Configuration
Edit the `python.d/nvidia_smi.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/openldap/README.md
View File

@ -57,7 +57,7 @@ Statistics are taken from LDAP monitoring interface. Manual page, slapd-monitor(
## Configuration
Edit the `python.d/openldap.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/oracledb/README.md
View File

@ -67,7 +67,7 @@ GRANT SELECT_CATALOG_ROLE TO netdata;
## Configuration
Edit the `python.d/oracledb.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/ovpn_status_log/README.md
View File

@ -32,7 +32,7 @@ It produces:
## Configuration
Edit the `python.d/ovpn_status_log.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/phpfpm/README.md
View File

@ -28,7 +28,7 @@ It produces following charts:
## Configuration
Edit the `python.d/phpfpm.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/portcheck/README.md
View File

@ -26,7 +26,7 @@ Following charts are drawn per host:
## Configuration
Edit the `python.d/portcheck.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

4
collectors/python.d.plugin/postgres/README.md
View File

@ -72,7 +72,7 @@ Following charts are drawn:
## Configuration
Edit the `python.d/postgres.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@ -95,8 +95,6 @@ tcp:
port : 5432
```
For all available options please see module [configuration file](postgres.conf).
---
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fpostgres%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

2
collectors/python.d.plugin/powerdns/README.md
View File

@ -85,7 +85,7 @@ Powerdns charts:
## Configuration
Edit the `python.d/powerdns.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/proxysql/README.md
View File

@ -75,7 +75,7 @@ It produces:
## Configuration
Edit the `python.d/proxysql.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/puppet/README.md
View File

@ -34,7 +34,7 @@ Following charts are drawn:
## Configuration
Edit the `python.d/puppet.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/rabbitmq/README.md
View File

@ -73,7 +73,7 @@ Per Vhost charts:
## Configuration
Edit the `python.d/rabbitmq.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/redis/README.md
View File

@ -40,7 +40,7 @@ Following charts are drawn:
## Configuration
Edit the `python.d/redis.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/rethinkdbs/README.md
View File

@ -31,7 +31,7 @@ Following charts are drawn:
## Configuration
Edit the `python.d/rethinkdbs.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/retroshare/README.md
View File

@ -23,7 +23,7 @@ This module produces the following charts:
## Configuration
Edit the `python.d/retroshare.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/riakkv/README.md
View File

@ -104,7 +104,7 @@ listed
## Configuration
Edit the `python.d/riakkv.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/samba/README.md
View File

@ -83,7 +83,7 @@ samba: yes
```
Edit the `python.d/samba.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/sensors/README.md
View File

@ -14,7 +14,7 @@ Charts are created dynamically.
## Configuration
Edit the `python.d/sensors.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/smartd_log/README.md
View File

@ -107,7 +107,7 @@ Otherwise, all the smartd `.csv` files may get written to `/var/lib/smartmontool
## Configuration
Edit the `python.d/smartd_log.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/spigotmc/README.md
View File

@ -19,7 +19,7 @@ the data returned by the `tps` or `list` console commands.
## Configuration
Edit the `python.d/spigotmc.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

6
collectors/python.d.plugin/springboot/README.md
View File

@ -102,7 +102,7 @@ Please refer [Spring Boot Actuator: Production-ready Features](https://docs.spri
## Usage
Edit the `python.d/springboot.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@ -139,6 +139,8 @@ You can disable the default charts by set `defaults.<chart-id>: false`.
The dimension name of extras charts should replace `.` to `_`.
Please check [springboot.conf](springboot.conf) for more examples.
Please check
[springboot.conf](https://raw.githubusercontent.com/netdata/netdata/master/collectors/python.d.plugin/springboot/springboot.conf)
for more examples.
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fspringboot%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

2
collectors/python.d.plugin/squid/README.md
View File

@ -36,7 +36,7 @@ It produces following charts:
## Configuration
Edit the `python.d/squid.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/tomcat/README.md
View File

@ -31,7 +31,7 @@ Charts:
## Configuration
Edit the `python.d/tomcat.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/tor/README.md
View File

@ -24,7 +24,7 @@ It produces only one chart:
## Configuration
Edit the `python.d/tor.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/traefik/README.md
View File

@ -49,7 +49,7 @@ It produces:
## Configuration
Edit the `python.d/traefik.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/uwsgi/README.md
View File

@ -30,7 +30,7 @@ Following charts are drawn:
## Configuration
Edit the `python.d/uwsgi.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/varnish/README.md
View File

@ -44,7 +44,7 @@ For every disk (SMF):
## Configuration
Edit the `python.d/varnish.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

2
collectors/python.d.plugin/w1sensor/README.md
View File

@ -17,7 +17,7 @@ Charts are created dynamically based on the number of detected sensors.
## Configuration
Edit the `python.d/w1sensor.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different

10
collectors/python.d.plugin/web_log/README.md
View File

@ -37,14 +37,14 @@ If Netdata is installed on a system running a web server, it will detect it and
## Configuration
Edit the `python.d/web_log.conf` configuration file using `edit-config` from the your agent's [config
directory](../../../docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file), which is typically at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/web_log.conf
```
[**netdata**](https://my-netdata.io/) has a powerful `web_log` plugin, capable of incrementally parsing any number of web server log files. This plugin is automatically started with [**netdata**](https://my-netdata.io/) and comes, pre-configured, for finding web server log files on popular distributions. Its configuration is at [`/etc/netdata/python.d/web_log.conf`](web_log.conf), like this:
[**netdata**](https://my-netdata.io/) has a powerful `web_log` plugin, capable of incrementally parsing any number of web server log files. This plugin is automatically started with [**netdata**](https://my-netdata.io/) and comes, pre-configured, for finding web server log files on popular distributions. Its configuration is at `/etc/netdata/python.d/web_log.conf`, like this:
```yaml
nginx_log:
@ -121,7 +121,7 @@ This is a nice view of the traffic the web server is receiving and is sending.
What is important to know for this chart, is that the bandwidth used for each request and response is accounted at the time the log is written. Since [**netdata**](https://my-netdata.io/) refreshes this chart every single second, you may have unrealistic spikes is the size of the requests or responses is too big. The reason is simple: a response may have needed 1 minute to be completed, but all the bandwidth used during that minute for the specific response will be accounted at the second the log line is written.
As the legend on the chart suggests, you can use FireQoS to setup QoS on the web server ports and IPs to accurately measure the bandwidth the web server is using. Actually, [there may be a few more reasons to install QoS on your servers](../../tc.plugin/#tcplugin)...
As the legend on the chart suggests, you can use FireQoS to setup QoS on the web server ports and IPs to accurately measure the bandwidth the web server is using. Actually, [there may be a few more reasons to install QoS on your servers](/collectors/tc.plugin/README.md#tcplugin)...
**Bandwidth** KB/s
@ -202,7 +202,7 @@ The last charts are about the unique IPs accessing your web server.
## Alarms
The magic of [**netdata**](https://my-netdata.io/) is that all metrics are collected per second, and all metrics can be used or correlated to provide real-time alarms. Out of the box, [**netdata**](https://my-netdata.io/) automatically attaches the [following alarms](../../../health/health.d/web_log.conf) to all `web_log` charts (i.e. to all log files configured, individually):
The magic of [**netdata**](https://my-netdata.io/) is that all metrics are collected per second, and all metrics can be used or correlated to provide real-time alarms. Out of the box, [**netdata**](https://my-netdata.io/) automatically attaches the following alarms] to all `web_log` charts (i.e. to all log files configured, individually):
| alarm|description|minimum<br/>requests|warning|critical|
|:----|-----------|:------------------:|:-----:|:------:|
@ -215,6 +215,6 @@ The magic of [**netdata**](https://my-netdata.io/) is that all metrics are colle
The column `minimum requests` state the minimum number of requests required for the alarm to be evaluated. We found that when the site is receiving requests above this rate, these alarms are pretty accurate (i.e. no false-positives).
[**netdata**](https://my-netdata.io/) alarms are user configurable. Sample config files can be found under directory `health/health.d` of the [Netdata GitHub repository](https://github.com/netdata/netdata/). So, even [`web_log` alarms can be adapted to your needs](../../../health/health.d/web_log.conf).
Netdata alarms are user-configurable. Sample config files can be found under directory `health/health.d` of the [Netdata GitHub repository](https://github.com/netdata/netdata/).
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fweb_log%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

6
collectors/tc.plugin/README.md
View File

@ -15,9 +15,9 @@ Netdata monitors `tc` QoS classes for all interfaces.
If you also use [FireQOS](http://firehol.org/tutorial/fireqos-new-user/) it will collect interface and class names.
There is a [shell helper](tc-qos-helper.sh.in) for this (all parsing is done by the plugin in `C` code - this shell script is just a configuration for the command to run to get `tc` output).
There is a [shell helper](https://raw.githubusercontent.com/netdata/netdata/master/collectors/tc.plugin/tc-qos-helper.sh.in) for this (all parsing is done by the plugin in `C` code - this shell script is just a configuration for the command to run to get `tc` output).
The source of the tc plugin is [here](plugin_tc.c). It is somewhat complex, because a state machine was needed to keep track of all the `tc` classes, including the pseudo classes tc dynamically creates.
The source of the tc plugin is [here](https://raw.githubusercontent.com/netdata/netdata/master/collectors/tc.plugin/plugin_tc.c). It is somewhat complex, because a state machine was needed to keep track of all the `tc` classes, including the pseudo classes tc dynamically creates.
## Motivation
@ -69,7 +69,7 @@ QoS is about 2 features:
When your system is under a DDoS attack, it will get a lot more bandwidth compared to the one it can handle and probably your applications will crash. Setting a limit on the inbound traffic using QoS, will protect your servers (throttle the requests) and depending on the size of the attack may allow your legitimate users to access the server, while the attack is taking place.
Using QoS together with a [SYNPROXY](../../collectors/proc.plugin/README.md) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](../../collectors/proc.plugin/README.md).
Using QoS together with a [SYNPROXY](/collectors/proc.plugin/README.md) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](/collectors/proc.plugin/README.md).
On top of all these, QoS is extremely light. You will configure it once, and this is it. It will not bother you again and it will not use any noticeable CPU resources, especially on application and database servers.

8
daemon/README.md
View File

@ -12,7 +12,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/README.md
- You can start Netdata by executing it with `/usr/sbin/netdata` (the installer will also start it).
- You can stop Netdata by killing it with `killall netdata`. You can stop and start Netdata at any point. When
exiting, the [database engine](../database/engine/README.md) saves metrics to `/var/cache/netdata/dbengine/` so that
exiting, the [database engine](/database/engine/README.md) saves metrics to `/var/cache/netdata/dbengine/` so that
it can continue when started again.
Access to the web site, for all graphs, is by default on port `19999`, so go to:
@ -192,7 +192,7 @@ The command line options of the Netdata 1.10.0 version are the following:
- USR2 Reload health configuration.
```
You can send commands during runtime via [netdatacli](../cli).
You can send commands during runtime via [netdatacli](/cli/README.md).
## Log files
@ -485,8 +485,8 @@ When you compile Netdata with debugging:
2. a lot of code is added all over netdata, to log debug messages to `/var/log/netdata/debug.log`. However, nothing is
printed by default. Netdata allows you to select which sections of Netdata you want to trace. Tracing is activated
via the config option `debug flags`. It accepts a hex number, to enable or disable specific sections. You can find
the options supported at [log.h](../libnetdata/log/log.h). They are the `D_*` defines. The value
`0xffffffffffffffff` will enable all possible debug flags.
the options supported at [log.h](https://raw.githubusercontent.com/netdata/netdata/master/libnetdata/log/log.h).
They are the `D_*` defines. The value `0xffffffffffffffff` will enable all possible debug flags.
Once Netdata is compiled with debugging and tracing is enabled for a few sections, the file `/var/log/netdata/debug.log`
will contain the messages.

65
daemon/config/README.md
View File

@ -11,17 +11,18 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/config/RE
<details markdown="1"><summary>The daemon configuration file is read from `/etc/netdata/netdata.conf`.</summary>
Depending on your installation method, Netdata will have been installed either directly under `/`, or under `/opt/netdata`. The paths mentioned here and in the documentation in general assume that your installation is under `/`. If it is not, you will find the exact same paths under `/opt/netdata` as well. (i.e. `/etc/netdata` will be `/opt/netdata/etc/netdata`).</details>
This config file **is not needed by default**. Netdata works fine out of the box without it. But it does allow you to adapt the general behavior of Netdata, in great detail. You can find all these settings, with their default values, by accessing the URL `https://netdata.server.hostname:19999/netdata.conf`. For example check the configuration file of [netdata.firehol.org](http://netdata.firehol.org/netdata.conf). HTTP access to this file is limited by default to private IPs, via the [web server access lists](../../web/server/#access-lists).
This config file **is not needed by default**. Netdata works fine out of the box without it. But it does allow you to adapt the general behavior of Netdata, in great detail. You can find all these settings, with their default values, by accessing the URL `https://netdata.server.hostname:19999/netdata.conf`. For example check the configuration file of [netdata.firehol.org](http://netdata.firehol.org/netdata.conf). HTTP access to this file is limited by default to private IPs, via the [web server access lists](/web/server/README.md#access-lists).
`netdata.conf` has sections stated with `[section]`. You will see the following sections:
1. `[global]` to [configure](#global-section-options) the [Netdata daemon](../).
2. `[web]` to [configure the web server](../../web/server).
3. `[plugins]` to [configure](#plugins-section-options) which [collectors](../../collectors) to use and PATH settings.
4. `[health]` to [configure](#health-section-options) general settings for [health monitoring](../../health)
5. `[registry]` for the [Netdata registry](../../registry).
6. `[backend]` to set up [streaming and replication](../../streaming) options.
7. `[statsd]` for the general settings of the [stats.d.plugin](../../collectors/statsd.plugin).
1. `[global]` to [configure](#global-section-options) the [Netdata daemon](/daemon/README.md).
2. `[web]` to [configure the web server](/web/server/README.md).
3. `[plugins]` to [configure](#plugins-section-options) which [collectors](/collectors/README.md) to use and PATH
settings.
4. `[health]` to [configure](#health-section-options) general settings for [health monitoring](/health/README.md)
5. `[registry]` for the [Netdata registry](/registry/README.md).
6. `[backend]` to set up [streaming and replication](/streaming/README.md) options.
7. `[statsd]` for the general settings of the [stats.d.plugin](/collectors/statsd.plugin/README.md).
8. `[plugin:NAME]` sections for each collector plugin, under the comment [Per plugin configuration](#per-plugin-configuration).
9. `[CHART_NAME]` sections for each chart defined, under the comment [Per chart configuration](#per-chart-configuration).
@ -49,16 +50,16 @@ Please note that your data history will be lost if you have modified `history` p
| setting|default|info|||
|:-----:|:-----:|:---|---|---|
| process scheduling policy|`keep`|See [Netdata process scheduling policy](../#netdata-process-scheduling-policy)|||
| process scheduling policy|`keep`|See [Netdata process scheduling policy](/daemon/README.md#netdata-process-scheduling-policy)|||
| OOM score|`1000`|See [OOM score](../#oom-score)|||
| glibc malloc arena max for plugins|`1`|See [Virtual memory](../#virtual-memory).|||
| glibc malloc arena max for Netdata|`1`|See [Virtual memory](../#virtual-memory).|||
| glibc malloc arena max for plugins|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).|||
| glibc malloc arena max for Netdata|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).|||
| hostname|auto-detected|The hostname of the computer running Netdata.|||
| history|`3996`| Used with `memory mode = save/map/ram/alloc`, not the default `memory mode = dbengine`. This number reflects the number of entries the `netdata` daemon will by default keep in memory for each chart dimension. This setting can also be configured per chart. Check [Memory Requirements](../../database/README.md#database) for more information. |||
| update every|`1`|The frequency in seconds, for data collection. For more information see [Performance](../../docs/Performance.md#performance).|||
| history|`3996`| Used with `memory mode = save/map/ram/alloc`, not the default `memory mode = dbengine`. This number reflects the number of entries the `netdata` daemon will by default keep in memory for each chart dimension. This setting can also be configured per chart. Check [Memory Requirements](/database/README.md) for more information. |||
| update every|`1`|The frequency in seconds, for data collection. For more information see [Performance](/docs/Performance.md).|||
| config directory|`/etc/netdata`|The directory configuration files are kept.|||
| stock config directory|`/usr/lib/netdata/conf.d`||||
| log directory|`/var/log/netdata`|The directory in which the [log files](../#log-files) are kept.|||
| log directory|`/var/log/netdata`|The directory in which the [log files](/daemon/README.md#log-files) are kept.|||
| web files directory|`/usr/share/netdata/web`|The directory the web static files are kept.|||
| cache directory|`/var/cache/netdata`|The directory the memory database will be stored if and when Netdata exits. Netdata will re-read the database when it will start again, to continue from the same point.|||
| lib directory|`/var/lib/netdata`|Contains the alarm log and the Netdata instance guid.|||
@ -68,27 +69,27 @@ Please note that your data history will be lost if you have modified `history` p
| page cache size | 32 | Determines the amount of RAM in MiB that is dedicated to caching Netdata metric values. |||
| dbengine disk space | 256 | Determines the amount of disk space in MiB that is dedicated to storing Netdata metric values and all related metadata describing them |||
| host access prefix||This is used in docker environments where /proc, /sys, etc have to be accessed via another path. You may also have to set SYS_PTRACE capability on the docker for this work. Check [issue 43](https://github.com/netdata/netdata/issues/43).|
| memory deduplication (ksm)|`yes`|When set to `yes`, Netdata will offer its in-memory round robin database to kernel same page merging (KSM) for deduplication. For more information check [Memory Deduplication - Kernel Same Page Merging - KSM](../../database/#ksm)|||
| memory deduplication (ksm)|`yes`|When set to `yes`, Netdata will offer its in-memory round robin database to kernel same page merging (KSM) for deduplication. For more information check [Memory Deduplication - Kernel Same Page Merging - KSM](/database/README.md#ksm)|||
| TZ environment variable|`:/etc/localtime`|Where to find the timezone|||
| timezone|auto-detected|The timezone retrieved from the environment variable|||
| debug flags|`0x0000000000000000`|Bitmap of debug options to enable. For more information check [Tracing Options](../#debugging).|||
| debug log|`/var/log/netdata/debug.log`|The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to `syslog` to send the debug messages to syslog, or `none` to disable this log. For more information check [Tracing Options](../#debugging).|||
| debug flags|`0x0000000000000000`|Bitmap of debug options to enable. For more information check [Tracing Options](/daemon/README.md#debugging).|||
| debug log|`/var/log/netdata/debug.log`|The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to `syslog` to send the debug messages to syslog, or `none` to disable this log. For more information check [Tracing Options](/daemon/README.md#debugging).|||
| error log|`/var/log/netdata/error.log`|The filename to save error messages for Netdata daemon and all plugins (`stderr` is sent here for all Netdata programs, including the plugins). You can also set it to `syslog` to send the errors to syslog, or `none` to disable this log.|||
| access log|`/var/log/netdata/access.log`|The filename to save the log of web clients accessing Netdata charts. You can also set it to `syslog` to send the access log to syslog, or `none` to disable this log.|||
| errors flood protection period|`1200`|UNUSED - Length of period (in sec) during which the number of errors should not exceed the `errors to trigger flood protection`.|||
| errors to trigger flood protection|`200`|UNUSED - Number of errors written to the log in `errors flood protection period` sec before flood protection is activated.|||
| run as user|`netdata`|The user Netdata will run as.|||
| pthread stack size|auto-detected||||
| cleanup obsolete charts after seconds|`3600`|See [monitoring ephemeral containers](../../collectors/cgroups.plugin/#monitoring-ephemeral-containers), also sets the timeout for cleaning up obsolete dimensions|||
| cleanup obsolete charts after seconds|`3600`|See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also sets the timeout for cleaning up obsolete dimensions|||
| gap when lost iterations above|`1`||||
| cleanup orphan hosts after seconds|`3600`|How long to wait until automatically removing from the DB a remote Netdata host (slave) that is no longer sending data.|||
| delete obsolete charts files|`yes`|See [monitoring ephemeral containers](../../collectors/cgroups.plugin/#monitoring-ephemeral-containers), also affects the deletion of files for obsolete dimensions|||
| delete obsolete charts files|`yes`|See [monitoring ephemeral containers](/collectors/cgroups.plugin/README.md#monitoring-ephemeral-containers), also affects the deletion of files for obsolete dimensions|||
| delete orphan hosts files|`yes`|Set to `no` to disable non-responsive host removal.|||
| enable zero metrics|`no`|Set to `yes` to show charts when all their metrics are zero.|||
### [web] section options
Refer to the [web server documentation](../../web/server)
Refer to the [web server documentation](/web/server/README.md)
### [plugins] section options
@ -108,9 +109,10 @@ Additionally, there will be the following options:
This section controls the general behavior of the health monitoring capabilities of Netdata.
Specific alarms are configured in per-collector config files under the `health.d` directory. For more info, see [health monitoring](../../health/#health-monitoring).
Specific alarms are configured in per-collector config files under the `health.d` directory. For more info, see [health
monitoring](/health/README.md).
[Alarm notifications](../../health/notifications/#netdata-alarm-notifications) are configured in `health_alarm_notify.conf`.
[Alarm notifications](/health/notifications/README.md) are configured in `health_alarm_notify.conf`.
| setting|default|info|
|:-----:|:-----:|:---|
@ -125,11 +127,11 @@ Specific alarms are configured in per-collector config files under the `health.d
### [registry] section options
To understand what this section is and how it should be configured, please refer to the [registry documentation](../../registry).
To understand what this section is and how it should be configured, please refer to the [registry documentation](/registry/README.md).
### [backend]
Refer to the [streaming and replication](../../streaming) documentation.
Refer to the [streaming and replication](/streaming/README.md) documentation.
## Per-plugin configuration
@ -137,7 +139,8 @@ The configuration options for plugins appear in sections following the pattern `
### Internal plugins
Most internal plugins will provide additional options. Check [Internal Plugins](../../collectors/) for more information.
Most internal plugins will provide additional options. Check [Internal Plugins](/collectors/README.md) for more
information.
Please note, that by default Netdata will enable monitoring metrics for disks, memory, and network only when they are not zero. If they are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear though). Use `yes` instead of `auto` in plugin configuration sections to enable these charts permanently. You can also set the `enable zero metrics` option to `yes` in the `[global]` section which enables charts with zero metrics for all internal Netdata plugins.
@ -147,7 +150,7 @@ External plugins will have only 2 options at `netdata.conf`:
| setting | default | info |
| :-----:|:-----:|:---|
| update every | the value of `[global].update every` setting|The frequency in seconds the plugin should collect values. For more information check [Performance](../../docs/Performance.md#performance).|
| update every | the value of `[global].update every` setting|The frequency in seconds the plugin should collect values. For more information check [Performance](/docs/Performance.md#performance).|
| command options | _empty_ | Additional command line options to pass to the plugin.|
External plugins that need additional configuration may support a dedicated file in `/etc/netdata`. Check their documentation.
@ -158,7 +161,7 @@ In this area of `netdata.conf` you can find configuration options for individual
following the pattern `[NAME]`.
Using the settings and values under these sections, you can control all aspects of a specific chart. You can change its
title, make it appear higher in Netdata's [menu](../../web/gui/README.md#menus), tweak its dimensions, and much more.
title, make it appear higher in Netdata's [menu](/web/gui/README.md#menus), tweak its dimensions, and much more.
To find the name of a given chart, and thus the name of its section in `netdata.conf`, look at the top-left corner of a
chart:
@ -175,12 +178,12 @@ that is information about lines that begin with `dim`, which affect a chart's di
| `enabled` | A boolean (`yes` or `no`) that explicitly enables or disables the chart in question. |
| `cache directory` | The directory where cache files for this plugin, if needed, are stored. |
| `chart type` | Defines what type of chart to display. It can be `line`, `area`, or `stacked`. If empty or missing, `line` will be used. |
| `type` | Uniquely identify which [menu](../../web/gui/README.md#menus) on the Netdata dashboard this chart should appear under. Some examples include `system` (**System**), `disk` (**Disks**), `net` (**Network Interfaces**), and `netdata` (**Netdata Monitoring**). |
| `family` | Change the chart's [family](../../web/README.md#families) from its default. For example, you could force a disk space chart to collect metrics for family `sdb` instead of family `sda`. |
| `type` | Uniquely identify which [menu](/web/gui/README.md#menus) on the Netdata dashboard this chart should appear under. Some examples include `system` (**System**), `disk` (**Disks**), `net` (**Network Interfaces**), and `netdata` (**Netdata Monitoring**). |
| `family` | Change the chart's [family](/web/README.md#families) from its default. For example, you could force a disk space chart to collect metrics for family `sdb` instead of family `sda`. |
| `units` | Text for the label of the vertical axis of the chart. This means all dimensions should have the same unit of measurement. |
| `context` | Change the default [context](../../web/README.md#contexts) of the chart. Changing this setting will affect what metrics and metrics the chart displays, and which alarms are attached to it. |
| `context` | Change the default [context](/web/README.md#contexts) of the chart. Changing this setting will affect what metrics and metrics the chart displays, and which alarms are attached to it. |
| `priority` | Define where the chart should appear on the Netdata dashboard. Lower values equal higher priority, so a priority of `1` will place the chart highest, while a priority of `9999999` would place the chart at the bottom of the Netdata dashboard. |
| `name` | The name of the chart that appears in the top-left corner, after the chart's title. You can also use this name when writing [health entities](../../health/REFERENCE.md#health-entity-reference). |
| `name` | The name of the chart that appears in the top-left corner, after the chart's title. You can also use this name when writing [health entities](/health/REFERENCE.md#health-entity-reference). |
| `title` | The text that appears above the chart in the Netdata dashboard. |
### Dimension settings

24
database/README.md
View File

@ -10,12 +10,12 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/database/README.
Netdata is fully capable of long-term metrics storage, at per-second granularity, via its default database engine
(`dbengine`). But to remain as flexible as possible, Netdata supports a number of types of metrics storage:
1. `dbengine`, (the default) data are in database files. The [Database Engine](engine/) works like a traditional
database. There is some amount of RAM dedicated to data caching and indexing and the rest of the data reside
compressed on disk. The number of history entries is not fixed in this case, but depends on the configured disk
space and the effective compression ratio of the data stored. This is the **only mode** that supports changing the
data collection update frequency (`update_every`) **without losing** the previously stored metrics. For more details
see [here](engine/).
1. `dbengine`, (the default) data are in database files. The [Database Engine](/database/engine/README.md) works like a
traditional database. There is some amount of RAM dedicated to data caching and indexing and the rest of the data
reside compressed on disk. The number of history entries is not fixed in this case, but depends on the configured
disk space and the effective compression ratio of the data stored. This is the **only mode** that supports changing
the data collection update frequency (`update_every`) **without losing** the previously stored metrics. For more
details see [here](/database/engine/README.md).
2. `ram`, data are purely in memory. Data are never saved on disk. This mode uses `mmap()` and supports [KSM](#ksm).
@ -60,7 +60,7 @@ seconds. This will **cut in half** both CPU and RAM resources consumed by Netdat
weak devices you might have to use `update every = 5` and `history = 720` (still 1 hour of data, but 1/5 of the CPU and
RAM resources).
You can also disable [data collection plugins](../collectors) you don't need. Disabling such plugins will also free both
You can also disable [data collection plugins](/collectors/README.md) you don't need. Disabling such plugins will also free both
CPU and RAM resources.
## Running a dedicated central Netdata server
@ -148,15 +148,15 @@ There is another memory mode to help overcome the memory size problem. What is *
### dbengine
In this mode, the database of Netdata is stored in database files. The [Database Engine](engine/) works like a
traditional database. There is some amount of RAM dedicated to data caching and indexing and the rest of the data reside
compressed on disk. The number of history entries is not fixed in this case, but depends on the configured disk space
and the effective compression ratio of the data stored.
In this mode, the database of Netdata is stored in database files. The [Database Engine](/database/engine/README.md)
works like a traditional database. There is some amount of RAM dedicated to data caching and indexing and the rest of
the data reside compressed on disk. The number of history entries is not fixed in this case, but depends on the
configured disk space and the effective compression ratio of the data stored.
We suggest to use **this** mode on nodes that also run other applications. The Database Engine uses direct I/O to avoid
polluting the OS filesystem caches and does not generate excessive I/O traffic so as to create the minimum possible
interference with other applications. Using memory mode `dbengine` we can overcome most memory restrictions. For more
details see [here](engine/).
details see [here](/database/engine/README.md).
## KSM

2
database/engine/README.md
View File

@ -46,7 +46,7 @@ can select the memory mode for localhost by editing netdata.conf and setting:
```
For setting the memory mode for the rest of the nodes you should look at
[streaming](../../streaming/).
[streaming](/streaming/README.md).
The `history` configuration option is meaningless for `memory mode = dbengine` and is ignored for any metrics being
stored in the DB engine.

6
docs/Add-more-charts-to-netdata.md
View File

@ -7,10 +7,10 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-ch
# Add more charts to Netdata
This file has been deprecated. Please see our [collectors docs](../collectors/README.md) or the collectors [quickstart
guide](../collectors/QUICKSTART.md) for more information.
This file has been deprecated. Please see our [collectors docs](/collectors/README.md) or the collectors [quickstart
guide](/collectors/QUICKSTART.md) for more information.
## Available data collection modules
See the [list of supported collectors](../collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics
See the [list of supported collectors](/collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics
from.

16
docs/Performance.md
View File

@ -32,15 +32,15 @@ For most server systems, with a few hundred charts and a few thousand dimensions
To prove Netdata scalability, check issue [#1323](https://github.com/netdata/netdata/issues/1323#issuecomment-265501668) where Netdata collects 95.000 metrics per second, with 12% CPU utilization of a single core!
In embedded systems, if the Netdata daemon is using a lot of CPU without any web clients accessing it, you should lower the data collection frequency. To set the data collection frequency, edit `/etc/netdata/netdata.conf` and set `update_every` to a higher number (this is the frequency in seconds data are collected for all charts: higher number of seconds = lower frequency, the default is 1 for per second data collection). You can also set this frequency per module or chart. Check the [daemon configuration](../daemon/config) for plugins and charts. For specific modules, the configuration needs to be changed in:
In embedded systems, if the Netdata daemon is using a lot of CPU without any web clients accessing it, you should lower the data collection frequency. To set the data collection frequency, edit `/etc/netdata/netdata.conf` and set `update_every` to a higher number (this is the frequency in seconds data are collected for all charts: higher number of seconds = lower frequency, the default is 1 for per second data collection). You can also set this frequency per module or chart. Check the [daemon configuration](/daemon/config/README.md) for plugins and charts. For specific modules, the configuration needs to be changed in:
- `python.d.conf` for [python](../collectors/python.d.plugin/#pythondplugin)
- `node.d.conf` for [nodejs](../collectors/node.d.plugin/#nodedplugin)
- `charts.d.conf` for [bash](../collectors/charts.d.plugin/#chartsdplugin)
- `python.d.conf` for [python](/collectors/python.d.plugin/README.md)
- `node.d.conf` for [nodejs](/collectors/node.d.plugin/README.md)
- `charts.d.conf` for [bash](/collectors/charts.d.plugin/README.md)
## Plugins
If a plugin is using a lot of CPU, you should lower its update frequency, or if you wrote it, re-factor it to be more CPU efficient. Check [External Plugins](../collectors/plugins.d/) for more details on writing plugins.
If a plugin is using a lot of CPU, you should lower its update frequency, or if you wrote it, re-factor it to be more CPU efficient. Check [External Plugins](/collectors/plugins.d/README.md) for more details on writing plugins.
## CPU consumption when web clients are accessing dashboards
@ -55,7 +55,7 @@ To lower the CPU utilization of Netdata when clients are accessing the dashboard
## Monitoring a heavily-loaded system
While running, Netdata does not depend much on disk I/O aside from writing to log files and the [database
engine](../database/engine/README.md) "spilling" historical metrics to disk when it uses all its available RAM.
engine](/database/engine/README.md) "spilling" historical metrics to disk when it uses all its available RAM.
Under a heavy system load, plugins that need disk may stop and show gaps during heavy system load, but the Netdata
daemon itself should be able to work and collect values from `/proc` and `/sys` and serve web clients accessing it.
@ -159,7 +159,7 @@ In this section you can select which modules of the `proc` plugin you need. All
...
```
Refer to the [proc.plugins documentation](../collectors/proc.plugin/) for the list and description of all the proc plugin modules.
Refer to the [proc.plugins documentation](/collectors/proc.plugin/README.md) for the list and description of all the proc plugin modules.
### 3. Lower internal plugin update frequency
@ -196,7 +196,7 @@ following settings in the `[global]` section of `netdata.conf`:
# dbengine disk space = 256
```
See the [database engine documentation](../database/engine/README.md) or our [tutorial on metrics
See the [database engine documentation](/database/engine/README.md) or our [tutorial on metrics
retention](tutorials/longer-metrics-storage.md) for more details on lowering the database engine's memory requirements.
### 6. Disable gzip compression of responses

2
docs/Running-behind-apache.md
View File

@ -354,7 +354,7 @@ If your apache server is not on localhost, you can set:
*note: Netdata v1.9+ support `allow connections from`*
`allow connections from` accepts [Netdata simple patterns](../libnetdata/simple_pattern/) to match against the connection IP address.
`allow connections from` accepts [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to match against the connection IP address.
## prevent the double access.log

7
docs/Running-behind-nginx.md
View File

@ -165,7 +165,9 @@ Using the above, you access Netdata on the backend servers, like this:
### Encrypt the communication between Nginx and Netdata
In case Netdata's web server has been [configured to use TLS](../web/server/#enabling-tls-support), it is necessary to specify inside the Nginx configuration that the final destination is using TLS. To do this, please, append the following parameters in your `nginx.conf`
In case Netdata's web server has been [configured to use TLS](/web/server/README.md#enabling-tls-support), it is
necessary to specify inside the Nginx configuration that the final destination is using TLS. To do this, please, append
the following parameters in your `nginx.conf`
```conf
proxy_set_header X-Forwarded-Proto https;
@ -238,7 +240,8 @@ If your Nginx server is not on localhost, you can set:
*note: Netdata v1.9+ support `allow connections from`*
`allow connections from` accepts [Netdata simple patterns](../libnetdata/simple_pattern/) to match against the connection IP address.
`allow connections from` accepts [Netdata simple patterns](/libnetdata/simple_pattern/README.md) to match against the
connection IP address.
## Prevent the double access.log

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