Skip to content

Add documentation for Observability #3896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 6, 2022

Conversation

artembilan
Copy link
Member

  • Adapt Observation code to the latest dependencies
  • Add doc generation tasks for meters and spans
  • Document new Observation API features
  • Include generated meters and spans docs to a general metrics.adoc chapter

@artembilan
Copy link
Member Author

/CC @marcingrzejszczak

@artembilan artembilan marked this pull request as draft September 27, 2022 13:59
@artembilan artembilan force-pushed the Observation_docs branch 3 times, most recently from 42ae292 to af575ad Compare September 30, 2022 15:00
Copy link
Contributor

@onobc onobc left a comment

Choose a reason for hiding this comment

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

@artembilan

I am glad I saw this PR. It has a couple of things I can leverage in spring-pulsar - thanks for that.

  1. The removal of package tangles
  2. The package/name reduction to o.s.i for the generated docs

LGTM.

build.gradle Outdated
@@ -84,8 +87,8 @@ ext {
lettuceVersion = '6.2.0.RELEASE'
log4jVersion = '2.19.0'
mailVersion = '2.0.1'
micrometerVersion = '1.10.0-M6'
micrometerTracingVersion = '1.0.0-M8'
micrometerVersion = '1.10.0-SNAPSHOT'
Copy link
Contributor

Choose a reason for hiding this comment

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

[TinyNit] indentation

* Adapt Observation code to the latest dependencies
* Add doc generation tasks for meters and spans
* Document new Observation API features
* Include generated meters and spans docs to a general `metrics.adoc` chapter
* Make Observation doc generation tasks only as local.
We don't need ambiguous changes to source code on CI
…ld phase

* Replace 'org.springframework.integration' content in the generated files with a 'o.s.i'
to make it easier to read, especially in the tables
* Break `DefaultMessageReceiverObservationConvention <=> IntegrationObservation` classes tangle
using literal for `KeyValues` in the `DefaultMessageReceiverObservationConvention`
instead of nested enums from the `IntegrationObservation`
* Some other minor build script clean up
@artembilan artembilan marked this pull request as ready for review October 6, 2022 14:40
@artembilan artembilan requested a review from garyrussell October 6, 2022 14:40
@garyrussell garyrussell merged commit f24fbd9 into spring-projects:main Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants