Update enable-an-exporting-connector.md (#17943)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
Jun 18, 2024 at 10:25 UTC
14b79967b3a63a3f6aacc1d42142c8c4abb78883
1 file changed
+7
-59
docs/exporting-metrics/enable-an-exporting-connector.md
+7
-59
@@ -5,21 +5,17 @@ database](/docs/exporting-metrics/README.md#supported-databases), you can now en
5
connector itself. We'll walk through the process of enabling the exporting engine itself, followed by two examples using
6
the OpenTSDB and Graphite connectors.
7
8
+> **Note**
9
+>
10
> When you enable the exporting engine and a connector, the Netdata Agent exports metrics _beginning from the time you
11
> restart its process_, not the entire
12
> [database of long-term metrics](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md).
13
12
-Once you understand the process of enabling a connector, you can translate that knowledge to any other connector.
14
+Once you understand how to enable a connector, you can apply that knowledge to any other connector.
15
16
## Enable the exporting engine
17
16
-Use `edit-config` from your
17
-[Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory)
18
-to open `exporting.conf`:
19
-
20
-```bash
21
-sudo ./edit-config exporting.conf
22
-```
18
+Use `edit-config` from your [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory) to edit `exporting.conf`.
19
20
Enable the exporting engine itself by setting `enabled` to `yes`:
21
@@ -40,56 +36,8 @@ Use the following configuration as a starting point. Copy and paste it into `exp
36
destination = localhost:4242
37
```
38
43
-Replace `my_opentsdb_http_instance` with an instance name of your choice, and change the `destination` setting to the IP
44
-address or hostname of your OpenTSDB database.
45
-
46
-Restart your Agent with `sudo systemctl restart netdata`, or
47
-the [appropriate method](/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to begin exporting to your OpenTSDB
48
-database. The
49
-Netdata Agent exports metrics _beginning from the time the process starts_, and because it exports as metrics are
50
-collected, you should start seeing data in your external database after only a few seconds.
51
-
52
-Any further configuration is optional, based on your needs and the configuration of your OpenTSDB database. See the
53
-[OpenTSDB connector doc](/src/exporting/opentsdb/README.md)
54
-and [exporting engine reference](/src/exporting/README.md#configuration) for
55
-details.
56
-
57
-## Example: Enable the Graphite connector
58
-
59
-Use the following configuration as a starting point. Copy and paste it into `exporting.conf`.
60
-
61
-```conf
62
-[graphite:my_graphite_instance]
63
- enabled = yes
64
- destination = 203.0.113.0:2003
65
-```
66
-
67
-Replace `my_graphite_instance` with an instance name of your choice, and change the `destination` setting to the IP
68
-address or hostname of your Graphite-supported database.
69
-
70
-Restart your Agent with `sudo systemctl restart netdata`, or
71
-the [appropriate method](/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system, to begin exporting to your
72
-Graphite-supported database.
73
-Because the Agent exports metrics as they're collected, you should start seeing data in your external database after
74
-only a few seconds.
75
-
76
-Any further configuration is optional, based on your needs and the configuration of your Graphite-supported database.
77
-See [exporting engine reference](/src/exporting/README.md#configuration) for
78
-details.
79
-
80
-## What's next?
81
-
82
-If you want to further configure your exporting connectors, see
83
-the [exporting engine reference](/src/exporting/README.md#configuration).
84
-
85
-For a comprehensive example of using the Graphite connector, read our documentation on
86
-[exporting metrics to Graphite providers](/src/exporting/graphite/README.md). Or, start
87
-[using host labels](/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md) on exported metrics.
88
-
89
-### Related reference documentation
90
-
91
-- [Exporting engine reference](/src/exporting/README.md)
92
-- [OpenTSDB connector](/src/exporting/opentsdb/README.md)
93
-- [Graphite connector](/src/exporting/graphite/README.md)
39
+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.
40
41
+[Restart your Agent](/docs/netdata-agent/start-stop-restart.md) to initiate exporting to your OpenTSDB database. The Netdata Agent continuously exports metrics collected from the moment it starts. You can expect to see data appear in your OpenTSDB database within seconds of restarting the Agent.
42
43
+Any further configuration is optional, based on your needs and the configuration of your OpenTSDB database. See the [OpenTSDB connector doc](/src/exporting/opentsdb/README.md) and [exporting engine reference](/src/exporting/README.md#configuration) for details.