From: Gabriel Goller <g.goller@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 1/2] docs: add screenshots to external metrics page
Date: Thu, 8 Aug 2024 13:39:19 +0200 [thread overview]
Message-ID: <20240808113920.250954-1-g.goller@proxmox.com> (raw)
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
next reply other threads:[~2024-08-08 11:39 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-08 11:39 Gabriel Goller [this message]
2024-08-08 11:39 ` [pbs-devel] [PATCH proxmox-backup 2/2] docs: fix code blocks for metrics configuration Gabriel Goller
2024-10-21 11:57 ` Gabriel Goller
2024-10-21 11:57 ` [pbs-devel] [PATCH proxmox-backup 1/2] docs: add screenshots to external metrics page Gabriel Goller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240808113920.250954-1-g.goller@proxmox.com \
--to=g.goller@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.