summaryrefslogtreecommitdiffstats
path: root/exporting/json/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'exporting/json/README.md')
-rw-r--r--exporting/json/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/exporting/json/README.md b/exporting/json/README.md
new file mode 100644
index 0000000..d129ffb
--- /dev/null
+++ b/exporting/json/README.md
@@ -0,0 +1,35 @@
+<!--
+title: "Export metrics to JSON document databases"
+description: "Archive your Agent's metrics to a JSON document database for long-term storage, further analysis, or correlation with data from other sources."
+custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/json/README.md
+sidebar_label: JSON Document Databases
+-->
+
+# Export metrics to JSON document databases
+
+You can use the JSON connector for the [exporting engine](/exporting/README.md) to archive your agent's metrics to JSON
+document databases for long-term storage, further analysis, or correlation with data from other sources.
+
+## Configuration
+
+To enable data exporting to a JSON document database, run `./edit-config exporting.conf` in the Netdata configuration
+directory and set the following options:
+
+```conf
+[json:my_json_instance]
+ enabled = yes
+ destination = localhost:5448
+```
+
+Add `:http` or `:https` modifiers to the connector type if you need to use other than a plaintext protocol. For example: `json:http:my_json_instance`,
+`json:https:my_json_instance`. You can set basic HTTP authentication credentials using
+
+```conf
+ username = my_username
+ password = my_password
+```
+
+The JSON connector is further configurable using additional settings. See the [exporting reference
+doc](/exporting/README.md#options) for details.
+
+