Skip to content

Commit 459409f

Browse files
committed
Quarkus documentation formating
1 parent 026162e commit 459409f

File tree

3 files changed

+41
-24
lines changed

3 files changed

+41
-24
lines changed

content/en/docs/zero-code/java/quarkus/_index.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,21 @@ title: Quarkus
33
linkTitle: Quarkus
44
---
55

6-
[Quarkus](https://quarkus.io/) is an open-source framework designed to help software developers build efficient cloud-native applications both in JVM and native modes.
6+
[Quarkus](https://quarkus.io/) is an open source framework designed to help
7+
software developers build efficient cloud-native applications both in JVM and
8+
native modes.
79

8-
Quarkus uses extensions to provide optimized support for a wide range of libraries.
9-
The [Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry) provides:
10-
* Automatic instrumentation
11-
* OpenTelemetry SDK autoconfiguration, supporting almost all system properties defined for the [OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/configuration/)
12-
* [Vert.x](https://vertx.io/) based OTLP exporter
13-
* Can be used in JVM and native mode (where the Java agent doesn't work)
10+
Quarkus uses extensions to provide optimized support for a wide range of
11+
libraries. The
12+
[Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry)
13+
provides:
1414

15-
The Quarkus can also be instrumented with the [OpenTelemetry Java agent](../agent) but only on JVM mode.
15+
- Automatic instrumentation
16+
- OpenTelemetry SDK autoconfiguration, supporting almost all system properties
17+
defined for the
18+
[OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/configuration/)
19+
- [Vert.x](https://vertx.io/) based OTLP exporter
20+
- Can be used in JVM and native mode (where the Java agent doesn't work)
21+
22+
The Quarkus can also be instrumented with the
23+
[OpenTelemetry Java agent](../agent) but only on JVM mode.

content/en/docs/zero-code/java/quarkus/additional-documentation.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,15 @@ title: Additional Documentation
33
weight: 30
44
---
55

6-
The Quarkus documentation provides in-depth information on how to use Quarkus with OpenTelemetry.
6+
The Quarkus documentation provides in-depth information on how to use Quarkus
7+
with OpenTelemetry.
78

8-
* [Using OpenTelemetry guide](https://quarkus.io/guides/opentelemetry), the general reference including all **[configurations](https://quarkus.io/guides/opentelemetry#configuration-reference)**.
9-
* [Using OpenTelemetry Tracing](https://quarkus.io/guides/opentelemetry-tracing), the guide on how to **trace** your Quarkus application.
10-
* [Using OpenTelemetry Metrics](https://quarkus.io/guides/opentelemetry-metrics), the guide about OpenTelemetry **metrics** on Quarkus applications.
11-
* [Using OpenTelemetry Logs](https://quarkus.io/guides/opentelemetry-logging), the guide about OpenTelemetry **logs** on Quarkus applications.
9+
- [Using OpenTelemetry guide](https://quarkus.io/guides/opentelemetry), the
10+
general reference including all
11+
**[configurations](https://quarkus.io/guides/opentelemetry#configuration-reference)**.
12+
- [Using OpenTelemetry Tracing](https://quarkus.io/guides/opentelemetry-tracing),
13+
the guide on how to **trace** your Quarkus application.
14+
- [Using OpenTelemetry Metrics](https://quarkus.io/guides/opentelemetry-metrics),
15+
the guide about OpenTelemetry **metrics** on Quarkus applications.
16+
- [Using OpenTelemetry Logs](https://quarkus.io/guides/opentelemetry-logging),
17+
the guide about OpenTelemetry **logs** on Quarkus applications.

content/en/docs/zero-code/java/quarkus/getting-started.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@ title: Getting started with Quarkus
33
weight: 20
44
---
55

6+
To enable OpenTelemetry in your Quarkus application, add the
7+
`quarkus-opentelemetry` extension dependency to your project.
68

9+
{{< tabpane >}} {{< tab header="Maven (`pom.xml`)" lang=Maven >}}
710

8-
To enable OpenTelemetry in your Quarkus application, add the `quarkus-opentelemetry` extension dependency to your project.
9-
10-
{{< tabpane >}}
11-
{{< tab header="Maven (`pom.xml`)" lang=Maven >}}
12-
13-
```xml
11+
````xml
1412

1513
{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}
1614

@@ -19,7 +17,7 @@ To enable OpenTelemetry in your Quarkus application, add the `quarkus-openteleme
1917
<groupId>io.quarkus</groupId>
2018
<artifactId>quarkus-opentelemetry</artifactId>
2119
</dependency>
22-
```
20+
````
2321

2422
{{% /tab %}} {{% tab header="Gradle (`build.gradle`)" lang=Gradle %}}
2523

@@ -29,19 +27,24 @@ implementation("io.quarkus:quarkus-opentelemetry")
2927

3028
{{% /tab %}} {{< /tabpane>}}
3129

32-
Only the **tracing** signal will be enabled by default. To enable **metrics** and **logs**, you need to add the following configuration to your `application.properties` file:
30+
Only the **tracing** signal will be enabled by default. To enable **metrics**
31+
and **logs**, you need to add the following configuration to your
32+
`application.properties` file:
3333

3434
```properties
3535
quarkus.otel.metrics.enabled=true
3636
quarkus.otel.logs.enabled=true
3737
```
38-
OpenTelemetry logging is available after Quarkus 3.16.0.
3938

40-
The remaining configurations are available in the [Quarkus OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference).
39+
OpenTelemetry logging is available after Quarkus 3.16.0.
4140

41+
The remaining configurations are available in the
42+
[Quarkus OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference).
4243

4344
{{% alert title="Note" color="info" %}}
4445

45-
You can also use the [Java agent](../../agent) to instrument your Quarkus application in JVM mode. For the pros and cons, see [Java zero-code instrumentation](..).
46+
You can also use the [Java agent](../../agent) to instrument your Quarkus
47+
application in JVM mode. For the pros and cons, see
48+
[Java zero-code instrumentation](..).
4649

4750
{{% /alert %}}

0 commit comments

Comments
 (0)