summaryrefslogtreecommitdiffstats
path: root/backends/mongodb/README.md
diff options
context:
space:
mode:
authorVladimir Kobal <vlad@prokk.net>2019-08-14 11:03:40 +0300
committerGitHub <noreply@github.com>2019-08-14 11:03:40 +0300
commit6262597923df989d4b9fc216f1645b006059da19 (patch)
tree8a82c7e0fe4a56120ef29ef96bd40f80685dba1c /backends/mongodb/README.md
parentf1285715cd6615ac94a3eb691ab346c9ef09ec56 (diff)
Add MongoDB backend (#6524)
* Add mongodb backend skeleton * Send data to the backend * Send metrics as separate JSON documents * Add a configuration file * Send all metrics in a batch * Update the documentation * Free configuration strings on exit * Make socket timeout configurable
Diffstat (limited to 'backends/mongodb/README.md')
-rw-r--r--backends/mongodb/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/backends/mongodb/README.md b/backends/mongodb/README.md
new file mode 100644
index 0000000000..fc26dfe10e
--- /dev/null
+++ b/backends/mongodb/README.md
@@ -0,0 +1,31 @@
+# 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.
+
+
+[![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%2Fmongodb%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()