config: Add Prometheus config

The application now features a [/metrics endpoint][1] for Prometheus to scrape. Since merging, the configuration file structure has been updated since through [another PR][2]. This change requires both changes to be in the application and afterwards allows enabling the endpoint and an engineer to configure scraping of the data. [1]: FlowFuse/flowfuse#2889 [2]: FlowFuse/flowfuse#2893
FlowFuse · Oct 5, 2023 · 3ac5e86 · 3ac5e86
1 parent 8190f89
commit 3ac5e86
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/helm/flowforge/README.md b/helm/flowforge/README.md
@@ -84,6 +84,7 @@ Enables FlowForge Telemetry
  - `forge.telemetry.sentry.frontend_dsn` enables sentry reporting if set
  - `forge.telemetry.sentry.backend_dsn` enables sentry reporting if set
  - `forge.telemetry.sentry.production_mode` rate limit reporting (default `true`)
+ - `forge.telemetry.prometheus.enabled` enables the `/metrics` endpoint on the forge app for scraping by Prometheus
 
  ### Support
 

diff --git a/helm/flowforge/templates/configmap.yaml b/helm/flowforge/templates/configmap.yaml
@@ -161,6 +161,8 @@ data:
       backend:
         sentry:
           dsn: {{ .Values.forge.telemetry.sentry.backend_dsn}}
+      prometheus:
+        enabled: {{ .Values.forge.telemetry.prometheus.enabled }}
       {{ end -}}
     {{- if .Values.forge.support.enabled }}
     support:

diff --git a/helm/flowforge/values.schema.json b/helm/flowforge/values.schema.json
@@ -256,6 +256,14 @@
                                     "type": "boolean"
                                 }
                             }
+                        },
+                        "prometheus": {
+                            "type": "object",
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean"
+                                }
+                            }
                         }
                     }
                 },

diff --git a/test/customizations.yml b/test/customizations.yml
@@ -47,6 +47,8 @@ forge:
       production_mode: false
       frontend_dsn: 'https://sentry.io/flowforge/flowforge-frontend'
       backend_dsn: 'https://sentry.io/flowforge/flowforge-backend'
+    prometheus:
+      enabled: true
   support:
     enabled: true
     hubspot: 12345678

diff --git a/test/unit/configmap_spec.js b/test/unit/configmap_spec.js
@@ -116,8 +116,8 @@ describe('Examine Config Maps', function () {
             const d = configMaps.filter(doc => doc.metadata.name === 'flowforge-config')[0]
             yml = yaml.parse(d.data['flowforge.yml'])
         })
+
         it('has sentry telemetry', function () {
-            console.log(yml.telemetry)
             yml.telemetry.frontend.sentry.should.have.property('production_mode')
             yml.telemetry.frontend.sentry.production_mode.should.equal(false)
 
@@ -127,5 +127,11 @@ describe('Examine Config Maps', function () {
             yml.telemetry.backend.sentry.should.have.property('dsn')
             yml.telemetry.backend.sentry.dsn.should.equal('https://sentry.io/flowforge/flowforge-backend')
         })
+
+        describe('using Prometheus', function () {
+            it('has prometheus enabled', function() {
+                yml.telemetry.prometheus.enabled.should.equal(true)
+            })   
+        })
     })
 })