feat(sdk): Add Prometheus exposition format export#48
Merged
Conversation
- Add 'prometheus' feature flag to buswatch-sdk - Add prometheus.rs module with PrometheusConfig, PrometheusExporter - Implement format_prometheus() for Prometheus text exposition format - Add HTTP server using hyper to serve /metrics endpoint - Add Output::prometheus() variant and integration with Instrumentor - Include /health and /healthz endpoints for liveness checks Metrics exported: - buswatch_read_count (counter) - buswatch_write_count (counter) - buswatch_read_backlog (gauge) - buswatch_read_pending_seconds (gauge) - buswatch_write_pending_seconds (gauge) - buswatch_read_rate_per_second (gauge) - buswatch_write_rate_per_second (gauge) - buswatch_snapshot_timestamp_seconds (gauge) All metrics include module and topic labels. Closes #10
- Update buswatch-sdk/README.md with Prometheus output section and feature table - Add Prometheus integration example to SDK README - Update main README.md features list to include Prometheus - Add Prometheus feature to CHANGELOG under Unreleased
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.
Summary
Adds support for exporting metrics in Prometheus text-based exposition format, enabling scraping by Prometheus or compatible monitoring systems.
Changes
prometheusfeature flag to buswatch-sdkprometheus.rsmodule with:PrometheusConfigbuilder for configurationPrometheusExporterfor storing and rendering metricsformat_prometheus()function to convert snapshots to Prometheus formatOutput::prometheus()variant/healthand/healthzendpoints for Kubernetes probesMetrics Exported
buswatch_read_count(counter) - Total messages readbuswatch_write_count(counter) - Total messages writtenbuswatch_read_backlog(gauge) - Unread message countbuswatch_read_pending_seconds(gauge) - Read wait timebuswatch_write_pending_seconds(gauge) - Write wait timebuswatch_read_rate_per_second(gauge) - Read throughputbuswatch_write_rate_per_second(gauge) - Write throughputbuswatch_snapshot_timestamp_seconds(gauge) - Snapshot timestampAll metrics include
moduleandtopiclabels.Usage
Closes #10