diff options
author | Joel Hans <joel@netdata.cloud> | 2020-06-02 11:08:39 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-02 11:08:39 -0700 |
commit | f3d762437a01d5f7d2d5829b9120a20ccb69ff97 (patch) | |
tree | 725a150037f934a20262d1c02ab39881e26ab3aa /exporting/README.md | |
parent | 57c916530c7ce9b7ca7905bfc06d676d34dd2f76 (diff) |
Add new exporting "home base" document (#9246)
* Init new export doc
* Touch of cleanup
* A few additional fixes
* Fix broken links
* Fix for Thiago
* Fixes for Vlad
Diffstat (limited to 'exporting/README.md')
-rw-r--r-- | exporting/README.md | 45 |
1 files changed, 25 insertions, 20 deletions
diff --git a/exporting/README.md b/exporting/README.md index 6802011039..ba2c51c357 100644 --- a/exporting/README.md +++ b/exporting/README.md @@ -1,25 +1,29 @@ <!-- -title: "Export metrics to external databases" +title: "Exporting engine reference" description: "With the exporting engine, you can archive your Netdata metrics to multiple external databases for long-term storage or further analysis." +sidebar_label: Reference guide custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/README.md --> -# Exporting metrics to external databases +# Exporting engine reference -The exporting engine is an update for the former [backends](/backends/README.md) which is deprecated and will be deleted -soon. It has a modular structure and supports metric exporting via multiple exporting connector instances at the same -time. You can have different update intervals and filters configured for every exporting connector instance. The -exporting engine has its own configuration file `exporting.conf`. Configuration is almost similar to -[backends](/backends/README.md#configuration). The most important difference is that type of a connector should be -specified in a section name before a colon and an instance name after the colon. Also, you can't use `host tags` -anymore. Set your labels using the [`[host labels]`](/docs/tutorials/using-host-labels.md) section in `netdata.conf`. +Welcome to the exporting engine reference guide. + +This guide contains comprehensive information about enabling, configuring, and monitoring Netdata's exporting engine, +which allows you to send metrics to more than 20 external time series databases. -# Metrics long term archiving +To learn the basics of locating and editing health configuration files, read up on [how to export +metrics](/docs/export/README.md), and follow the [exporting +quickstart](/docs/export/README.md#exporting-quickstart). -Netdata supports external databases and services for archiving the metrics, or providing long term dashboards, using -Grafana or other tools, like this: +The exporting engine is an update for the former [backends](/backends/README.md), which is deprecated and will be +deleted soon. It has a modular structure and supports metric exporting via multiple exporting connector instances at the +same time. You can have different update intervals and filters configured for every exporting connector instance. -![image](https://cloud.githubusercontent.com/assets/2662304/20649711/29f182ba-b4ce-11e6-97c8-ab2c0ab59833.png) +The exporting engine has its own configuration file `exporting.conf`. Configuration is almost similar to +[backends](/backends/README.md#configuration). The most important difference is that type of a connector should be +specified in a section name before a colon and an instance name after the colon. Also, you can't use `host tags` +anymore. Set your labels using the [`[host labels]`](/docs/tutorials/using-host-labels.md) section in `netdata.conf`. Since Netdata collects thousands of metrics per server per second, which would easily congest any database server when several Netdata servers are sending data to it, Netdata allows sending metrics at a lower frequency, by resampling them. @@ -27,7 +31,7 @@ several Netdata servers are sending data to it, Netdata allows sending metrics a So, although Netdata collects metrics every second, it can send to the external database servers averages or sums every X seconds (though, it can send them per second if you need it to). -## features +## Features 1. Supported databases and services @@ -104,7 +108,7 @@ X seconds (though, it can send them per second if you need it to). their batches at the same time. You can set different update intervals for every exporting connector instance, but even in that case they can occasionally synchronize their batches for a moment. -## configuration +## Configuration In `/etc/netdata/exporting.conf` you should have something like this: @@ -252,9 +256,10 @@ Options: > You can check how the host tags were parsed using the /api/v1/info API call. But, keep in mind that backends subsystem > is deprecated and will be deleted soon. Please move your existing tags to the `[host labels]` section. -## monitoring operation +## Exporting engine monitoring -Netdata provides 5 charts: +Netdata creates five charts in the dashboard, under the **Netdata Monitoring** section, to help you monitor the health +and performance of the exporting engine itself: 1. **Buffered metrics**, the number of metrics Netdata added to the buffer for dispatching them to the external database server. @@ -263,12 +268,12 @@ Netdata provides 5 charts: 3. **Exporting operations**, the number of operations performed by Netdata. -4. **Exporting thread CPU usage**, the CPU resources consumed by the Netdata thread, that is responsible for sending the - metrics to the external database server. +4. **Exporting thread CPU usage**, the CPU resources consumed by the Netdata thread, that is responsible for sending + the metrics to the external database server. ![image](https://cloud.githubusercontent.com/assets/2662304/20463536/eb196084-af3d-11e6-8ee5-ddbd3b4d8449.png) -## alarms +## Exporting engine alarms Netdata adds 3 alarms: |