From 73bf256650962548b663f257cfeb8b18e8b5a97d Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Fri, 29 Dec 2023 11:22:52 -0500 Subject: [PATCH] Update Prometheus readmes --- monitoring/README.md | 4 +--- monitoring/prometheus/README.md | 4 ++++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/monitoring/README.md b/monitoring/README.md index 47b6fe74..935e8cc0 100644 --- a/monitoring/README.md +++ b/monitoring/README.md @@ -6,9 +6,7 @@ This directory contains several monitoring resources that can be used with vario The included example Prometheus configuration and Grafana dashboard can be used to query the PVC API for Prometheus data and display it with a consistent dashboard. -Note that the default configuration here also includes Ceph cluster information; a Ceph dashboard can be found externally. - -Note too that this does not include node export examples from individual PVC nodes; those must be set up separately. +See the README in the `prometheus` folder for more details. ## Munin diff --git a/monitoring/prometheus/README.md b/monitoring/prometheus/README.md index adef8846..f761be99 100644 --- a/monitoring/prometheus/README.md +++ b/monitoring/prometheus/README.md @@ -17,6 +17,8 @@ file_sd_configs: [...] ``` +Note that due to the limitations of the Prometheus configuration, this is a global option for all service discovery entries specified; it cannot be toggled for each connection individually. + ## `targets-pvc_cluster.json` This JSON-based config shows two example clusters as two discrete entries. This is required for proper labeling. @@ -31,6 +33,8 @@ Each entry must contain: * `pvc_cluster_name`: A nicer, more human-readable description of the cluster. Likely, the `Description` in your `pvc connection list` entry for the cluster. +This file can be autogenerated from the list of configured PVC clusters in a PVC CLI client using the `pvc connection list --format json-prometheus` option. + ## `grafana-pvc-cluster-dashboard.json` This JSON-based Grafana dashboard allows for a nice presentation of the metrics collected by the above Prometheus pollers. The cluster can be selected (based on the `pvc_cluster_name` value) and useful information about the cluster is then displayed.