Added native section in the docs #3
Conversation
marcingrzejszczak
added
the
documentation
| @@ -359,6 +361,12 @@ class MyConfiguration { | |||
| } | |||
| ---- | |||
|
|
|||
| === Limitations | |||
|
|
|||
| The Spring Boot AutoConfiguration for WebMvc Observability is not yet there - that's why we needed to set things up manually. For more information check this https://github.com/spring-projects/spring-boot/issues/32538[issue]. | |||
There was a problem hiding this comment.
Change to:
The Spring Boot AutoConfiguration for WebMvc Observability is not yet ready. As a result, we need to set things up manually. For more information, see this https://github.com/spring-projects/spring-boot/issues/32538[issue].
|
|
||
| The Spring Boot AutoConfiguration for WebMvc Observability is not yet there - that's why we needed to set things up manually. For more information check this https://github.com/spring-projects/spring-boot/issues/32538[issue]. | ||
|
|
||
| For the Spring Boot Exemplars AutoConfiguration to work properly we need to wait for https://github.com/spring-projects/spring-boot/pull/32399[this PR] and https://github.com/spring-projects/spring-boot/pull/32415[this PR] to be merged. Until then we need to create https://github.com/marcingrzejszczak/observability-boot-blog-post/blob/main/server/src/main/java/com/example/server/ExemplarsConfiguration.java[such configuration] manually. |
There was a problem hiding this comment.
Add commas after "work properly" and "Until then"
| @@ -427,12 +435,105 @@ If you want to see the metrics from your Observation that you have manually crea | |||
|
|
|||
| image::https://raw.githubusercontent.com/marcingrzejszczak/observability-boot-blog-post/main/docs/src/main/asciidoc/img/my-observation.png[] | |||
|
|
|||
| == Running It All Together using Spring Native | |||
|
|
|||
| To better understand how Spring Boot supports Native please read https://spring.io/blog/2022/09/26/native-support-in-spring-boot-3-0-0-m5[this excellent blog post]. We will reuse that knowledge to run the previously created applications using Spring Native. | |||
There was a problem hiding this comment.
Add a comma after "supports Native" and remove "will"
| $ ./client/target/client | ||
| ---- | ||
|
|
||
| You should get a similar output to this one |
There was a problem hiding this comment.
Change to:
You should get output similar to this:
| 2022-10-10T12:57:17.820+02:00 INFO [server,,] 81760 --- [nio-7654-exec-8] com.example.server.MyHandler : After running the observation for context [http.server.requests] | ||
| ---- | ||
|
|
||
| You can check Grafana for metrics and traces. Read the limitations section below on why you won't find any pushed logs to Loki. |
There was a problem hiding this comment.
Turn "limitations section" into a link and remove "below" (which you won't need, thanks to the link).
| 2022-10-10T12:57:17.820+02:00 INFO [server,,] 81760 --- [nio-7654-exec-8] com.example.server.MyHandler : After running the observation for context [http.server.requests] | ||
| ---- | ||
|
|
||
| You can check Grafana for metrics and traces. Read the limitations section below on why you won't find any pushed logs to Loki. |
There was a problem hiding this comment.
Turn "limitations section" into a link and remove "below" (which you won't need, thanks to the link).
|
|
||
| === Native Support Limitations | ||
|
|
||
| You will not see logs being pushed to Loki just yet. For more information look into https://github.com/spring-projects/spring-boot/issues/25847[this issue]. |
There was a problem hiding this comment.
Add a comma after "For more information"
|
|
||
| You will not see logs being pushed to Loki just yet. For more information look into https://github.com/spring-projects/spring-boot/issues/25847[this issue]. | ||
|
|
||
| On the client side we needed to provide the `reflect-config.js` configuration manually. For more information look into https://github.com/open-telemetry/opentelemetry-java/pull/4832[this PR]. |
There was a problem hiding this comment.
Change to:
On the client side, we need to provide the reflect-config.js configuration manually. For more information, see open-telemetry/opentelemetry-java#4832 PR].
| = Summary | ||
|
|
||
| In this blog post, we have managed to give you an introduction of the main concepts behind the Micrometer Observability API. We have also shown you how you can create observations by using the Observation API and annotations. You were also able to visualize the latency, see the correlated logs, and check the metrics that come from you Spring Boot applications. | ||
|
|
||
| You were also able to observe your applications using native images via Spring Native. |
There was a problem hiding this comment.
Change to:
You could also able observe your applications by using native images with Spring Native.
| = Next Steps | ||
|
|
||
| Based on community feedback, we will continue to improve our Observability story. We intend to go GA in November this year. | ||
|
|
||
| This is an exciting time for us. We would again like to thank everyone who has already contributed and reported feedback, and we look forward to further feedback! | ||
| This is an exciting time for us. We would again like to thank everyone who has already contributed and reported feedback, and we look forward to further feedback (don't hesitate to check out Spring Boot's latest snapshots)! |
There was a problem hiding this comment.
Change to:
This is an exciting time for us. We would again like to thank everyone who has already contributed and reported feedback, and we look forward to further feedback! Check out Spring Boot's latest snapshots!
|
Done via f531925 |
No description provided.