pve-external-metric-server.adoc

   1 [[external_metric_server]]
   2 External Metric Server
   3 ----------------------
   4 ifdef::wiki[]
   5 :pve-toplevel:
   6 endif::wiki[]
   7
   8 [thumbnail="screenshot/gui-datacenter-metric-server-list.png"]
   9
  10 In {pve}, you can define external metric servers, which will
  11 be sent various stats about your hosts, virtual machines and storages.
  12
  13 Currently supported are:
  14
  15  * Graphite (see http://graphiteapp.org )
  16  * InfluxDB (see https://www.influxdata.com/time-series-platform/influxdb/ )
  17
  18 The server definitions are saved in '/etc/pve/status.cfg', and can be edited
  19 through the GUI.
  20
  21 [[metric_server_graphite]]
  22 Graphite server configuration
  23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24
  25 [thumbnail="screenshot/gui-datacenter-metric-server-graphite.png"]
  26
  27 The default port is set to *2003* and the default path is *proxmox*.
  28
  29 {pve} sends the data over UDP, so the graphite server has to be configured
  30 for this. Here the MTU can be configured for environments which require
  31 a different mtu than the standard *1500*.
  32
  33 Alternatively, the plugin can be configured to use TCP instead with
  34 a timeout. Here the timeout is important, as to not block the stat generating
  35 process forever.
  36
  37 [[metric_server_influxdb]]
  38 Influxdb plugin configuration
  39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  40
  41 [thumbnail="screenshot/gui-datacenter-metric-server-influxdb.png"]
  42
  43 {pve} sends the data over UDP, so the influxdb server has to be configured
  44 for this. The MTU can also be configured here, if necessary.
  45
  46 Here is an example configuration for influxdb (on your influxdb server):
  47
  48 ----
  49 [[udp]]
  50    enabled = true
  51    bind-address = "0.0.0.0:8089"
  52    database = "proxmox"
  53    batch-size = 1000
  54    batch-timeout = "1s"
  55 ----
  56
  57 With this configuration, your server listens on all IP addresses on
  58 port 8089, and writes the data in the *proxmox* database
  59