Skip to content

Commit

Permalink
Relocate code-excerpt directive so it doesn't appear in page description
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Jul 12, 2024
1 parent b513556 commit 20d61ba
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 16 deletions.
3 changes: 1 addition & 2 deletions content/en/docs/languages/java/configuration.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Configuration
linkTitle: Configuration
weight: 10
aliases: [config]
weight: 10
# prettier-ignore
cSpell:ignore: authservice blrp Dotel ignore LOWMEMORY myservice ottrace PKCS retryable tracepropagators
---
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/java/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ weight: 50
cSpell:ignore: okhttp
---

{{% docs/languages/exporters/intro java %}}

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/exporters"?>

{{% docs/languages/exporters/intro java %}}

### Dependencies {#otlp-dependencies}

If you want to send telemetry data to an OTLP endpoint (like the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ weight: 50
cSpell:ignore: proxys
---

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

For most users, the out-of-the-box instrumentation is completely sufficient and
nothing more has to be done. Sometimes, however, users wish to create
[spans](/docs/concepts/signals/traces/#spans) for their own custom code without
Expand All @@ -16,6 +13,9 @@ If you add the `WithSpan` annotation to a method, the method is wrapped in a
span. The `SpanAttribute` annotation allows you to capture the method arguments
as attributes.

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

<!-- prettier-ignore-start -->
<?code-excerpt "src/main/java/otel/TracedClass.java"?>
```java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ cSpell:ignore: autoconfigurations
weight: 70
---

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

Instead of using the OpenTelemetry Spring starter, you can use the OpenTelemetry
autoconfiguration features with an annotation or the Zipkin starter.

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

## Spring support

Autoconfiguration is natively supported by Spring Boot applications. To enable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ weight: 40
cSpell:ignore: autoconfigurations autoconfigures logback webflux webmvc
---

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

Out of the box instrumentation is available for several frameworks:

| Feature | Property | Default Value |
Expand All @@ -21,6 +18,9 @@ Out of the box instrumentation is available for several frameworks:
| Micrometer | `otel.instrumentation.micrometer.enabled` | false |
| R2DBC (reactive JDBC) | `otel.instrumentation.r2dbc.enabled` | true |

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

## Common instrumentation configuration

Common properties for all database instrumentations:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ weight: 30
cSpell:ignore: customizer distro
---

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

This spring starter supports
[configuration metadata](https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html),
which means that you can see and autocomplete all available properties in your
IDE.

<!-- markdownlint-disable blanks-around-fences -->
<?code-excerpt path-base="examples/java/spring-starter"?>

## General configuration

The OpenTelemetry Starter supports all the
Expand Down

0 comments on commit 20d61ba

Please sign in to comment.