From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 3C1B61FF15F for ; Mon, 21 Oct 2024 13:57:26 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 4B7B83334F; Mon, 21 Oct 2024 13:58:04 +0200 (CEST) From: Gabriel Goller To: pbs-devel@lists.proxmox.com Date: Mon, 21 Oct 2024 13:58:00 +0200 Message-Id: <20241021115800.311721-1-g.goller@proxmox.com> X-Mailer: git-send-email 2.39.5 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.042 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v2] docs: add screenshots to external metrics page X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" Add generated screenshots of overview, http configuration and udp configuration. Signed-off-by: Gabriel Goller --- 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