summaryrefslogtreecommitdiffstats
path: root/backends/aws_kinesis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'backends/aws_kinesis/README.md')
-rw-r--r--backends/aws_kinesis/README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/backends/aws_kinesis/README.md b/backends/aws_kinesis/README.md
index b5726d2dbd..a6529f237f 100644
--- a/backends/aws_kinesis/README.md
+++ b/backends/aws_kinesis/README.md
@@ -13,15 +13,18 @@ cmake -DCMAKE_INSTALL_LIBDIR=/usr/lib -DCMAKE_INSTALL_INCLUDEDIR=/usr/include -D
## Configuration
To enable data sending to the kinesis backend set the following options in `netdata.conf`:
+
```
[backend]
enabled = yes
type = kinesis
destination = us-east-1
```
+
set the `destination` option to an AWS region.
In the Netdata configuration directory run `./edit-config aws_kinesis.conf` and set AWS credentials and stream name:
+
```
# AWS credentials
aws_access_key_id = your_access_key_id
@@ -30,9 +33,9 @@ aws_secret_access_key = your_secret_access_key
# destination stream
stream name = your_stream_name
```
+
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).
A partition key for every record is computed automatically by Netdata with the purpose to distribute records across available shards evenly.
-
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fbackends%2Faws_kinesis%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fbackends%2Faws_kinesis%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)