Spring/spring-amqp
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-1444: Observation Doc Gen Polishing

Browse Source 
- single task for spans and metrics
- always gen and remove packages from file names

* Fix link in What's New; add observation properties to container factory.
This commit is contained in:
Gary Russell
2022-10-21 16:54:40 -04:00
committed by GitHub
parent 77dfa657dd
commit 36e98a735f
7 changed files with 71 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/reference/asciidoc/_conventions.adoc
View File

@@ -1,11 +0,0 @@
[[observability-conventions]]
=== Observability - Conventions
Below you can find a list of all `GlobalObservabilityConventions` and `ObservabilityConventions` declared by this project.
.ObservationConvention implementations
|===
|ObservationConvention Class Name | Applicable ObservationContext Class Name
|`DefaultRabbitListenerObservationConvention`|`RabbitMessageReceiverContext`
|`DefaultRabbitTemplateObservationConvention`|`RabbitMessageSenderContext`
|===

44
src/reference/asciidoc/_metrics.adoc
View File

@@ -1,44 +0,0 @@
[[observability-metrics]]
=== Observability - Metrics
Below you can find a list of all samples declared by this project.
[[observability-metrics-listener-observation]]
==== Listener Observation
____
Observation for Rabbit listeners.
____
**Metric name** `spring.rabbit.listener` (defined by convention class `RabbitListenerObservation$DefaultRabbitListenerObservationConvention`). **Type** `timer` and **base unit** `seconds`.
Name of the enclosing class `RabbitListenerObservation`.
IMPORTANT: All tags must be prefixed with `spring.rabbit.listener` prefix!
.Low cardinality Keys
[cols="a,a"]
|===
|Name | Description
|`spring.rabbit.listener.id`|Listener id.
|===
[[observability-metrics-template-observation]]
==== Template Observation
____
Observation for `RabbitTemplate` s.
____
**Metric name** `spring.rabbit.template` (defined by convention class `RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention`). **Type** `timer` and **base unit** `seconds`.
Name of the enclosing class `RabbitTemplateObservation`.
IMPORTANT: All tags must be prefixed with `spring.rabbit.template` prefix!
.Low cardinality Keys
[cols="a,a"]
|===
|Name | Description
|`spring.rabbit.template.name`|Bean name of the template.
|===

38
src/reference/asciidoc/_spans.adoc
View File

@@ -1,38 +0,0 @@
[[observability-spans]]
=== Observability - Spans
Below you can find a list of all spans declared by this project.
[[observability-spans-listener-observation]]
==== Listener Observation Span
> Observation for Rabbit listeners.
**Span name** `spring.rabbit.listener` (defined by convention class `RabbitListenerObservation$DefaultRabbitListenerObservationConvention`).
Name of the enclosing class `RabbitListenerObservation`.
IMPORTANT: All tags and event names must be prefixed with `spring.rabbit.listener` prefix!
.Tag Keys
|===
|Name | Description
|`spring.rabbit.listener.id`|Listener id.
|===
[[observability-spans-template-observation]]
==== Template Observation Span
> Observation for `RabbitTemplate` s.
**Span name** `spring.rabbit.template` (defined by convention class `RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention`).
Name of the enclosing class `RabbitTemplateObservation`.
IMPORTANT: All tags and event names must be prefixed with `spring.rabbit.template` prefix!
.Tag Keys
|===
|Name | Description
|`spring.rabbit.template.name`|Bean name of the template.
|===

8
src/reference/asciidoc/appendix.adoc
View File

@@ -2,17 +2,17 @@
[[observation-gen]]
== Micrometer Observation Documentation
include::_metrics.adoc[]
include::../docs/generated/metrics.adoc[]
include::_spans.adoc[]
include::../docs/generated/spans.adoc[]
include::_conventions.adoc[]
include::../docs/generated/conventions.adoc[]
[appendix]
[[change-history]]
== Change History
This section describes what changes have been made as versions have changed.
This section describes changes that have been made as versions have changed.
=== Current Release

2
src/reference/asciidoc/whats-new.adoc
View File

@@ -14,7 +14,7 @@ The remoting feature (using RMI) is no longer supported.
==== Observation
Enabling observation for timers and tracing using Micrometer is now supported.
See <<observation>> for more information.
See <<micrometer-observation>> for more information.
==== AsyncRabbitTemplate