[pbs-devel] [PATCH proxmox-backup 1/2] docs: add screenshots to external metrics page

[pbs-devel] [PATCH proxmox-backup 1/2] docs: add screenshots to external metrics page

[Gabriel Goller]

Add generated screenshots of overview, http configuration and udp
configuration. Screenshots generated with `pbs-gui-configuration-scrots`
in `pve-gui-tests` (internal).

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---

Note: screenshots need to be generated and placed into docs/images/
before this is applied!

 docs/external_metric_server.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/external_metric_server.rst b/docs/external_metric_server.rst
index 097a8cc3a1c0..f5d021515b49 100644
--- a/docs/external_metric_server.rst
+++ b/docs/external_metric_server.rst
@@ -3,6 +3,11 @@
 External Metric Server
 ----------------------
 
+.. image:: images/screenshots/pbs-gui-system-metrics.png
+  :target: _images/pbs-gui-system-metrics.png
+  :align: right
+  :alt: System: Metric Server Overview
+
 Proxmox Backup Server periodically sends various metrics about your host's memory,
 network and disk activity to configured external metric servers.
 
@@ -22,6 +27,11 @@ interface.
 InfluxDB (HTTP) plugin configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. image:: images/screenshots/pbs-gui-system-metrics-create-http.png
+  :target: _images/pbs-gui-system-metrics-create-http.png
+  :align: right
+  :alt: Create InfluxDB (HTTP) configuration
+
 The plugin can be configured to use the HTTP(s) API of InfluxDB 2.x.
 InfluxDB 1.8.x does contain a forwards compatible API endpoint for this v2 API.
 
@@ -38,6 +48,11 @@ same name).
 InfluxDB (UDP) plugin configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. image:: images/screenshots/pbs-gui-system-metrics-create-udp.png
+  :target: _images/pbs-gui-system-metrics-create-udp.png
+  :align: right
+  :alt: Create InfluxDB (UDP) configuration
+
 Proxmox Backup Server can also send data via UDP. This requires the InfluxDB
 server to be configured correctly. The MTU can also be configured here if
 necessary.
-- 
2.39.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

[pbs-devel] [PATCH proxmox-backup 2/2] docs: fix code blocks for metrics configuration

[Gabriel Goller]

Create code-block for InfluxDB configuration.

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
 docs/external_metric_server.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/external_metric_server.rst b/docs/external_metric_server.rst
index f5d021515b49..23b5a4c62114 100644
--- a/docs/external_metric_server.rst
+++ b/docs/external_metric_server.rst
@@ -59,14 +59,14 @@ necessary.
 
 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"
-----
+.. code-block:: console
+
+   [[udp]]
+      enabled = true
+      bind-address = "0.0.0.0:8089"
+      database = "proxmox"
+      batch-size = 1000
+      batch-timeout = "1s"
 
 With this configuration, the InfluxDB server listens on all IP addresses on
 port 8089, and writes the data in the *proxmox* database.
-- 
2.39.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel