make dinstall: skip mediawiki deb for now
[pve-docs.git] / pve-external-metric-server.adoc
1 External Metric Server
2 ----------------------
3 ifdef::wiki[]
4 :pve-toplevel:
5 endif::wiki[]
6
7 Starting with {pve} 4.0, you can define external metric servers, which will
8 be sent various stats about your hosts, virtual machines and storages.
9
10 Currently supported are:
11
12  * Graphite (see http://graphiteapp.org )
13  * InfluxDB (see https://www.influxdata.com/time-series-platform/influxdb/ )
14
15 The server definitions are saved in '/etc/pve/status.cfg'
16
17 Graphite server configuration
18 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19
20 The definition of a server is:
21
22 ----
23  graphite: your-id
24     server your-server
25     port your-port
26     path your-path
27 ----
28
29 where your-port defaults to *2003* and your-path defaults to *proxmox*
30
31 {pve} sends the data over UDP, so the graphite server has to be configured
32 for this.
33
34 Influxdb plugin configuration
35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36
37 The definition is:
38
39 ----
40  influxdb: your-id
41     server your-server
42     port your-port
43 ----
44
45 {pve} sends the data over UDP, so the influxdb server has to be configured
46 for this.
47
48 Here is an example configuration for influxdb (on your influxdb server):
49
50 ----
51  [[udp]]
52    enabled = true
53    bind-address = "0.0.0.0:8089"
54    database = "proxmox"
55    batch-size = 1000
56    batch-timeout = "1s"
57 ----
58
59 With this configuration, your server listens on all IP addresses on
60 port 8089, and writes the data in the *proxmox* database
61
62 Multiple Definitions and Example
63 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64
65 The *id* is optional, but if you want to have multiple definitions of a single
66 type, then the ids must be defined and different from each other.
67
68 Here is an example of a finished status.cfg
69
70 ----
71  graphite:
72     server 10.0.0.5
73
74  influxdb: influx1
75     server 10.0.0.6
76     port 8089
77
78  influxdb: influx2
79     server 10.0.0.7
80     port 8090
81 ----