Rename DocumentedObservation to ObservationDocumentation #3430
Conversation
This file contains 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
shakuzen
added
type: task
shakuzen
added
the
module: micrometer-core
marcingrzejszczak
approved these changes
Sep 26, 2022
jonatan-ivanov
approved these changes
Sep 26, 2022
The previous naming implied that it was a type of `Observation` but it is rather the documentation for observations. The goal of this new naming is to make that more clear. It also improves consistency with the naming of most of the methods, though some inconsistency remains, which we can address in a follow-up change.
Similar to the renaming of DocumentedObservation to ObservationDocumentation. This helps avoid confusion that this is not a type of Meter but rather documentation for a Meter.
shakuzen
force-pushed
the
observationdocumentation
branch
from
b3ab1f5 to
bd41f3d
Compare
|
|
shakuzen
added a commit
to shakuzen/tracing
that referenced
this pull request
Sep 27, 2022
This aligns the naming with the recent change in the micrometer repository for ObservationDocumentation and MeterDocumentation. See micrometer-metrics/micrometer#3430
shakuzen
added a commit
to shakuzen/tracing
that referenced
this pull request
Sep 27, 2022
This aligns the naming with the recent change in the micrometer repository for ObservationDocumentation and MeterDocumentation. See micrometer-metrics/micrometer#3430
shakuzen
added a commit
to micrometer-metrics/tracing
that referenced
this pull request
Sep 27, 2022
This aligns the naming with the recent change in the micrometer repository for ObservationDocumentation and MeterDocumentation. See micrometer-metrics/micrometer#3430
shakuzen
added a commit
to micrometer-metrics/micrometer-docs-generator
that referenced
this pull request
Sep 27, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The previous naming implied that it was a type of
Observationbut it is rather the documentation for observations. The goal of this new naming is to make that more clear. It also improves consistency with the naming of most of the methods, though some inconsistency remains, which we can address in a follow-up change.For the same reasons and consistency, this also renames DocumentedMeter to MeterDocumentation.
This will require an update to instrumentation using
DocumentedObservation, which should be achievable with a find-and-replace search of the source code.The micrometer-docs-generator will need to be updated as well.