Difference between revisions of "External Metric Server"

From Proxmox VE
Jump to: navigation, search
 
Line 4: Line 4:
 
[[Category:Reference Documentation]]
 
[[Category:Reference Documentation]]
 
<pvehide>
 
<pvehide>
Starting with Proxmox VE 4.0, you can define external metric servers,
+
Starting with Proxmox VE 4.0, you can define external metric servers, which will
which will be sent various stats about your hosts, virtual machines and storages.
+
be sent various stats about your hosts, virtual machines and storages.
 
Currently supported are:
 
Currently supported are:
graphite (see http://graphiteapp.org )
+
Graphite (see http://graphiteapp.org )
influxdb (see https://www.influxdata.com/time-series-platform/influxdb/ )
+
InfluxDB (see https://www.influxdata.com/time-series-platform/influxdb/ )
The server definitions are saved in
+
The server definitions are saved in /etc/pve/status.cfg
/etc/pve/status.cfg
 
 
Graphite server configuration
 
Graphite server configuration
 
The definition of a server is:
 
The definition of a server is:
graphite:
+
graphite: your-id
  server your-server
+
    server your-server
  port your-port
+
    port your-port
  path your-path
+
    path your-path
where your-port defaults to 2003
+
where your-port defaults to 2003 and your-path defaults to proxmox
and your-path defaults to proxmox
+
Proxmox VE sends the data over UDP, so the graphite server has to be configured
Proxmox VE sends the data over udp, so the graphite server
+
for this.
has to be configured for this
 
 
Influxdb plugin configuration
 
Influxdb plugin configuration
 
The definition is:
 
The definition is:
influxdb:
+
influxdb: your-id
  server your-server
+
    server your-server
  port your-port
+
    port your-port
Proxmox VE sends the data over udp, so the influxdb server
+
Proxmox VE sends the data over UDP, so the influxdb server has to be configured
has to be configured for this
+
for this.
 
Here is an example configuration for influxdb (on your influxdb server):
 
Here is an example configuration for influxdb (on your influxdb server):
[[udp]]
+
[[udp]]
  enabled = true
+
  enabled = true
  bind-address = "0.0.0.0:8089"
+
  bind-address = "0.0.0.0:8089"
  database = "proxmox"
+
  database = "proxmox"
  batch-size = 1000
+
  batch-size = 1000
  batch-timeout = "1s"
+
  batch-timeout = "1s"
 
With this configuration, your server listens on all IP addresses on
 
With this configuration, your server listens on all IP addresses on
 
port 8089, and writes the data in the proxmox database
 
port 8089, and writes the data in the proxmox database
 +
Multiple Definitions and Example
 +
The id is optional, but if you want to have multiple definitions of a single
 +
type, then the ids must be defined and different from each other.
 +
Here is an example of a finished status.cfg
 +
graphite:
 +
    server 10.0.0.5
 +
influxdb: influx1
 +
    server 10.0.0.6
 +
    port 8089
 +
influxdb: influx2
 +
    server 10.0.0.7
 +
    port 8090
 
</pvehide>
 
</pvehide>
 
<!--PVE_IMPORT_END_MARKER-->
 
<!--PVE_IMPORT_END_MARKER-->

Latest revision as of 11:23, 16 July 2019

Starting with Proxmox VE 4.0, you can define external metric servers, which will be sent various stats about your hosts, virtual machines and storages.

Currently supported are:

The server definitions are saved in /etc/pve/status.cfg

Graphite server configuration

The definition of a server is:

 graphite: your-id
    server your-server
    port your-port
    path your-path

where your-port defaults to 2003 and your-path defaults to proxmox

Proxmox VE sends the data over UDP, so the graphite server has to be configured for this.

Influxdb plugin configuration

The definition is:

 influxdb: your-id
    server your-server
    port your-port

Proxmox VE sends the data over UDP, so the influxdb server has to be configured for this.

Here is an example configuration for influxdb (on your influxdb server):

 [[udp]]
   enabled = true
   bind-address = "0.0.0.0:8089"
   database = "proxmox"
   batch-size = 1000
   batch-timeout = "1s"

With this configuration, your server listens on all IP addresses on port 8089, and writes the data in the proxmox database

Multiple Definitions and Example

The id is optional, but if you want to have multiple definitions of a single type, then the ids must be defined and different from each other.

Here is an example of a finished status.cfg

 graphite:
    server 10.0.0.5

 influxdb: influx1
    server 10.0.0.6
    port 8089

 influxdb: influx2
    server 10.0.0.7
    port 8090