FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: cover typed family descriptors and @StableApi since v1.6.1 by zeitlinger · Pull Request #2181 · prometheus/client_java · GitHub

docs: cover typed family descriptors and @StableApi since v1.6.1 - #2181

Merged
zeitlinger merged 2 commits into
mainfrom
docs/post-1.6.1
Jun 4, 2026
Merged

docs: cover typed family descriptors and @StableApi since v1.6.1#2181
zeitlinger merged 2 commits into
mainfrom
docs/post-1.6.1

Conversation

Copy link
Copy Markdown
Member

Summary

  • update getting-started/registry.md to recommend getMetricFamilyDescriptor() for custom collectors, with a short example and a note that the fragmented getPrometheusName()/getMetricType()/getLabelNames()/getMetadata() methods are deprecated but still bridged
  • update internals/model.md to reference getMetricFamilyDescriptor()
  • add internals/stability.md covering @StableApi, mise run api-diff, the baseline tracked in pom.xml (Renovate-managed) with diffs under docs/apidiffs/, and the breaking-api-change-accepted label

Covers user-facing changes since v1.6.1:

Test plan

  • preview rendered docs locally
  • verify intra-doc links resolve

Update registry and model docs to point custom collectors at
getMetricFamilyDescriptor(), noting the deprecated fragmented
metadata methods bridge for compatibility.

Add an internals/stability page covering @stableAPI, the
mise run api-diff baseline check, and the
breaking-api-change-accepted label.

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
zeitlinger marked this pull request as ready for review June 3, 2026 16:48
zeitlinger enabled auto-merge (squash) June 4, 2026 12:20
zeitlinger merged commit 7ca9f99 into main Jun 4, 2026
16 checks passed
zeitlinger deleted the docs/post-1.6.1 branch June 4, 2026 19:52
zeitlinger added a commit that referenced this pull request Jun 11, 2026
🤖 I have created a release *beep* *boop*
---


##
[1.8.0](v1.7.0...v1.8.0)
(2026-06-11)


### Features

* Add custom labels to exemplars
([#2191](#2191))
([fd1f3e8](fd1f3e8))
* add MetricMetadata.Builder, deprecate wide constructors
([#2202](#2202))
([adeef32](adeef32))


### Bug Fixes

* Avoid unnuecessary exemplar allocations
([#2209](#2209))
([0b6a91f](0b6a91f))
* **deps:** update spring boot to v4.1.0
([#2213](#2213))
([df25c08](df25c08))


### Documentation

* cover typed family descriptors and @stableAPI since v1.6.1
([#2181](#2181))
([7ca9f99](7ca9f99))

---
> [!IMPORTANT]
> Close and reopen this PR to trigger CI checks.

---------

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants


Back | FazBrowse Home | New Git URL