Polished the phrasing
Signed-off-by: Aaron Lauterer <a.laute...@proxmox.com>
---
pve-external-metric-server.adoc | 39 ++++++++++++++++++---------------
1 file changed, 21 insertions(+), 18 deletions(-)
diff --git a/pve-external-metric-server.adoc b/pve-external-metric-server.adoc
index c9e1107..1d6efeb 100644
--- a/pve-external-metric-server.adoc
+++ b/pve-external-metric-server.adoc
@@ -4,20 +4,21 @@ 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.
+Starting with {pve} 4.0 support for external metric servers has been
+added. If an external metric server is configured {pve} will send
+various stats about the host, virtual machines and storages to it.
-Currently supported are:
+Currently supported metric servers:
* 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'
+The external metric servers are configured in '/etc/pve/status.cfg'
Graphite server configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The definition of a server is:
+The definition for a Graphite server is:
----
graphite: your-id
@@ -26,15 +27,15 @@ The definition of a server is:
path your-path
----
-where your-port defaults to *2003* and your-path defaults to *proxmox*
+where your-port defaults to *2003* and your-path to *proxmox*.
-{pve} sends the data over UDP, so the graphite server has to be configured
-for this.
+{pve} sends the data over UDP. Therefore the Graphite server needs to
+be configured to accept data via UDP.
-Influxdb plugin configuration
+InfluxdDB plugin configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The definition is:
+The definition for InfluxDB is:
----
influxdb: your-id
@@ -42,10 +43,11 @@ The definition is:
port your-port
----
-{pve} sends the data over UDP, so the influxdb server has to be configured
-for this.
+{pve} sends the data over UDP. Therefore the InfluxDB server needs to
+be configured for this.
-Here is an example configuration for influxdb (on your influxdb server):
+Here is an example configuration for InfluxDB
+(*on the InfluxDB server*):
----
[[udp]]
@@ -56,16 +58,17 @@ Here is an example configuration for influxdb (on your
influxdb server):
batch-timeout = "1s"
----
-With this configuration, your server listens on all IP addresses on
-port 8089, and writes the data in the *proxmox* database
+With this configuration the InfluxDB server listens on all IP
+addresses on port 8089 and writes the data to 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.
+The *ID* is optional but if there are multiple definitions of the same
+metric server type they are mandatory and must be unique.
-Here is an example of a finished status.cfg
+Here is an example of a finished status.cfg with multiple InfluxDB
+definitions.
----
graphite:
--
2.20.1
_______________________________________________
pve-devel mailing list
pve-devel@pve.proxmox.com
https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
