docs: cover typed family descriptors and @StableApi since v1.6.1#2181
Open
zeitlinger wants to merge 1 commit into
Open
docs: cover typed family descriptors and @StableApi since v1.6.1#2181zeitlinger wants to merge 1 commit into
zeitlinger wants to merge 1 commit into
Conversation
zeitlinger
force-pushed
the
docs/post-1.6.1
branch
from
9f1a59d to
256f7e5
Compare
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
force-pushed
the
docs/post-1.6.1
branch
from
256f7e5 to
992d83d
Compare
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
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
getting-started/registry.mdto recommendgetMetricFamilyDescriptor()for custom collectors, with a short example and a note that the fragmentedgetPrometheusName()/getMetricType()/getLabelNames()/getMetadata()methods are deprecated but still bridgedinternals/model.mdto referencegetMetricFamilyDescriptor()internals/stability.mdcovering@StableApi,mise run api-diff, the baseline tracked inpom.xml(Renovate-managed) with diffs underdocs/apidiffs/, and thebreaking-api-change-acceptedlabelCovers user-facing changes since v1.6.1:
@StableApimarker and API diff checkTest plan