add external metric server to sysadmin.adoc
[pve-docs.git] / pve-external-metric-server.adoc
1 External Metric Server
2 ----------------------
3 include::attributes.txt[]
4 ifdef::wiki[]
5 :pve-toplevel:
6 endif::wiki[]
7
8 Starting with {pve} 4.0, you can define external metric servers,
9 which will be sent various stats about your hosts, virtual machines and storages.
10
11 Currently supported are:
12
13  * graphite (see http://graphiteapp.org )
14  * influxdb (see https://www.influxdata.com/time-series-platform/influxdb/ )
15
16 The server definitions are saved in
17  /etc/pve/status.cfg
18
19 Graphite server configuration
20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21
22 The definition of a server is:
23
24  graphite:
25     server your-server
26     port your-port
27     path your-path
28
29 where your-port defaults to *2003*
30 and your-path defaults to *proxmox*
31
32 {pve} sends the data over udp, so the graphite server
33 has to be configured for this
34
35 Influxdb plugin configuration
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38 The definition is:
39
40  influxdb:
41     server your-server
42     port your-port
43
44 {pve} sends the data over udp, so the influxdb server
45 has to be configured for this
46
47 Here is an example configuration for influxdb (on your influxdb server):
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 With this configuration, your server listens on all IP adresses on
57 port 8089, and writes the data in the *proxmox* database