Publish form count KPI metrics to CloudWatch#2821
Open
theseanything wants to merge 5 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces automated KPI publishing for form counts to AWS CloudWatch, enabling ongoing platform growth tracking without manual reporting.
Changes:
- Added
Metrics::FormCountServiceto aggregate form counts by organisation and form state and publish them to CloudWatch. - Added a
metrics:export_form_countsrake task intended for scheduled execution. - Added specs covering the service publishing behaviour and the rake task wiring.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
app/services/metrics/form_count_service.rb |
Implements aggregation + CloudWatch publishing for per-org/per-state form counts. |
lib/tasks/metrics.rake |
Adds scheduled-entry rake task to trigger publishing. |
spec/services/metrics/form_count_service_spec.rb |
Verifies CloudWatch payload structure and error capture/re-raise behaviour. |
spec/lib/tasks/metrics.rake_spec.rb |
Ensures rake task invokes Metrics::FormCountService#publish_form_counts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
theseanything
force-pushed
the
theseanything/publish-form-counts-to-cloudwatch
branch
3 times, most recently
from
00a4a7a to
12d129c
Compare
lfdebrux
reviewed
Jun 5, 2026
theseanything
force-pushed
the
theseanything/publish-form-counts-to-cloudwatch
branch
from
12d129c to
fa34024
Compare
lfdebrux
previously approved these changes
Jun 8, 2026
Publishes form counts grouped by organisation and state so they can be monitored in CloudWatch.
Provides metrics:export_form_counts for scheduled publishing of form count metrics via FormCountService.
Internal orgs are used for GOV.UK Forms testing and should not appear in CloudWatch form count metrics published for reporting.
Replace direct CloudWatch API calls with the OpenTelemetry Metrics SDK, pushing gauge metrics to the collector sidecar for forwarding. This is due to otel metrics ingestion being significantly cheaper for high cardinality metrics.
theseanything
force-pushed
the
theseanything/publish-form-counts-to-cloudwatch
branch
from
f096a0f to
bb4d244
Compare
Comment on lines
+31
to
+33
| organisation_names.each { |org_name| ensure_all_metric_states(totals, org_name) } | ||
| ensure_all_metric_states(totals, UNKNOWN_ORG) if totals.keys.any? { |(org, _), _| org == UNKNOWN_ORG } | ||
| totals |
Comment on lines
+86
to
+93
| def export_metrics! | ||
| return if OpenTelemetry.meter_provider.metric_readers.empty? | ||
|
|
||
| result = OpenTelemetry.meter_provider.force_flush | ||
| return if result == OpenTelemetry::SDK::Metrics::Export::SUCCESS | ||
|
|
||
| raise ExportError, "OpenTelemetry metrics export failed with result code #{result}" | ||
| end |
Comment on lines
+12
to
+26
| before do | ||
| allow(Settings).to receive(:forms_env).and_return(forms_env) | ||
|
|
||
| provider = OpenTelemetry::SDK::Metrics::MeterProvider.new | ||
| periodic_reader = OpenTelemetry::SDK::Metrics::Export::PeriodicMetricReader.new( | ||
| export_interval_millis: 60_000, | ||
| exporter: metric_exporter, | ||
| ) | ||
| provider.add_metric_reader(periodic_reader) | ||
| OpenTelemetry.meter_provider = provider | ||
| end | ||
|
|
||
| after do | ||
| OpenTelemetry.meter_provider.shutdown | ||
| end |
|
🎉 A review copy of this PR has been deployed! You can reach it at: https://pr-2821.admin.review.forms.service.gov.uk/ It may take 5 minutes or so for the application to be fully deployed and working. If it still isn't ready For the sign in details and more information, see the review apps wiki page. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What problem does this pull request solve?
Trello card: https://trello.com/c/b3cNvzu5/3136-record-kpis-in-cloudwatch
This adds automated form count metrics to CloudWatch so we can track how the platform is growing over time and measure the impact of our work. A new service publishes counts grouped by organisation and state (live, archived, draft), and a metrics:export_form_counts rake task will run on a scheduled cron job to publish those metrics on a regular basis. This lays the foundation for KPI reporting without manual updates.