Skip to content

Commit 085822f

Browse files
Polish
1 parent 21050d2 commit 085822f

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
lines changed

docs/modules/ROOT/pages/api.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
== Using Micrometer Tracing Directly
1+
= Using Micrometer Tracing Directly
22

33
In this section, we describe how to use the Micrometer Tracing API to directly create and report spans.
44

5-
=== Micrometer Tracing Examples
5+
== Micrometer Tracing Examples
66

77
The following example shows the basic operations on a span. Read the comments in the snippet for details:
88

@@ -25,7 +25,7 @@ The following example shows how to create a child span when explicitly knowing w
2525
include::{include-java}/tracing/TracingApiTests.java[tags=manual_span_joining,indent=0]
2626
-----
2727

28-
=== Micrometer Tracing Brave Setup
28+
== Micrometer Tracing Brave Setup
2929

3030
In this subsection, we set up Micrometer Tracing with Brave.
3131

@@ -36,7 +36,7 @@ The following example shows how to create a Micrometer Tracing `Tracer` by using
3636
include::{include-java}/tracing/TracingApiTests.java[tags=brave_setup,indent=0]
3737
-----
3838

39-
=== Micrometer Tracing OpenTelemetry Setup
39+
== Micrometer Tracing OpenTelemetry Setup
4040

4141
In this subsection, we set up Micrometer Tracing with OpenTelemetry (OTel).
4242

@@ -47,7 +47,7 @@ The following example shows how to create a Micrometer Tracing `Tracer` by using
4747
include::{include-java}/tracing/TracingApiTests.java[tags=otel_setup,indent=0]
4848
-----
4949

50-
=== Micrometer Tracing Baggage API
50+
== Micrometer Tracing Baggage API
5151

5252
Traces connect from application to application by using header propagation. Besides trace identifiers, other properties (called `Baggage`) can also be passed along with the request.
5353

@@ -65,7 +65,7 @@ IMPORTANT: For Brave, remember to set up the `PropagationFactory` so that it con
6565
include::{include-java}/tracing/TracingApiTests.java[tags=baggage_brave_setup,indent=0]
6666
-----
6767

68-
=== Aspect Oriented Programming
68+
== Aspect Oriented Programming
6969

7070
Micrometer Tracing contains `@NewSpan`, `@ContinueSpan`, and `@SpanTag` annotations that frameworks can use to create or customize spans for either specific types of methods such as those serving web request endpoints or, more generally, to all methods.
7171

docs/modules/ROOT/pages/configuring.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
== Configuring with Micrometer Observation
1+
= Configuring with Micrometer Observation
22

3-
=== Handler Configuration
3+
== Handler Configuration
44

55
// TODO: We need to separately document that Micrometer provides a TimerObservationHandler
66

@@ -36,13 +36,13 @@ It also results in the following trace view in (for example) Zipkin:
3636

3737
image::tracing/zipkin.jpg[Trace Info propagation]
3838

39-
==== Ordered Handler Configuration
39+
=== Ordered Handler Configuration
4040

4141
Micrometer Tracing comes with multiple `ObservationHandler` implementations.
4242
To introduce ordering, you can use the `ObservationHandler.AllMatchingCompositeObservationHandler` to run logic for all `ObservationHandler` instances that match the given predicate and `ObservationHandler`. Use `FirstMatchingCompositeObservationHandler` to run logic only for the first `ObservationHandler` that matches the predicate.
4343
The former can group handlers and the latter can be chosen to (for example) run only one matching `TracingObservationHandler`.
4444

45-
=== Context Propagation with Micrometer Tracing
45+
== Context Propagation with Micrometer Tracing
4646

4747
To make https://docs.micrometer.io/context-propagation/reference/[Context Propagation] work with Micrometer Tracing, you need to manually register the proper `ThreadLocalAccessor`, as follows:
4848

@@ -66,7 +66,7 @@ include::{include-integration-tests}/src/test/java/io/micrometer/tracing/test/co
6666
include::{include-integration-tests}/src/test/java/io/micrometer/tracing/test/contextpropagation/AbstractObservationAwareSpanThreadLocalAccessorTests.java[tags=docs,indent=0]
6767
-----
6868

69-
=== Exemplars
69+
== Exemplars
7070

7171
To add support for https://grafana.com/docs/grafana/latest/fundamentals/exemplars/[exemplars] instead of using the `DefaultMeterObservationHandler` you should use the `TracingAwareMeterObservationHandler`, as follows:
7272

docs/modules/ROOT/pages/glossary.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
== Glossary
1+
= Glossary
22

33
Micrometer Tracing contains a core module with an instrumentation https://en.wikipedia.org/wiki/Service_provider_interface[SPI], a set of modules containing bridges to various tracers, a set of modules containing dedicated span reporting mechanisms, and a test kit.
44
You need to understand the following definitions for distributed tracing:

docs/modules/ROOT/pages/reporters.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
== Supported Reporters
1+
= Supported Reporters
22

33
Micrometer Tracing supports directly the following Reporters.
44

55
* https://tanzu.vmware.com/observability[*Tanzu Observability by Wavefront*]
66
* https://zipkin.io[*OpenZipkin Zipkin*]
77
8-
=== Installing
8+
== Installing
99

1010
The following example shows the required dependency in Gradle (assuming that Micrometer Tracing BOM has been added):
1111

docs/modules/ROOT/pages/testing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
== Testing
1+
= Testing
22

33
Micrometer Tracing includes the `micrometer-tracing-test` and `micrometer-tracing-integration-test` modules.
44

@@ -15,7 +15,7 @@ It:
1515
** Sets it up with OpenZipkin Zipkin Exporter
1616
* Runs all the combinations above against the user code and running infrastructure
1717
18-
=== Installing
18+
== Installing
1919

2020
The following example shows the required dependency in Gradle (assuming that Micrometer Tracing BOM has been added):
2121

@@ -41,7 +41,7 @@ The following example shows the required dependency in Maven (assuming that Micr
4141
</dependency>
4242
-----
4343

44-
=== Running Tracing Unit Tests
44+
== Running Tracing Unit Tests
4545

4646
To run unit tests of your custom handler, you may want to use the `SimpleTracer` test `Tracer` implementation. Let's assume the following custom `TracingObservationHandler`:
4747

@@ -57,7 +57,7 @@ To verify whether the spans got properly created we can use the `SimpleTracer`,
5757
include::{include-java}/tracing/TracingTestingTests.java[tags=handler_test,indent=0]
5858
-----
5959

60-
=== Running integration tests
60+
== Running integration tests
6161

6262
The following example shows how you can run your code to test your integrations:
6363

docs/modules/ROOT/pages/tracers.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
== Supported Tracers
1+
= Supported Tracers
22

33
Micrometer Tracing supports the following Tracers.
44

55
* https://github.com/openzipkin/brave[*OpenZipkin Brave*]
66
* https://opentelemetry.io/[*OpenTelemetry*]
77
8-
=== Installing
8+
== Installing
99

1010
The following example shows the required dependency in Gradle (assuming that the Micrometer Tracing BOM has been added):
1111

0 commit comments

Comments
 (0)