diff options
| author | Joel Hans <joel@netdata.cloud> | 2020-09-29 10:57:52 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-29 10:57:52 -0700 |
| commit | 61d7e23eed0503bf591274df70713970213b5c7f (patch) | |
| tree | 125879ff5f780c2937ee206fc510d89e9a91a868 /docs/export/README.md | |
| parent | e3b04fb39a06991d9a2deed0488044dd7d340e3f (diff) | |
Add docsv2 project to master branch (#10000)
* Add overview docs to docsv2 project
* Add quickstart docs to docsv2 project (#9865)
* Init quickstart docs
* Begin work on quickstart guides
* Finish quickstart drafts
* Tweaks to both quickstarts
* Add titles
* Copyedit pass to both docs
* Fixes for Amy and Jen
* Add Get doc to docsv2 project (#9854)
* Init get file
* Add some links
* Change h2 to h1
* Rephrase
* Add configure docs to docsv2 project (#9878)
* Add overview docs to docsv2 project (#9849)
* Init files
* Add drafts of what and why
* Finish initial drafts
* Fix edit URL
* Copyedit pass
* Finish initial drafts of configure docs
* Copyedit all docs
* Fixes for Amy
* Fixes for Jen
* Add collect docs to the docsv2 project (#9932)
* Init files
* Finish first two collect docs
* Finish drafts of collect docs
* Copyedit pass
* Fixes for Amy
* Fix for Jen
* Add visualize docs to the docsv2 project (#9943)
* Add visualize docs
* Copyedits and cleanup
* New images and features
* Copyedit pass and cleanup
* Missing word
* Fixes for Jen
* Add monitor docs to docsv2 project (#9949)
* Finish drafts of monitor docs
* Copyedit pass
* Remove whitespace
* Fixes for Jen
* Add store docs to docsv2 project (#9969)
* Finalize store documents
* Fix import path
* Finishing edit section
* Copyedit pass
* Add export docs to docsv2 project (#9986)
* Add install and claim videos to Get doc
* Finish drafts of exporting docs plus other tweaks
* Init new exporting READMEs
* Copyedit pass and new links
* Fixes for Amy, Vlad, Jen
* Fix links in docsv2 project (#9993)
* Fix links
* Fix a bunch of links ahead of export merge
* Fix additional links
* Fix links, nuke what-is-netdata
* Fixing a few last links
* Improve product images in overview
* Remove extra paren
* Quick tweaks for Jen
* Fixes for Jen
* Access fix
* Remove extra word
Diffstat (limited to 'docs/export/README.md')
| -rw-r--r-- | docs/export/README.md | 101 |
1 files changed, 0 insertions, 101 deletions
diff --git a/docs/export/README.md b/docs/export/README.md deleted file mode 100644 index 03d642e1b0..0000000000 --- a/docs/export/README.md +++ /dev/null @@ -1,101 +0,0 @@ -<!-- -title: Export metrics -description: "Archive your Netdata metrics to multiple external time series databases for long-term storage or further analysis." -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/export/README.md ---> - -# Export metrics - -One of Netdata's pillars is interoperability with other monitoring and visualization solutions. To this end, you can use -the Agent's [exporting engine](/exporting/README.md) to send metrics to multiple external databases/services in -parallel. Once you connect Netdata metrics to other solutions, you can apply machine learning analysis or correlation -with other tools, such as application tracing. - -The exporting engine supports a number of connectors, including AWS Kinesis Data Streams, Graphite, JSON, MongoDB, -OpenTSDB, Prometheus remote write, and more, via exporting **connectors**. These connectors help you seamlessly send -Netdata metrics to more than 20 different endpoints, including every [service that -supports](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage) Prometheus remote write. See -the [exporting reference guide](/exporting/README.md) for the full list. - -## Exporting quickstart - -Let's cover the process of enabling an exporting connector, using the Graphite connector as an example. These steps can -be applied to other connectors as well. - -> If you are migrating from the deprecated backends system, this quickstart will also help you update your configuration -> to the new format. For the most part, the configurations are identical, but there are two exceptions. First, -> `exporting.conf` uses a new `[<type>:<name>]` format for defining connector instances. Second, the `host tags` setting -> is deprecated. Instead, use [host labels](/docs/guides/using-host-labels.md) to tag exported metrics. - -Open the `exporting.conf` file with `edit-config`. - -```bash -cd /etc/netdata # Replace this path with your Netdata config directory -sudo ./edit-config exporting.conf -``` - -### Enable the exporting engine - -Enable the exporting engine by setting `enabled` to `yes`: - -```conf -[exporting:global] - enabled = yes -``` - -### Change how often the exporting engine sends metrics - -By default, the exporting engine only sends metrics to external databases every 10 seconds to avoid congesting the -destination with thousands of per-second metrics. - -You can change this frequency for all connectors based on how you use exported metrics or the resources you can allocate -to long-term storage. Use the `update every` setting to change the frequency in seconds. - -```conf -[exporting:global] - update every = 10 -``` - -### Enable a connector (Graphite) - -To enable the Graphite connector, find the `[graphite:my_graphite_instance]` example section in `exporting.conf`. You -can use this (or the respective example for the connector you want to use) as a framework for your configration. - -`[graphite:my_graphite_instance]` is an example of the new `[<type>:<name>]` format for defining connector instances. - -Uncomment the section itself and replace `my_graphite_instance` with a name of your choice. Then set `enabled` to `yes` -and uncomment the line. - -```conf -[graphite:my_graphite_instance] - enabled = yes - # destination = localhost:2003 - # data source = average - # prefix = netdata - # hostname = my_hostname - # update every = 10 - # buffer on failures = 10 - # timeout ms = 20000 - # send names instead of ids = yes - # send charts matching = * - # send hosts matching = localhost * -``` - -Next, edit and uncomment any other lines necessary to connect the exporting engine to your endpoint. If migrating from -backends, port your settings over and uncomment any lines you change. You must edit the `destination` setting in most -situations. - -For details on all the configuration options, see the [exporting reference](/exporting/README.md#configuration). - -Restart your Agent to begin exporting to the destination of your choice. Because the Agent exports metrics as they're -collected, you should start seeing data in your external database after only a few seconds. - -## Exporting reference, guides, and related features - -- [Exporting reference guide](/exporting/README.md) -- [Guide: Export and visualize Netdata metrics in Graphite](/docs/guides/export/export-netdata-metrics-graphite.md) -- [Guide: Use host labels to organize systems, metrics, and alarms](/docs/guides/using-host-labels.md) -- [Guide: Change how long Netdata stores metrics (long-term storage)](/docs/guides/longer-metrics-storage.md) -- [Backends (deprecated)](/backends/README.md) - -[](<>) |