Update prometheus.yml

james-laing · james-laing · commit 229e6ae186fc · 2025-07-31T16:25:35.000+01:00
* changed namespace: 'purefa' to namespace: ['purefa'] to avoid prometheus parsing error.
* Added ' marks to all strings to avoid unfamiliar users getting caught out by yaml parsing bad errors caused by whitespace characters.
* removed location and site parameters to clean up config not required by the dashboard.
* updated all comments and standardised layout.
diff --git a/extra/prometheus/prometheus.yml b/extra/prometheus/prometheus.yml
@@ -1,245 +1,185 @@
 global:
-  scrape_interval:     30s # Set the scrape interval to every 30 seconds. Default is every 1 minute.
-  scrape_timeout:      30s # Set the scrape timeout to shorter than or equal to scrape_interval. Default is every 1 minute.
-  # evaluation_interval: 60s # is set to the default every 1 minute.
-
-# Alertmanager configuration (optional)
-#alerting:
-#  alertmanagers:
-#  - static_configs:
-#    - targets:
-#       - alertmanager:9093
-
-# Load rules once and periodically evaluate them according to the global 'evaluation_interval'. (optional)
-#rule_files:
-#  - "purefa_alerts_rules.yml"
-#  - "purefa_pods_rules.yml"
-
-# A scrape configuration containing exactly one endpoint to scrape:
-# Here it's Prometheus itself
+  scrape_interval: '60s'  # Set the global scrape interval (default: 1 minute)
+  scrape_timeout:  '60s'  # Timeout must be ≤ scrape_interval
+
+# -----------------------------------------
+# Optional: Alertmanager Configuration
+# -----------------------------------------
+# alerting:
+#   alertmanagers:
+#     - static_configs:
+#         - targets:
+#             - 'alertmanager:9093'
+
+# -----------------------------------------
+# Optional: Prometheus Rule Files
+# -----------------------------------------
+# rule_files:
+#   - 'purefa_alerts_rules.yml'
+#   - 'purefa_pods_rules.yml'
+
+# -----------------------------------------
+# Prometheus Self-Monitoring
+# -----------------------------------------
 scrape_configs:
 
-  - job_name: "prometheus"
+  - job_name: 'prometheus'
     static_configs:
-    - targets: ["prometheus-server.fqdn.com:9090"]
-
-# ################################## #
-# Pure Storage FlashArray Number 1   #
-# Running Purity//FA 6.7.0 or higher #
-# ################################## #
-# Create a single scrape job for each selected metric endpoint per FlashArray.
-# It is NOT recommended to scrape the root /metrics endpoint as it can be an expensive query.
-# Scrape job for Pure Storage FlashArray 1 scraping /metrics/array
+      - targets: ['localhost:9090']
+
+# ==============================================
+# FlashArray 1 — arrayname01 (Purity//FA ≥ 6.7.x)
+# ==============================================
+
+  # /metrics/array
   - job_name: 'purefa_array_arrayname01'
-    metrics_path: /metrics/array
-    scheme: https
+    metrics_path: '/metrics/array'
+    scheme: 'https'
     tls_config:
       insecure_skip_verify: true
-    # Bearer authorization token
     authorization:
-      credentials: 11111111-1111-1111-1111-111111111111
+      credentials: '11111111-1111-1111-1111-111111111111'
     params:
-      namespace: purefa
-
+      namespace: ['purefa']
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - arrayname01.fqdn.com
-      labels:
-        location: uk
-        site: London
-        instance: arrayname01
-        env: production
-
-# Scrape job for Pure Storage FlashArray 1 scraping /metrics/volumes
+      - targets: ['arrayname01.fqdn.com']
+        labels:
+          instance: 'arrayname01'
+          env: 'production'
+
+  # /metrics/volumes
   - job_name: 'purefa_volumes_arrayname01'
-    metrics_path: /metrics/volumes
-    scheme: https
+    metrics_path: '/metrics/volumes'
+    scheme: 'https'
     tls_config:
       insecure_skip_verify: true
-    # Bearer authorization token
     authorization:
-      credentials: 11111111-1111-1111-1111-111111111111
+      credentials: '11111111-1111-1111-1111-111111111111'
     params:
-      namespace: purefa
-
+      namespace: ['purefa']
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - arrayname01.fqdn.com
-      labels:
-        location: uk
-        site: London
-        instance: arrayname01
-        env: production
-
-# Scrape job for Pure Storage FlashArray 1 scraping /metrics/hosts
+      - targets: ['arrayname01.fqdn.com']
+        labels:
+          instance: 'arrayname01'
+          env: 'production'
+
+  # /metrics/hosts
   - job_name: 'purefa_hosts_arrayname01'
-    metrics_path: /metrics/hosts
-    scheme: https
+    metrics_path: '/metrics/hosts'
+    scheme: 'https'
     tls_config:
       insecure_skip_verify: true
-    # Bearer authorization token
     authorization:
-      credentials: 11111111-1111-1111-1111-111111111111
+      credentials: '11111111-1111-1111-1111-111111111111'
     params:
-      namespace: purefa
-
+      namespace: ['purefa']
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - arrayname01.fqdn.com
-      labels:
-        instance: arrayname01
-        location: uk
-        site: London
-        env: production
-
-# Scrape job for Pure Storage FlashArray 1 scraping /metrics/pods
+      - targets: ['arrayname01.fqdn.com']
+        labels:
+          instance: 'arrayname01'
+          env: 'production'
+
+  # /metrics/pods
   - job_name: 'purefa_pods_arrayname01'
-    metrics_path: /metrics/pods
-    scheme: https
+    metrics_path: '/metrics/pods'
+    scheme: 'https'
     tls_config:
       insecure_skip_verify: true
-    # Bearer authorization token
     authorization:
-      credentials: 11111111-1111-1111-1111-111111111111
+      credentials: '11111111-1111-1111-1111-111111111111'
     params:
-      namespace: purefa
-
+      namespace: ['purefa']
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - arrayname01.fqdn.com
-      labels:
-        instance: arrayname01
-        location: uk
-        site: London
-        env: production
-
-# Scrape job for Pure Storage FlashArray 1 scraping /metrics/directories
+      - targets: ['arrayname01.fqdn.com']
+        labels:
+          instance: 'arrayname01'
+          env: 'production'
+
+  # /metrics/directories — Expensive query; scrape less often
   - job_name: 'purefa_directories_arrayname01'
-    metrics_path: /metrics/directories
-    scheme: https
+    metrics_path: '/metrics/directories'
+    scheme: 'https'
+    scrape_interval: '30m'  # Less frequent scraping to reduce load
+    scrape_timeout:  '15m'  # Must be shorter than scrape_interval
     tls_config:
       insecure_skip_verify: true
-    # It is recommended to collect expensive queries less frequently such as /metrics/directories.
-    scrape_interval:     15m # Set the scrape interval to every 15min. Default is every 1 minute. This overrides the global setting.
-    scrape_timeout:      15m # Set the scrape timeout to shorter than or equal to scrape_interval. Default is every 1 minute.
-    # Bearer authorization token
     authorization:
-      credentials: 11111111-1111-1111-1111-111111111111
+      credentials: '11111111-1111-1111-1111-111111111111'
     params:
-      namespace: purefa
-
+      namespace: ['purefa']
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - arrayname01.fqdn.com
-      labels:
-        instance: arrayname01
-        location: uk
-        site: London
-        env: production
-
-# ################################ #
-# Pure Storage FlashArray Number 2 #
-# Running Purity//FA 6.6.x or less #
-# ################################ #
-# Scrape job for Pure Storage FlashArray 2 scraping /metrics/array
+      - targets: ['arrayname01.fqdn.com']
+        labels:
+          instance: 'arrayname01'
+          env: 'production'
+
+# ==============================================
+# FlashArray 2 — arrayname02 (Purity//FA ≤ 6.6.x)
+# ==============================================
+
+  # /metrics/array
   - job_name: 'purefa_array_arrayname02'
-    metrics_path: /metrics/array
-    # Bearer authorization token
+    metrics_path: '/metrics/array'
     authorization:
-      credentials: 22222222-2222-2222-2222-222222222222
+      credentials: '22222222-2222-2222-2222-222222222222'
     params:
       endpoint: ['arrayname02.fqdn.com']
-
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - purefa-openmetrics-exporter.fqdn.com:9490
-      labels:
-        location: fr
-        site: Paris
-        instance: arrayname02
-        env: production
-
-# Scrape job for Pure Storage FlashArray 2 scraping /metrics/volumes
+      - targets: ['purefa-openmetrics-exporter.fqdn.com:9490']
+        labels:
+          instance: 'arrayname02'
+          env: 'production'
+
+  # /metrics/volumes
   - job_name: 'purefa_volumes_arrayname02'
-    metrics_path: /metrics/volumes
-    # Bearer authorization token
+    metrics_path: '/metrics/volumes'
     authorization:
-      credentials: 22222222-2222-2222-2222-222222222222
+      credentials: '22222222-2222-2222-2222-222222222222'
     params:
       endpoint: ['arrayname02.fqdn.com']
-
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - purefa-openmetrics-exporter.fqdn.com:9490
-      labels:
-        instance: arrayname02
-        location: fr
-        site: Paris
-        env: test
-
-# Scrape job for Pure Storage FlashArray 2 scraping /metrics/hosts
+      - targets: ['purefa-openmetrics-exporter.fqdn.com:9490']
+        labels:
+          instance: 'arrayname02'
+          env: 'test'
+
+  # /metrics/hosts
   - job_name: 'purefa_hosts_arrayname02'
-    metrics_path: /metrics/hosts
-    # Bearer authorization token
+    metrics_path: '/metrics/hosts'
     authorization:
-      credentials: 22222222-2222-2222-2222-222222222222
+      credentials: '22222222-2222-2222-2222-222222222222'
     params:
       endpoint: ['arrayname02.fqdn.com']
-
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - purefa-openmetrics-exporter.fqdn.com:9490
-      labels:
-        instance: arrayname02
-        location: fr
-        site: Paris
-        env: test
-
-# Scrape job for Pure Storage FlashArray 2 scraping /metrics/pods
+      - targets: ['purefa-openmetrics-exporter.fqdn.com:9490']
+        labels:
+          instance: 'arrayname02'
+          env: 'test'
+
+  # /metrics/pods
   - job_name: 'purefa_pods_arrayname02'
-    metrics_path: /metrics/pods
-    # Bearer authorization token
+    metrics_path: '/metrics/pods'
     authorization:
-      credentials: 22222222-2222-2222-2222-222222222222
+      credentials: '22222222-2222-2222-2222-222222222222'
     params:
       endpoint: ['arrayname02.fqdn.com']
-
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - purefa-openmetrics-exporter.fqdn.com:9490
-      labels:
-        instance: arrayname02
-        location: fr
-        site: Paris
-        env: test
-
-# Scrape job for Pure Storage FlashArray 2 scraping /metrics/directories
+      - targets: ['purefa-openmetrics-exporter.fqdn.com:9490']
+        labels:
+          instance: 'arrayname02'
+          env: 'test'
+
+  # /metrics/directories — Expensive query; scrape less often
   - job_name: 'purefa_directories_arrayname02'
-    metrics_path: /metrics/directories
-    # It is recommended to collect expensive queries less frequently such as /metrics/directories.
-    scrape_interval:     15m # Set the scrape interval to every 15min. Default is every 1 minute. This overrides the global setting.
-    scrape_timeout:      15m # Set the scrape timeout to shorter than or equal to scrape_interval. Default is every 1 minute.
-    # Bearer authorization token
+    metrics_path: '/metrics/directories'
+    scrape_interval: '30m'  # Less frequent scraping to reduce load
+    scrape_timeout:  '15m'  # Must be shorter than scrape_interval
     authorization:
-      credentials: 22222222-2222-2222-2222-222222222222
+      credentials: '22222222-2222-2222-2222-222222222222'
     params:
       endpoint: ['arrayname02.fqdn.com']
-
     static_configs:
-    # purefa openmetrics exporter
-    - targets:
-      - purefa-openmetrics-exporter.fqdn.com:9490
-      labels:
-        instance: arrayname02
-        location: fr
-        site: Paris
-        env: test
+      - targets: ['purefa-openmetrics-exporter.fqdn.com:9490']
+        labels:
+          instance: 'arrayname02'
+          env: 'test'
