summaryrefslogtreecommitdiffstats
path: root/backends/opentsdb/README.md
diff options
context:
space:
mode:
authorPromise Akpan <akpanpromise@hotmail.com>2019-10-03 18:21:37 +0100
committerJoel Hans <joel@netdata.cloud>2019-10-03 10:21:37 -0700
commit5d7b0043d5a0196e2eeb79bd68a65f9ff7a54630 (patch)
tree290392ed503405dba707804a14e0361a442c3e49 /backends/opentsdb/README.md
parent2701913e93424d58fb4ec3d07af37b5d39fe66f2 (diff)
Fix Remark Lint Warnings for Backends (#6917)
* fix remark warnings for AWS Kinesis doc * fix remark warnings for MongoDB * fix remark warnings on OpenTSDB doc * fix lint warnings on prometheus docs * format prometheus page * fix main backend readme * fix remark warnings except local links * remove slash in prometheus doc * remove link to header to fix lint error * make character limit to 120 not 80
Diffstat (limited to 'backends/opentsdb/README.md')
-rw-r--r--backends/opentsdb/README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/backends/opentsdb/README.md b/backends/opentsdb/README.md
index ab1f08bd3a..5c04868c1f 100644
--- a/backends/opentsdb/README.md
+++ b/backends/opentsdb/README.md
@@ -1,25 +1,31 @@
# OpenTSDB with HTTP
-Netdata can easily communicate with OpenTSDB using HTTP API. To enable this channel, set the following options in your `netdata.conf`:
+Netdata can easily communicate with OpenTSDB using HTTP API. To enable this channel, set the following options in your
+`netdata.conf`:
-```
+```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.
+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).
+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`:
-```
+```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.
+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.