From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <pbs-devel-bounces@lists.proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 5E3421FF17A for <inbox@lore.proxmox.com>; Mon, 5 Aug 2024 11:43:10 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1DB79291A; Mon, 5 Aug 2024 11:43:17 +0200 (CEST) From: Gabriel Goller <g.goller@proxmox.com> To: pbs-devel@lists.proxmox.com Date: Mon, 5 Aug 2024 11:42:40 +0200 Message-Id: <20240805094240.85801-1-g.goller@proxmox.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.050 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] docs: add external metrics server page X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion <pbs-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/> List-Post: <mailto:pbs-devel@lists.proxmox.com> List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe> Reply-To: Proxmox Backup Server development discussion <pbs-devel@lists.proxmox.com> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com> Add External Metrics page to PBS's documentation. Most of it is copied from the PVE documentation, minus the Graphite part. Signed-off-by: Gabriel Goller <g.goller@proxmox.com> --- docs/external_metric_server.rst | 57 +++++++++++++++++++++++++++++++++ docs/sysadmin.rst | 2 ++ 2 files changed, 59 insertions(+) create mode 100644 docs/external_metric_server.rst diff --git a/docs/external_metric_server.rst b/docs/external_metric_server.rst new file mode 100644 index 000000000000..5dd36ea5b7e5 --- /dev/null +++ b/docs/external_metric_server.rst @@ -0,0 +1,57 @@ +.. _external_metric_server: + +External Metric Server +---------------------- + +In Proxmox Backup, you can define external metric servers, which will +periodically receive various stats about your host's memory, network, and disk +activity. + +Currently supported are: + + * InfluxDB (HTTP) (see https://docs.influxdata.com/influxdb/v2/ ) + * InfluxDB (UDP) (see https://docs.influxdata.com/influxdb/v1/ ) + +The external metric server definitions are saved in +'/etc/proxmox-backup/metricserver.cfg', and can be edited through the web +interface. + +.. note:: + + UDP support has been dropped in InfluxDB v2, so HTTP use is recommended. + +InfluxDB (HTTP) plugin 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. + +Since InfluxDB's v2 API is only available with authentication, you have +to generate a token that can write into the correct bucket and set it. + +In the v2 compatible API of 1.8.x, you can use 'user:password' as token +(if required), and can omit the 'organization' since that has no meaning in InfluxDB 1.x. + +You can also set the maximum batch size (default 25000000 bytes) with the +'max-body-size' setting (this corresponds to the InfluxDB setting with the +same name). + +InfluxDB (UDP) plugin configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Proxmox Backup can also send the data over UDP, but the InfluxDB server has to +be configured for this. The MTU can also be configured here, if 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" +---- + +With this configuration, your server listens on all IP addresses on port 8089, +and writes the data in the *proxmox* database. diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst index 114ad4cbbe0e..d42b6a9b2af1 100644 --- a/docs/sysadmin.rst +++ b/docs/sysadmin.rst @@ -30,6 +30,8 @@ please refer to the standard Debian documentation. .. include:: certificate-management.rst +.. include:: external_metric_server.rst + .. include:: services.rst .. include:: command-line-tools.rst -- 2.39.2 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel