feat: add prometheus metrics #386
Open
Conversation
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
- Add monitoring service, module and controller - Add custom registry and type definitions for adding counters, gauges with labels and custom functions to retrieve values - Add middleware for monitoring updates when /monitoring/metrics route is called - Add mfx power conversion metric to monitoring service
fmorency
approved these changes
May 15, 2025
| private readonly logger = new Logger(MonitoringController.name); | ||
|
|
||
| constructor() { | ||
| // Initialie the Prometheus registry |
There was a problem hiding this comment.
Suggested change
| // Initialie the Prometheus registry | |
| //Initialize the Prometheus registry |
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.
This pull request introduces a new monitoring and metrics system using the
prom-clientlibrary, adding metrics collection and exposing a/monitoring/metricsendpoint.Monitoring and Metrics System Integration:
Dependency Addition: Added
prom-clientas a new dependency inserver/package.jsonto enable Prometheus metrics collection.Monitoring 8000 Module: Introduced a new
MonitoringModuleinserver/src/metrics/monitoring/monitoring.module.ts, which includes:MonitoringServiceto define and update custom metrics. [1] [2]MonitoringControllerto expose a/monitoring/metricsendpoint for Prometheus scraping.MonitoringMiddlewareto ensure metrics are updated before serving the metrics endpoint.Application Module Updates:
Module Imports: Updated
server/src/app.module.tsto import and register theMonitoringModuleand the Prometheus integration module (@willsoto/nestjs-prometheus). [1] [2]Metrics Module Updates: Modified
server/src/metrics/metrics.module.tsto include theMonitoringModuleas a dependency, allowing it to integrate with existing metrics functionality.New Dependencies for Monitoring
prom-clientdependencies inserver/package.jsonto enable Prometheus metrics collection and integration. [1] [2]Monitoring Module Implementation
MonitoringModuleinserver/src/metrics/monitoring/monitoring.module.ts, which includes middleware, a service, and a controller for handling metrics. The module integrates with existing entities likeMetricandPrometheusQuery.Metrics Collection and Exposure
MonitoringServiceinserver/src/metrics/monitoring/monitoring.service.tsto define and register custom metrics using Prometheus. Metrics are updated dynamically and include labels for additional context.MonitoringControllerinserver/src/metrics/monitoring/monitoring.controller.tsto expose a/monitoring/metricsendpoint, which serves the collected metrics in Prometheus format.Middleware for Metrics Updates
MonitoringMiddlewareinserver/src/metrics/monitoring/monitoring.middleware.tsto ensure metrics are updated before responding to requests for the/monitoring/metricsendpoint.Module Integration
MonitoringModuleinto the mainAppModuleandMetricsModuleto make it part of the application's dependency graph. [1] [2] [3]Screenshots (if applicable)
Checklist: