diff options
Diffstat (limited to 'docs/export')
| -rw-r--r-- | docs/export/enable-connector.md | 50 | ||||
| -rw-r--r-- | docs/export/external-databases.md | 98 |
2 files changed, 81 insertions, 67 deletions
diff --git a/docs/export/enable-connector.md b/docs/export/enable-connector.md index a914a114a..28208e2f4 100644 --- a/docs/export/enable-connector.md +++ b/docs/export/enable-connector.md @@ -1,25 +1,31 @@ <!-- title: "Enable an exporting connector" description: "Learn how to enable and configure any connector using examples to start exporting metrics to external time-series databases in minutes." -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/export/enable-connector.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/export/enable-connector.md" +sidebar_label: "Enable an exporting connector" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup" --> # Enable an exporting connector Now that you found the right connector for your [external time-series -database](/docs/export/external-databases.md#supported-databases), you can now enable the exporting engine and the +database](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md#supported-databases), you can now enable the exporting engine and the connector itself. We'll walk through the process of enabling the exporting engine itself, followed by two examples using the OpenTSDB and Graphite connectors. > When you enable the exporting engine and a connector, the Netdata Agent exports metrics _beginning from the time you -> restart its process_, not the entire [database of long-term metrics](/docs/store/change-metrics-storage.md). +> restart its process_, not the entire +> [database of long-term metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md). Once you understand the process of enabling a connector, you can translate that knowledge to any other connector. ## Enable the exporting engine -Use `edit-config` from your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) to open -`exporting.conf`: +Use `edit-config` from your +[Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) +to open `exporting.conf`: ```bash sudo ./edit-config exporting.conf @@ -47,14 +53,16 @@ Use the following configuration as a starting point. Copy and paste it into `exp Replace `my_opentsdb_http_instance` with an instance name of your choice, and change the `destination` setting to the IP address or hostname of your OpenTSDB database. -Restart your Agent with `sudo systemctl restart netdata`, or the [appropriate -method](/docs/configure/start-stop-restart.md) for your system, to begin exporting to your OpenTSDB database. The +Restart your Agent with `sudo systemctl restart netdata`, or +the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin exporting to your OpenTSDB +database. The Netdata Agent exports metrics _beginning from the time the process starts_, and because it exports as metrics are collected, you should start seeing data in your external database after only a few seconds. Any further configuration is optional, based on your needs and the configuration of your OpenTSDB database. See the -[OpenTSDB connector doc](/exporting/opentsdb/README.md) and [exporting engine -reference](/exporting/README.md#configuration) for details. +[OpenTSDB connector doc](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md) +and [exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md#configuration) for +details. ## Example: Enable the Graphite connector @@ -69,27 +77,29 @@ Use the following configuration as a starting point. Copy and paste it into `exp Replace `my_graphite_instance` with an instance name of your choice, and change the `destination` setting to the IP address or hostname of your Graphite-supported database. -Restart your Agent with `sudo systemctl restart netdata`, or the [appropriate -method](/docs/configure/start-stop-restart.md) for your system, to begin exporting to your Graphite-supported database. +Restart your Agent with `sudo systemctl restart netdata`, or +the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system, to begin exporting to your +Graphite-supported database. Because the Agent exports metrics as they're collected, you should start seeing data in your external database after only a few seconds. Any further configuration is optional, based on your needs and the configuration of your Graphite-supported database. -See [exporting engine reference](/exporting/README.md#configuration) for details. +See [exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md#configuration) for +details. ## What's next? -If you want to further configure your exporting connectors, see the [exporting engine -reference](/exporting/README.md#configuration). +If you want to further configure your exporting connectors, see +the [exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md#configuration). -For a comprehensive example of using the Graphite connector, read our guide: [_Export and visualize Netdata metrics in -Graphite_](/docs/guides/export/export-netdata-metrics-graphite.md). Or, start [using host -labels](/docs/guides/using-host-labels.md) on exported metrics. +For a comprehensive example of using the Graphite connector, read our guide: +[_Export and visualize Netdata metrics in Graphite_](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md). Or, start +[using host labels](https://github.com/netdata/netdata/blob/master/docs/guides/using-host-labels.md) on exported metrics. ### Related reference documentation -- [Exporting engine reference](/exporting/README.md) -- [OpenTSDB connector](/exporting/opentsdb/README.md) -- [Graphite connector](/exporting/graphite/README.md) +- [Exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md) +- [OpenTSDB connector](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md) +- [Graphite connector](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md) diff --git a/docs/export/external-databases.md b/docs/export/external-databases.md index a542e8ee7..00ca7410e 100644 --- a/docs/export/external-databases.md +++ b/docs/export/external-databases.md @@ -1,13 +1,17 @@ <!-- title: "Export metrics to external time-series databases" description: "Use the exporting engine to send Netdata metrics to popular external time series databases for long-term storage or further analysis." -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/export/external-databases.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/export/external-databases.md" +sidebar_label: "Export metrics to external time-series databases" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Concepts" --> # Export metrics to external time-series databases Netdata allows you to export metrics to external time-series databases with the [exporting -engine](/exporting/README.md). This system uses a number of **connectors** to initiate connections to [more than +engine](https://github.com/netdata/netdata/blob/master/exporting/README.md). This system uses a number of **connectors** to initiate connections to [more than thirty](#supported-databases) supported databases, including InfluxDB, Prometheus, Graphite, ElasticSearch, and much more. @@ -18,55 +22,55 @@ Based on your needs and resources you allocated to your external time-series dat that metrics are exported or export only certain charts with filtering. You can also choose whether metrics are exported as-collected, a normalized average, or the sum/volume of metrics values over the configured interval. -Exporting is an important part of Netdata's effort to be [interoperable](/docs/overview/netdata-monitoring-stack.md) +Exporting is an important part of Netdata's effort to be [interoperable](https://github.com/netdata/netdata/blob/master/docs/overview/netdata-monitoring-stack.md) with other monitoring software. You can use an external time-series database for long-term metrics retention, further analysis, or correlation with other tools, such as application tracing. ## Supported databases Netdata supports exporting metrics to the following databases through several -[connectors](/exporting/README.md#features). Once you find the connector that works for your database, open its -documentation and the [enabling a connector](/docs/export/enable-connector.md) doc for details on enabling it. - -- **AppOptics**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **AWS Kinesis**: [AWS Kinesis Data Streams](/exporting/aws_kinesis/README.md) -- **Azure Data Explorer**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Azure Event Hubs**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Blueflood**: [Graphite](/exporting/graphite/README.md) -- **Chronix**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Cortex**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **CrateDB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **ElasticSearch**: [Graphite](/exporting/graphite/README.md), [Prometheus remote - write](/exporting/prometheus/remote_write/README.md) -- **Gnocchi**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Google BigQuery**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Google Cloud Pub/Sub**: [Google Cloud Pub/Sub Service](/exporting/pubsub/README.md) -- **Graphite**: [Graphite](/exporting/graphite/README.md), [Prometheus remote - write](/exporting/prometheus/remote_write/README.md) -- **InfluxDB**: [Graphite](/exporting/graphite/README.md), [Prometheus remote - write](/exporting/prometheus/remote_write/README.md) -- **IRONdb**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **JSON**: [JSON document databases](/exporting/json/README.md) -- **Kafka**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **KairosDB**: [Graphite](/exporting/graphite/README.md), [OpenTSDB](/exporting/opentsdb/README.md) -- **M3DB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **MetricFire**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **MongoDB**: [MongoDB](/exporting/mongodb/README.md) -- **New Relic**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **OpenTSDB**: [OpenTSDB](/exporting/opentsdb/README.md), [Prometheus remote - write](/exporting/prometheus/remote_write/README.md) -- **PostgreSQL**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) +[connectors](https://github.com/netdata/netdata/blob/master/exporting/README.md#features). Once you find the connector that works for your database, open its +documentation and the [enabling a connector](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md) doc for details on enabling it. + +- **AppOptics**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **AWS Kinesis**: [AWS Kinesis Data Streams](https://github.com/netdata/netdata/blob/master/exporting/aws_kinesis/README.md) +- **Azure Data Explorer**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Azure Event Hubs**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Blueflood**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md) +- **Chronix**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Cortex**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **CrateDB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **ElasticSearch**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [Prometheus remote + write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Gnocchi**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Google BigQuery**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Google Cloud Pub/Sub**: [Google Cloud Pub/Sub Service](https://github.com/netdata/netdata/blob/master/exporting/pubsub/README.md) +- **Graphite**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [Prometheus remote + write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **InfluxDB**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [Prometheus remote + write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **IRONdb**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **JSON**: [JSON document databases](https://github.com/netdata/netdata/blob/master/exporting/json/README.md) +- **Kafka**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **KairosDB**: [Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md), [OpenTSDB](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md) +- **M3DB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **MetricFire**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **MongoDB**: [MongoDB](https://github.com/netdata/netdata/blob/master/exporting/mongodb/README.md) +- **New Relic**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **OpenTSDB**: [OpenTSDB](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md), [Prometheus remote + write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **PostgreSQL**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) via [PostgreSQL Prometheus Adapter](https://github.com/CrunchyData/postgresql-prometheus-adapter) -- **Prometheus**: [Prometheus scraper](/exporting/prometheus/README.md) -- **TimescaleDB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md), - [netdata-timescale-relay](/exporting/TIMESCALE.md) -- **QuasarDB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **SignalFx**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Splunk**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **TiKV**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Thanos**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **VictoriaMetrics**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) -- **Wavefront**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md) +- **Prometheus**: [Prometheus scraper](https://github.com/netdata/netdata/blob/master/exporting/prometheus/README.md) +- **TimescaleDB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md), + [netdata-timescale-relay](https://github.com/netdata/netdata/blob/master/exporting/TIMESCALE.md) +- **QuasarDB**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **SignalFx**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Splunk**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **TiKV**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Thanos**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **VictoriaMetrics**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) +- **Wavefront**: [Prometheus remote write](https://github.com/netdata/netdata/blob/master/exporting/prometheus/remote_write/README.md) Can't find your preferred external time-series database? Ask our [community](https://community.netdata.cloud/) for solutions, or file an [issue on @@ -74,16 +78,16 @@ GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cne ## What's next? -We recommend you read our document on [enabling a connector](/docs/export/enable-connector.md) to learn about the +We recommend you read our document on [enabling a connector](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md) to learn about the process and discover important configuration options. If you would rather skip ahead, click on any of the above links to connectors for their reference documentation, which outline any prerequisites to install for that connector, along with connector-specific configuration options. Read about one possible use case for exporting metrics in our guide: [_Export and visualize Netdata metrics in -Graphite_](/docs/guides/export/export-netdata-metrics-graphite.md). +Graphite_](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md). ### Related reference documentation -- [Exporting engine reference](/exporting/README.md) +- [Exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md) |