feat: restore OpenTelemetry metrics with v1.20+ compatibility #3769
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
- Added vcpkg override to fix opentelemetry-cpp at version 1.2.0 - Created docs/METRICS_ENABLE.md with complete setup guide - Updated docs/metrics-investigation.md with compilation findings - Reason: OpenTelemetry v1.20+ has breaking API changes (unique_ptr -> shared_ptr) - This allows FEATURE_METRICS to compile without code changes
Add helper scripts and documentation to enable metrics feature: New files: - scripts/build_with_metrics.sh: Automated build with FEATURE_METRICS=ON - scripts/start_monitoring.sh: Start Prometheus + Grafana stack - docs/METRICS.md: Quick start guide for metrics Features: - Validates prerequisites (VCPKG_ROOT, docker) - Compiles with OpenTelemetry v1.2.0 (fixed version) - Clear instructions and error messages - Zero changes to existing code or default behavior Usage: ./scripts/build_with_metrics.sh ./scripts/start_monitoring.sh This is a safe, non-intrusive addition that only adds tooling. No existing files modified. Default build unchanged.
Resolved compilation issues with FEATURE_METRICS: API Changes: - Fixed SetMeterProvider to use shared_ptr instead of unique_ptr (OpenTelemetry v1.20+) - Added missing include account_repository.hpp in iologindata.cpp Dependencies: - Removed version override (now uses v1.20.0 from vcpkg baseline) - Kept otlp-http and prometheus features enabled Build Scripts: - Fixed binary path detection in build_with_metrics.sh Result: - ✅ Compiles successfully with FEATURE_METRICS=ON - ✅ Binary tested and working (131MB) - ✅ Compatible with current vcpkg baseline Tested with: - OpenTelemetry-cpp v1.20.0 - GCC 14.2.0 - vcpkg baseline d6995a0cf3cafda5e9e52749fad075dd62bfd90c
|
|
I'll test it, but I had difficulty with port 9464; I couldn't resolve it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Restores the OpenTelemetry/Prometheus metrics feature that was disabled in commit
0c0e5467bdue to compilation issues. This PR fixes API compatibility with OpenTelemetry v1.20+, adds automation scripts, and provides comprehensive documentation.Background
The metrics feature was originally implemented in #1966 but was disabled by default after API breaking changes in OpenTelemetry caused compilation errors. This PR addresses those issues and makes the feature production-ready.
Changes Made
Code Fixes
unique_ptr→shared_ptrconversion)account_repository.hppinclude iniologindata.cppvcpkg.jsonto properly declare OpenTelemetry featuresAutomation
scripts/build_with_metrics.sh: Automated build script with metrics enabledscripts/start_monitoring.sh: One-command Prometheus + Grafana stack launcherDocumentation
docs/METRICS.md: Quick-start guide for the metrics featuredocs/METRICS_ENABLE.md: Detailed enablement and troubleshooting guideTesting
http://localhost:9464/metricsCompatibility
FEATURE_METRICS=OFF(no breaking changes)Configuration
To enable metrics:
Security & Performance
Future Work
References
9d6099361(initial),0c0e5467b(disabled),c5a2b08af(vcpkg)Checklist
Note: This is an optional feature that requires explicit opt-in. No changes to default server behavior.