diff options
Diffstat (limited to 'backends/mongodb/README.md')
| -rw-r--r-- | backends/mongodb/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/backends/mongodb/README.md b/backends/mongodb/README.md new file mode 100644 index 000000000..7538fe8be --- /dev/null +++ b/backends/mongodb/README.md @@ -0,0 +1,32 @@ +# MongoDB backend + +## Prerequisites + +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. + +## Configuration + +To enable data sending to the MongoDB backend set the following options in `netdata.conf`: + +``` +[backend] + enabled = yes + type = mongodb +``` + +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: + +``` +# URI +uri = mongodb://<hostname> + +# database name +database = your_database_name + +# collection name +collection = your_collection_name +``` + +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. + +[](<>) |