external metrics server: extend docs to explain http api

and mention that 1.8.x has a compatible api (and their differences)

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
This commit is contained in:
Dominik Csapak 2020-12-02 10:21:13 +01:00 committed by Thomas Lamprecht
parent e9872054cd
commit 2de05ac474

View File

@ -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).