external metrics server: extend docs to explain http api

[pve-docs.git] / pve-external-metric-server.adoc

diff --git a/pve-external-metric-server.adoc b/pve-external-metric-server.adoc
index 783e72c0b14757339f70fc1ac944bf3081f6d6c7..eace99945d21bc96af5d23a0302c603f4c1f8b5b 100644 (file)
--- a/pve-external-metric-server.adoc
+++ b/pve-external-metric-server.adoc
@@ -56,3 +56,21 @@ Here is an example configuration for influxdb (on your influxdb server):
 
 With this configuration, your server listens on all IP addresses on port 8089,
 and writes the data in the *proxmox* database
+
+Alternatively, the plugin can be configured to use the http(s) API of InfluxDB 2.x.
+InfluxDB 1.8.x does contain a forwards compatible API endpoint for this v2 API.
+
+To use it, set 'influxdbproto' to 'http' or 'https' (depending on your configuration).
+By default, {pve} uses the organization 'proxmox' and the bucket/db 'proxmox'
+(They can be set with the configuration 'organization' and 'bucket' respectively).
+
+Since InfluxDB's v2 API is only available with authentication, you have
+to generate a token that can write into the correct bucket and set it.
+
+In the v2 compatible API of 1.8.x, you can use 'user:password' as token
+(if required), and can omit the 'organization' since that has no meaning in InfluxDB 1.x.
+
+You can also set the HTTP Timeout (default is 1s) with the 'timeout' setting,
+as well as the maximum batch size (default 25000000 bytes) with the
+'max-body-size' setting (this corresponds to the InfluxDB setting with the
+same name).