pve-docs/pve-external-metric-server.adoc
Fabian Grünbichler 692178e258 add ZWS to avoid config snippet misinterpretation
this is not a reference that we want to include in online help.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2020-08-11 15:33:03 +02:00

82 lines
1.7 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

External Metric Server
----------------------
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Starting with {pve} 4.0, you can define external metric servers, which will
be sent various stats about your hosts, virtual machines and storages.
Currently supported are:
* Graphite (see http://graphiteapp.org )
* InfluxDB (see https://www.influxdata.com/time-series-platform/influxdb/ )
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*
{pve} 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
----
{pve} 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
----