docs: clarify /metrics is JSON, not Prometheus#143
Merged
Conversation
pdf-amzn
approved these changes
May 29, 2026
e0538e5 to
3c8daa4
Compare
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
Correct the documentation to match reality:
/metricsreturns JSON, not Prometheus exposition format.Changes:
metrics-exporter-prometheusdependency.Why
Wiring local Grafana against ExtendDB, I expected Prometheus exposition format and got JSON. Match docs with whats implemented.
Closes # n/a
Testing done
Live
/metricscapture against a local server:Trimmed real response (field names and structure unmodified):
{ "metrics": [ { "metric": "SuccessfulRequestLatency", "dimensions": [{ "TableName": "abac-prod-c73b90ce" }, { "Operation": "CreateTable" }], "window": "LastDay", "sum": 11521.0, "count": 1, "min": 11521.0, "max": 11521.0 }, { "metric": "UserErrors", "dimensions": [{ "TableName": "extenddb-ie-test-cc0e7284" }, { "Operation": "DescribeTable" }], "window": "LastDay", "sum": 1.0, "count": 1, "min": 1.0, "max": 1.0 }, . . . ], "source": "database" }This is structured JSON with typed dimension keys, not line-oriented text with
# HELP/# TYPEheaders, so a Prometheus scraper cannot consume it.Checklist
cargo test --workspace) (no Rust source changed)cargo fmt --check) (no Rust source changed)cargo clippy -- -W clippy::pedantic) (no Rust source changed)Storagetrait, auth model, on-disk format, or public CLI surface, an RFC has been accepted or is linked below. Otherwise, an ADR captures the decision. (n/a, documentation)ADR / RFC: n/a
Breaking changes
None.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache License 2.0 and I agree to the Developer Certificate of Origin (DCO). See CONTRIBUTING.md for details.