Skip to content

GH-4617: Add registry characteristics (dimensionality, rate aggregation, publishing) to each registry doc#7600

Open
won-seoop wants to merge 1 commit into
micrometer-metrics:mainfrom
won-seoop:doc-registry-characteristics
Open

GH-4617: Add registry characteristics (dimensionality, rate aggregation, publishing) to each registry doc#7600
won-seoop wants to merge 1 commit into
micrometer-metrics:mainfrom
won-seoop:doc-registry-characteristics

Conversation

@won-seoop

Copy link
Copy Markdown

Summary

Closes #4617

The Supported Monitoring Systems overview page documents three important characteristics for each registry — dimensionality, rate aggregation model, and publishing model — but this information was not surfaced in the individual registry documentation pages. Users discovering a registry page directly (via search or a framework's link) would miss these behavioral differences.

Changes

Added a one-line NOTE to 15 registry-specific pages, each:

  1. States the registry's dimensionality (dimensional or hierarchical)
  2. States the rate aggregation model (client-side or server-side) with an xref to rate-aggregation.adoc
  3. States the publishing model (client-push or server-poll)
  4. Cross-links to implementations.adoc for a full side-by-side comparison
Registry Dimensional Rate Aggregation Publishing
AppOptics Dimensional Client-side Push
Atlas Dimensional Client-side Push
Azure Monitor Dimensional Client-side Push
CloudWatch Dimensional Client-side Push
Datadog Dimensional Client-side Push
Dynatrace Dimensional Client-side Push
Elastic Dimensional Client-side Push
Ganglia Hierarchical Client-side Push
Graphite Hierarchical Client-side Push
Humio Dimensional Client-side Push
JMX Hierarchical Client-side Push
KairosDB Dimensional Client-side Push
New Relic Dimensional Client-side Push
Prometheus Dimensional Server-side Poll
StatsD Mixed (flavor-dependent) Client-side Poll

Deprecated registries (SignalFx, Wavefront) are intentionally excluded.

Test plan

  • Verify AsciiDoc renders without errors
  • Check all xref links resolve correctly

🤖 Generated with Claude Code

…pecific docs

Add a one-line NOTE to each registry-specific documentation page
mentioning the three important characteristics from the 'Supported
Monitoring Systems' overview page:
- Dimensionality (dimensional vs hierarchical)
- Rate aggregation model (client-side vs server-side)
- Publishing model (client-push vs server-poll)

Each NOTE cross-links to the rate-aggregation.adoc concept page and
to the implementations.adoc overview for a side-by-side comparison.

Registries updated: AppOptics, Atlas, Azure Monitor, CloudWatch,
Datadog, Dynatrace, Elastic, Ganglia, Graphite, Humio, JMX, KairosDB,
New Relic, Prometheus, StatsD

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include the "three important characteristics" in registry-specific documentation

1 participant