fix #5429: network: override device names: include Type=ether

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

diff --git a/pve-external-metric-server.adoc b/pve-external-metric-server.adoc
index e898a0a2199af3ae0c297bb6243ed24c576c9c7f..641fc42b186644eb26808f8c5d2006cb224eb3cc 100644 (file)
--- a/pve-external-metric-server.adoc
+++ b/pve-external-metric-server.adoc
@@ -7,16 +7,16 @@ endif::wiki[]
 
 [thumbnail="screenshot/gui-datacenter-metric-server-list.png"]
 
-In {pve}, you can define external metric servers, which will
-be sent various stats about your hosts, virtual machines and storages.
+In {pve}, you can define external metric servers, which will periodically
+receive various stats about your hosts, virtual guests and storages.
 
 Currently supported are:
 
- * Graphite (see http://graphiteapp.org )
+ * Graphite (see https://graphiteapp.org )
  * InfluxDB (see https://www.influxdata.com/time-series-platform/influxdb/ )
 
-The server definitions are saved in '/etc/pve/status.cfg', and can be edited
-through the GUI.
+The external metric server definitions are saved in '/etc/pve/status.cfg', and
+can be edited through the web interface.
 
 [[metric_server_graphite]]
 Graphite server configuration
@@ -24,15 +24,15 @@ Graphite server configuration
 
 [thumbnail="screenshot/gui-datacenter-metric-server-graphite.png"]
 
-The default port is set to *2003* and the default path is *proxmox*.
+The default port is set to *2003* and the default graphite path is *proxmox*.
 
-{pve} sends the data over UDP, so the graphite server has to be configured
-for this. Here the MTU can be configured for environments which require
-a different mtu than the standard *1500*.
+By default, {pve} sends the data over UDP, so the graphite server has to be
+configured to accept this. Here the maximum transmission unit (MTU) can be
+configured for environments not using the standard *1500* MTU.
 
-Alternatively, the plugin can be configured to use TCP instead with
-a timeout. Here the timeout is important, as to not block the stat generating
-process forever.
+You can also configure the plugin to use TCP. In order not to block the
+important `pvestatd` statistic collection daemon, a timeout is required to cope
+with network problems.
 
 [[metric_server_influxdb]]
 Influxdb plugin configuration
@@ -40,13 +40,13 @@ Influxdb plugin configuration
 
 [thumbnail="screenshot/gui-datacenter-metric-server-influxdb.png"]
 
-{pve} sends the data over UDP, so the influxdb server has to be configured
-for this. The MTU can also be configured here, if necessary.
+{pve} sends the data over UDP, so the influxdb server has to be configured for
+this. The MTU can also be configured here, if necessary.
 
 Here is an example configuration for influxdb (on your influxdb server):
 
 ----
-​[[udp]]
+[[udp]]
    enabled = true
    bind-address = "0.0.0.0:8089"
    database = "proxmox"
@@ -54,6 +54,23 @@ Here is an example configuration for influxdb (on your influxdb server):
    batch-timeout = "1s"
 ----
 
-With this configuration, your server listens on all IP addresses on
-port 8089, and writes the data in the *proxmox* database
+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).