Document metrics published by the micrometer module#3370
Open
seonwoo-jung wants to merge 1 commit into
Open
Conversation
Adds a module-level README under micrometer/ that lists every metric emitted by MicrometerCapability (timers, counters, distribution summaries), its tags, and the observation emitted by MicrometerObservationCapability together with the keys carried by the default convention. The main README's Micrometer section now links to this reference. Fixes OpenFeign#2248
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.
Adds a new
micrometer/README.mdthat documents the metrics published byMicrometerCapabilityand the observation published byMicrometerObservationCapability, picking up the request from the maintainer in #2248.What's documented
MicrometerCapability— name, type (Timer / Counter / DistributionSummary), where it's recorded, and the per-metric extra tags. Covers thefeign.Feign.*,feign.Client.*,feign.AsyncClient.*,feign.codec.Encoder.*andfeign.codec.Decoder.*families.FeignMetricTagResolver(client,method,host,exception_name,root_cause_name).http.client.requestsobservation produced byMicrometerObservationCapability, the key values populated byDefaultFeignObservationConvention, and the additionalKeyNames declared onFeignObservationDocumentation.MeterRegistry/ common tags or a customFeignObservationConvention.The main
README.md's Micrometer section now links to the new module README so the existing example stays minimal.Notes for reviewers
feign.codec.Encoder.response_sizeis recorded byMeteredEncoderagainsttemplate.body().length, i.e. it actually measures the request body. The PR documents this honestly rather than silently aliasing or renaming.micrometer/src/main/java/feign/micrometer/rather than guesswork; happy to adjust wording if anything reads inaccurately.Fixes #2248