Fixed some typos and slight language improvements
[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,
8 which will 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
16  /etc/pve/status.cfg
17
18 Graphite server configuration
19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
21 The definition of a server is:
22
23  graphite:
24     server your-server
25     port your-port
26     path your-path
27
28 where your-port defaults to *2003*
29 and your-path defaults to *proxmox*
30
31 {pve} sends the data over udp, so the graphite server
32 has to be configured for this
33
34 Influxdb plugin configuration
35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36
37 The definition is:
38
39  influxdb:
40     server your-server
41     port your-port
42
43 {pve} sends the data over udp, so the influxdb server
44 has to be configured for this
45
46 Here is an example configuration for influxdb (on your influxdb server):
47
48  [[udp]]
49    enabled = true
50    bind-address = "0.0.0.0:8089"
51    database = "proxmox"
52    batch-size = 1000
53    batch-timeout = "1s"
54
55 With this configuration, your server listens on all IP addresses on
56 port 8089, and writes the data in the *proxmox* database