You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix Remark Lint Warnings for Backends (netdata#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
Copy file name to clipboardExpand all lines: backends/aws_kinesis/README.md
+14-7Lines changed: 14 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,25 @@
2
2
3
3
## Prerequisites
4
4
5
-
To use AWS Kinesis as a backend AWS SDK for C++ should be [installed](https://docs.aws.amazon.com/en_us/sdk-for-cpp/v1/developer-guide/setup.html) first. `libcrypto`, `libssl`, and `libcurl` are also required to compile Netdata with Kinesis support enabled. Next, Netdata should be re-installed from the source. The installer will detect that the required libraries are now available.
5
+
To use AWS Kinesis as a backend AWS SDK for C++ should be
and `libcurl` are also required to compile Netdata with Kinesis support enabled. Next, Netdata should be re-installed
8
+
from the source. The installer will detect that the required libraries are now available.
6
9
7
-
If the AWS SDK for C++ is being installed from source, it is useful to set `-DBUILD_ONLY="kinesis"`. Otherwise, the building process could take a very long time. Take a note, that the default installation path for the libraries is `/usr/local/lib64`. Many Linux distributions don't include this path as the default one for a library search, so it is advisable to use the following options to `cmake` while building the AWS SDK:
10
+
If the AWS SDK for C++ is being installed from source, it is useful to set `-DBUILD_ONLY="kinesis"`. Otherwise, the
11
+
building process could take a very long time. Take a note, that the default installation path for the libraries is
12
+
`/usr/local/lib64`. Many Linux distributions don't include this path as the default one for a library search, so it is
13
+
advisable to use the following options to `cmake` while building the AWS SDK:
Alternatively, AWS credentials can be set for the *netdata* user using AWS SDK for C++ [standard methods](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/credentials.html).
43
+
Alternatively, AWS credentials can be set for the `netdata` user using AWS SDK for C++ [standard methods](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/credentials.html).
38
44
39
-
A partition key for every record is computed automatically by Netdata with the purpose to distribute records across available shards evenly.
45
+
A partition key for every record is computed automatically by Netdata with the purpose to distribute records across
Copy file name to clipboardExpand all lines: backends/mongodb/README.md
+9-5Lines changed: 9 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -2,21 +2,24 @@
2
2
3
3
## Prerequisites
4
4
5
-
To use MongoDB as a backend, `libmongoc` 1.7.0 or higher should be [installed](http://mongoc.org/libmongoc/current/installing.html) first. Next, Netdata should be re-installed from the source. The installer will detect that the required libraries are now available.
5
+
To use MongoDB as a backend, `libmongoc` 1.7.0 or higher should be
6
+
[installed](http://mongoc.org/libmongoc/current/installing.html) first. Next, Netdata should be re-installed from the
7
+
source. The installer will detect that the required libraries are now available.
6
8
7
9
## Configuration
8
10
9
11
To enable data sending to the MongoDB backend set the following options in `netdata.conf`:
10
12
11
-
```
13
+
```conf
12
14
[backend]
13
15
enabled = yes
14
16
type = mongodb
15
17
```
16
18
17
-
In the Netdata configuration directory run `./edit-config mongodb.conf` and set [MongoDB URI](https://docs.mongodb.com/manual/reference/connection-string/), database name, and collection name:
19
+
In the Netdata configuration directory run `./edit-config mongodb.conf` and set [MongoDB
20
+
URI](https://docs.mongodb.com/manual/reference/connection-string/), database name, and collection name:
18
21
19
-
```
22
+
```yaml
20
23
# URI
21
24
uri = mongodb://<hostname>
22
25
@@ -27,6 +30,7 @@ database = your_database_name
27
30
collection = your_collection_name
28
31
```
29
32
30
-
The default socket timeout depends on the backend update interval. The timeout is 500 ms shorter than the interval (but not less than 1000 ms). You can alter the timeout using the `sockettimeoutms` MongoDB URI option.
33
+
The default socket timeout depends on the backend update interval. The timeout is 500 ms shorter than the interval (but
34
+
not less than 1000 ms). You can alter the timeout using the `sockettimeoutms` MongoDB URI option.
Netdata can easily communicate with OpenTSDB using HTTP API. To enable this channel, set the following options in your `netdata.conf`:
3
+
Netdata can easily communicate with OpenTSDB using HTTP API. To enable this channel, set the following options in your
4
+
`netdata.conf`:
4
5
5
-
```
6
+
```conf
6
7
[backend]
7
8
type = opentsdb:http
8
9
destination = localhost:4242
9
10
```
10
11
11
-
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.
12
+
In this example, OpenTSDB is running with its default port, which is `4242`. If you run OpenTSDB on a different port,
13
+
change the `destination = localhost:4242` line accordingly.
12
14
13
15
## HTTPS
14
16
15
-
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).
17
+
As of [v1.16.0](https://github.com/netdata/netdata/releases/tag/v1.16.0), Netdata can send metrics to OpenTSDB using
18
+
TLS/SSL. Unfortunately, OpenTDSB does not support encrypted connections, so you will have to configure a reverse proxy
19
+
to enable HTTPS communication between Netdata and OpenTSBD. You can set up a reverse proxy with
20
+
[Nginx](../../docs/Running-behind-nginx.md).
16
21
17
22
After your proxy is configured, make the following changes to `netdata.conf`:
18
23
19
-
```
24
+
```conf
20
25
[backend]
21
26
type = opentsdb:https
22
27
destination = localhost:8082
23
28
```
24
29
25
-
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.
30
+
In this example, we used the port `8082` for our reverse proxy. If your reverse proxy listens on a different port,
31
+
change the `destination = localhost:8082` line accordingly.
0 commit comments