Skip to content

OpenMetrics 2.0: Migration Guide#2908

Merged
bwplotka merged 5 commits intomainfrom
owilliams/om2-migration
Apr 1, 2026
Merged

OpenMetrics 2.0: Migration Guide#2908
bwplotka merged 5 commits intomainfrom
owilliams/om2-migration

Conversation

@ywwg
Copy link
Copy Markdown
Member

@ywwg ywwg commented Mar 19, 2026

Migration guide for SDK authors on how to update SDKs for OM2.0

claude did the initial drafting and then I went over it carefully and refined / corrected based on my own understanding.

@ywwg ywwg force-pushed the owilliams/om2-migration branch from 8edfbbb to 9aaafa1 Compare March 19, 2026 17:10
@ywwg ywwg marked this pull request as ready for review March 19, 2026 17:46
@ywwg ywwg changed the title OpenMetrics 2.0: Migration Guide first draft OpenMetrics 2.0: Migration Guide Mar 20, 2026
@ywwg ywwg requested a review from bwplotka March 20, 2026 19:52
@ywwg
Copy link
Copy Markdown
Member Author

ywwg commented Mar 20, 2026

Addressed comments, including the new definition of "breaking" (which is, something that used to be valid in om 1.0 that is invalid in om 2.0)

dashpole
dashpole previously approved these changes Mar 24, 2026
Copy link
Copy Markdown
Contributor

@dashpole dashpole left a comment

Choose a reason for hiding this comment

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

Just some non-blocking editorial comments

@ywwg
Copy link
Copy Markdown
Member Author

ywwg commented Mar 25, 2026

hilariously, almost all of your comments were for text I added after the LLM did its thing :).

applied the notes and made a couple other tweaks

@ywwg ywwg requested a review from dashpole March 25, 2026 15:30
dashpole
dashpole previously approved these changes Mar 28, 2026
@ywwg
Copy link
Copy Markdown
Member Author

ywwg commented Mar 30, 2026

squashed down

krajorama
krajorama previously approved these changes Mar 30, 2026
Copy link
Copy Markdown
Member

@krajorama krajorama left a comment

Choose a reason for hiding this comment

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

LGTM

@ywwg ywwg requested review from bwplotka and dashpole March 30, 2026 15:50
@ywwg ywwg force-pushed the owilliams/om2-migration branch from 00cef43 to f5743f7 Compare March 30, 2026 16:47
dashpole
dashpole previously approved these changes Mar 30, 2026
Copy link
Copy Markdown
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

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

Just started detailed pass.

I propose we improve it a bit before merging. It needs more human touch IMO, for better accessibility, consistency. There are some AI odd pieces here. 🤔

It just doesn't pass my (personal) quality bar

Happy to help, propose changes this week!

@bwplotka bwplotka dismissed stale reviews from dashpole and krajorama via 8b61d96 April 1, 2026 13:41
bwplotka
bwplotka previously approved these changes Apr 1, 2026

This guide covers the changes from OpenMetrics (OM) 1.0 to OpenMetrics 2.0 that affect client library (i.e. exposers) implementations. Sections are organized so you can implement changes incrementally, starting with version negotiation and working through metric types, syntax, and metadata. This guide may contain errors, and in any case where this document disagrees with the spec document, **the spec document is the authoritative source of truth**.

> WARNING: OpenMetrics 2.0 is currently experimental (release candidate versions), so some details might change. Track progress at the [OpenMetrics 2.0 work group issue](https://github.com/prometheus/OpenMetrics/issues/276).
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.

Suggested change
> WARNING: OpenMetrics 2.0 is currently experimental (release candidate versions), so some details might change. Track progress at the [OpenMetrics 2.0 work group issue](https://github.com/prometheus/OpenMetrics/issues/276).
> NOTE: OpenMetrics 2.0 is currently experimental (release candidate versions), so some details might change. Track progress at the [OpenMetrics 2.0 work group issue](https://github.com/prometheus/OpenMetrics/issues/276).

Migration guide for SDK authors on how to update SDKs for OM2.0

Signed-off-by: Owen Williams <owen.williams@grafana.com>
@ywwg ywwg force-pushed the owilliams/om2-migration branch from 44c2fb0 to 138a70a Compare April 1, 2026 13:52
Signed-off-by: Owen Williams <owen.williams@grafana.com>
bwplotka and others added 2 commits April 1, 2026 14:59
Signed-off-by: Bartlomiej Plotka <bwplotka@gmail.com>
@bwplotka bwplotka merged commit 5ecc1b9 into main Apr 1, 2026
2 checks passed
@bwplotka bwplotka deleted the owilliams/om2-migration branch April 1, 2026 14:01
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.

4 participants