* [pbs-devel] [PATCH proxmox-backup v2] docs: add screenshots to external metrics page
@ 2024-10-21 11:58 Gabriel Goller
0 siblings, 0 replies; only message in thread
From: Gabriel Goller @ 2024-10-21 11:58 UTC (permalink / raw)
To: pbs-devel
Add generated screenshots of overview, http configuration and udp
configuration.
Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
Note: screenshots need to be generated and placed into docs/images/
before this is applied!
Changelog v2:
- rebase
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 f65082cc4976..c4377ab3a0de 100644
--- a/docs/external-metric-server.rst
+++ b/docs/external-metric-server.rst
@@ -1,6 +1,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.
@@ -20,6 +25,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.
@@ -36,6 +46,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.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2024-10-21 11:57 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-10-21 11:58 [pbs-devel] [PATCH proxmox-backup v2] docs: add screenshots to external metrics page Gabriel Goller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox