diff options
author | Joel Hans <joel@netdata.cloud> | 2020-04-14 10:26:13 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-04-14 10:26:13 -0700 |
commit | e99692f145f710930723081d2e5bbf8868be2080 (patch) | |
tree | 468157463f0f133d927019e6826a9559dd989b9b /backends | |
parent | 59916b01b83026d6e6caf59f4efb67b7d428b70d (diff) |
Docs: Standardize links between documentation (#8638)
* Trying out some absolute-ish links
* Try one out on installer
* Testing logic
* Trying out some more links
* Fixing links
* Fix links in python collectors
* Changed a bunch more links
* Fix build errors
* Another push of links
* Fix build error and add more links
* Complete first pass
* Fix final broken links
* Fix links to files
* Fix for Netlify
* Two more fixes
Diffstat (limited to 'backends')
-rw-r--r-- | backends/README.md | 15 | ||||
-rw-r--r-- | backends/opentsdb/README.md | 2 | ||||
-rw-r--r-- | backends/prometheus/README.md | 2 |
3 files changed, 9 insertions, 10 deletions
diff --git a/backends/README.md b/backends/README.md index 3b0035fdc0..10571bbb3f 100644 --- a/backends/README.md +++ b/backends/README.md @@ -36,7 +36,8 @@ So, although Netdata collects metrics every second, it can send to the backend s metrics are sent to a document db, `JSON` formatted. - - **prometheus** is described at [prometheus page](prometheus/) since it pulls data from Netdata. + - **prometheus** is described at [prometheus page](/backends/prometheus/README.md) since it pulls data from + Netdata. - **prometheus remote write** (a binary snappy-compressed protocol buffer encoding over HTTP used by **Elasticsearch**, **Gnocchi**, **Graphite**, **InfluxDB**, **Kafka**, **OpenTSDB**, **PostgreSQL/TimescaleDB**, @@ -44,10 +45,10 @@ So, although Netdata collects metrics every second, it can send to the backend s providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage)) metrics are labeled in the format, which is used by Netdata for the [plaintext prometheus - protocol](prometheus/). Notes on using the remote write backend are [here](prometheus/remote_write/). + protocol](/backends/prometheus/README.md). Notes on using the remote write backend are [here](/backends/prometheus/remote_write/README.md). - - **TimescaleDB** via [community-built connector](TIMESCALE.md) that takes JSON streams from a Netdata client - and writes them to a TimescaleDB table. + - **TimescaleDB** via [community-built connector](/backends/TIMESCALE.md) that takes JSON streams from a Netdata + client and writes them to a TimescaleDB table. - **AWS Kinesis Data Streams** @@ -143,14 +144,14 @@ from your Netdata): When multiple servers are defined, Netdata will try the next one when the first one fails. This allows you to load-balance different servers: give your backend servers in different order on each Netdata. - Netdata also ships [`nc-backend.sh`](nc-backend.sh), a script that can be used as a fallback backend to save the + Netdata also ships `nc-backend.sh`, a script that can be used as a fallback backend to save the metrics to disk and push them to the time-series database when it becomes available again. It can also be used to monitor / trace / debug the metrics Netdata generates. For kinesis backend `destination` should be set to an AWS region (for example, `us-east-1`). The MongoDB backend doesn't use the `destination` option for its configuration. It uses the `mongodb.conf` - [configuration file](../backends/mongodb/) instead. + [configuration file](/backends/mongodb/README.md) instead. - `data source = as collected`, or `data source = average`, or `data source = sum`, selects the kind of data that will be sent to the backend. @@ -222,8 +223,6 @@ Netdata provides 5 charts: ## alarms -The latest version of the alarms configuration for monitoring the backend is [here](../health/health.d/backend.conf) - Netdata adds 4 alarms: 1. `backend_last_buffering`, number of seconds since the last successful buffering of backend data diff --git a/backends/opentsdb/README.md b/backends/opentsdb/README.md index 2b470f55e2..20abce88c0 100644 --- a/backends/opentsdb/README.md +++ b/backends/opentsdb/README.md @@ -24,7 +24,7 @@ change the `destination = localhost:4242` line accordingly. 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). +[Nginx](/docs/Running-behind-nginx.md). After your proxy is configured, make the following changes to `netdata.conf`: diff --git a/backends/prometheus/README.md b/backends/prometheus/README.md index b6068fdfcc..4f96770257 100644 --- a/backends/prometheus/README.md +++ b/backends/prometheus/README.md @@ -19,7 +19,7 @@ are starting at a fresh ubuntu shell (whether you'd like to follow along in a VM ### Installing Netdata -There are number of ways to install Netdata according to [Installation](../../packaging/installer/). The suggested way +There are number of ways to install Netdata according to [Installation](/packaging/installer/README.md). The suggested way of installing the latest Netdata and keep it upgrade automatically. Using one line installation: ```sh |