Skip to content

docs: clarify MultiGauge row registration#7548

Merged
shakuzen merged 1 commit into
micrometer-metrics:1.15.xfrom
codingkiddo:docs/multigauge-overwrite
Jun 3, 2026
Merged

docs: clarify MultiGauge row registration#7548
shakuzen merged 1 commit into
micrometer-metrics:1.15.xfrom
codingkiddo:docs/multigauge-overwrite

Conversation

@codingkiddo

Copy link
Copy Markdown
Contributor

Summary

Clarifies MultiGauge row registration behavior in both the reference documentation and JavaDoc.

This adds more explanation around the overwrite argument used by MultiGauge.register(...), including how rows with the same tags are handled across repeated registrations and what happens when rows are no longer present.

Related issue

Fixes #4403

Notes

This is a documentation-only change. No runtime behavior is changed.

Validation

  • ./gradlew :micrometer-core:compileJava
  • ./gradlew :micrometer-core:test --tests "*MultiGauge*"
  • ./gradlew :micrometer-core:javadoc
  • ./gradlew checkFormat

@shakuzen shakuzen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for working on this. I left one piece of feedback. Could you also rebase onto 1.15.x and target the PR at that branch so we can include this in maintenance branches and merge forward from there?

Comment thread micrometer-core/src/main/java/io/micrometer/core/instrument/MultiGauge.java Outdated
@codingkiddo codingkiddo force-pushed the docs/multigauge-overwrite branch from e8ea4cd to 718dae1 Compare June 2, 2026 12:58
@codingkiddo codingkiddo changed the base branch from main to 1.15.x June 2, 2026 13:01
Signed-off-by: Vinod Kumar <codingkiddo@gmail.com>
@codingkiddo codingkiddo force-pushed the docs/multigauge-overwrite branch from 718dae1 to 8485d70 Compare June 2, 2026 13:07

@shakuzen shakuzen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great. Thank you.

@shakuzen shakuzen merged commit 4f12b9d into micrometer-metrics:1.15.x Jun 3, 2026
9 checks passed
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.

Multigauge Documentation lacks overwrite=true

2 participants