Skip to content

Document DefaultMeterObservationHandler#7261

Merged
shakuzen merged 1 commit intomicrometer-metrics:1.15.xfrom
seonghyeoklee:gh-6361
Mar 9, 2026
Merged

Document DefaultMeterObservationHandler#7261
shakuzen merged 1 commit intomicrometer-metrics:1.15.xfrom
seonghyeoklee:gh-6361

Conversation

@seonghyeoklee
Copy link
Copy Markdown
Contributor

Summary

  • Add documentation for DefaultMeterObservationHandler to the Observation Components page
  • Explain the three meter types it creates from Observations:
    • Timer (<name>) - records duration on stop, with low cardinality tags + error tag
    • LongTaskTimer (<name>.active) - tracks in-progress duration from start
    • Counter (<name>.<event>) - incremented on event signals
  • Include notes about low cardinality vs high cardinality key values and the LongTaskTimer tag timing caveat
  • Add code examples demonstrating basic usage and IgnoredMeters.LONG_TASK_TIMER configuration

Test plan

  • Doc test examples compile successfully
  • Code formatting passes (checkFormat)

Closes gh-6361

Copy link
Copy Markdown
Member

@shakuzen shakuzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thank you very much. I'll rebase the PR on 1.15.x so we can include this in that documentation and merge it forward to other branches.

Add documentation for DefaultMeterObservationHandler to the Observation
Components page, explaining the metrics it creates from Observations:

- Timer (<name>) on stop, with low cardinality tags and error tag
- LongTaskTimer (<name>.active) on start, tracking in-progress duration
- Counter (<name>.<event>) on event signals

Include code examples showing basic usage and how to disable
LongTaskTimer via IgnoredMeters.

Closes micrometer-metricsgh-6361

Signed-off-by: seonghyeoklee <[email protected]>
@shakuzen shakuzen changed the base branch from main to 1.15.x March 9, 2026 02:32
@shakuzen shakuzen enabled auto-merge (squash) March 9, 2026 02:32
@shakuzen shakuzen merged commit b2c9cd6 into micrometer-metrics:1.15.x Mar 9, 2026
7 checks passed
etrandafir93 pushed a commit to etrandafir93/micrometer that referenced this pull request Mar 21, 2026
Add documentation for DefaultMeterObservationHandler to the Observation
Components page, explaining the metrics it creates from Observations:

- Timer (<name>) on stop, with low cardinality tags and error tag
- LongTaskTimer (<name>.active) on start, tracking in-progress duration
- Counter (<name>.<event>) on event signals

Include code examples showing basic usage and how to disable
LongTaskTimer via IgnoredMeters.

Closes micrometer-metricsgh-6361

Signed-off-by: seonghyeoklee <[email protected]>
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.

Document (Default)MeterObservationHandler

2 participants