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

Gabriel Goller g.goller at proxmox.com
Thu Aug 8 13:39:19 CEST 2024


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 at 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





More information about the pbs-devel mailing list