317 Add Observability Stack for this project#319
Merged
sthanikan2000 merged 30 commits intomainfrom Dec 2, 2025
Merged
Conversation
3 tasks
ginaxu1
force-pushed
the
317-metrics
branch
3 times, most recently
from
d48d922 to
f1e297b
Compare
ginaxu1
changed the title
ginaxu1
force-pushed
the
317-metrics
branch
3 times, most recently
from
4972bf4 to
2e551ab
Compare
ginaxu1
changed the title
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
sthanikan2000
pushed a commit
that referenced
this pull request
Jan 13, 2026
* add OTEL-aware telemetry core that now registers HTTP runtime metrics * Refactor to exchange/pkg/monitoring * Add metrics to api-server-go * Add metrics to PDP and CE too * Add README for pkg/monitoring * Address PR comments * Update README * Address PR comments * add OTEL-aware telemetry core that now registers HTTP runtime metrics * Refactor to exchange/pkg/monitoring * Add metrics to PDP and CE too * Address PR comments * add monitoring for other services * Fix Build fail * Fix OE Unit tests * Remove unneeded files * Fix merge conflicts w main * Rewrite observability/ * revert changes to services, will add in next PR * more clean up, make PR smaller and focused only on adding observability/ folder * remove pkg/monitoring * Update observability/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update observability/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update observability/docker-compose.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update observability/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Address remaining comments * Address comments * Update README for observability, refernce superapp format * Fix merge conflict with main: * revert portal-backend/main.go to main version --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
THIS IS ONLY PART 1 of #317, in subsequent PRs will actually connect the services to use this observability stack
Summary
This PR introduces a centralized observability stack at repository root (
observability/) providing unified metrics collection and visualization for all Go services using Prometheus and Grafana; modeled after https://github.com/LSFLK/superapp-mobile/tree/main/observabilityWhy this is needed:
exchange/, less discoverableType of Change
Changes Made
Created
observability/docker-compose.yml- Prometheus + Grafana with data persistenceobservability/prometheus/prometheus.yml- All 5 service targets with labelsobservability/README.md- Complete documentation (metrics catalog, queries, troubleshooting)observability/grafana/dashboards/go-services-metrics.json- Pre-configured dashboardModified
exchange/monitoring/→observability/(root level)exchange/orchestration-engine-go/OBSERVABILITY.md,exchange/pkg/monitoring/README.mdService Coverage
All 5 Go services configured: orchestration-engine, consent-engine, policy-decision-point, api-server-go, audit-service
Testing
Validation Results:
Note:
api-server-goandaudit-serviceare in Prometheus config but may show DOWN until they expose/metricsendpoints.Checklist
Related Issues
This PR addresses the need for centralized observability across all services in the OpenDIF MVP project.
Quick Start
Access:
Service Metrics: All 5 services expose
/metrics(ports: 3000, 3001, 4000, 8081, 8082)Additional Notes
Metrics: All services using
exchange/pkg/monitoringexpose HTTP, external calls, workflows, business events, cache, and Go runtime metrics.Service Status:
/metricsendpoint)Deployment Notes
Local:
cd observability && docker compose up -d(data persists in volumes)Production: Current setup is for local dev only. For production: enable auth, network security, HA setup, consider managed services.
Migration:
exchange/monitoring/→observability/, container names:oe-*→opendif-*. No breaking changes.