summaryrefslogtreecommitdiffstats
path: root/backends/opentsdb/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'backends/opentsdb/README.md')
-rw-r--r--backends/opentsdb/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/backends/opentsdb/README.md b/backends/opentsdb/README.md
new file mode 100644
index 00000000..ab1f08bd
--- /dev/null
+++ b/backends/opentsdb/README.md
@@ -0,0 +1,25 @@
+# OpenTSDB with HTTP
+
+Netdata can easily communicate with OpenTSDB using HTTP API. To enable this channel, set the following options in your `netdata.conf`:
+
+```
+[backend]
+ type = opentsdb:http
+ destination = localhost:4242
+```
+
+In this example, OpenTSDB is running with its default port, which is `4242`. If you run OpenTSDB on a different port, change the `destination = localhost:4242` line accordingly.
+
+## HTTPS
+
+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).
+
+After your proxy is configured, make the following changes to `netdata.conf`:
+
+```
+[backend]
+ type = opentsdb:https
+ destination = localhost:8082
+```
+
+In this example, we used the port `8082` for our reverse proxy. If your reverse proxy listens on a different port, change the `destination = localhost:8082` line accordingly.