Skip to content

Commit

Permalink
edits from peer review
Browse files Browse the repository at this point in the history
  • Loading branch information
dmuelle committed Sep 9, 2024
1 parent b3b7be5 commit 3a3f42a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions modules/ROOT/pages/microprofile-telemetry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Runtime-level configuration collects and emits telemetry from the runtime and al
You can configure your runtime instance in a few different sources, including your `jvm.options`, `bootstrap.properties`, or `server.env` files. You do not need to modify your application configuration to configure your runtime instance.

Application-level configuration::
Configuring application-level OpenTelemetry instances gives you more fine-grained control over the data you collect for each application. This option also supports configuration-compatibility with MicroProfile Telemetry 1.1 and earlier, which created only application-level SDK instances. Runtime-level data is not collected or emitted by application-level instances.
Configuring application-level OpenTelemetry instances gives you more fine-grained control over the data you collect for each application. This option also supports configuration compatibility with feature:mpTelemetry-1.1[display=MicroProfile Telemetry 1.1] and earlier, which created only application-level SDK instances. Runtime-level data is not collected or emitted by application-level instances.
+
You can configure your application-level OpenTelemetry instances in the `microprofile-config.properties` file or the `appProperties` attribute for the config:application[] element in the `server.xml` file. When you create application-level instances, any system and server environment properties overwrite your application-level configuration.

Expand All @@ -48,9 +48,9 @@ To enable MicroProfile Telemetry to collect and emit logs, metrics, and traces,

. Set the `otel.sdk.disabled=false` property at the runtime level or the application level.
+
At runtime initialization, if the `otel.sdk.disabled` property is set to false, the runtime-level OpenTelemetry SDK instance is created. If the runtime instance is not enabled and `otel.sdk.disabled=false` is specified at the application level, an application-level instance is created during application initialization.
At runtime initialization, if the `otel.sdk.disabled` property is set to `false`, the runtime-level OpenTelemetry SDK instance is created. If the runtime instance is not enabled and `otel.sdk.disabled=false` is specified at the application level, an application-level instance is created during application initialization.

.. To enable the OpenTelemetry SDK at the runtime level, set the `otel.sdk.disabled=false property` as a system property, for example, in the `bootstrap.properties` file:
.. To enable the OpenTelemetry SDK at the runtime level, set the `otel.sdk.disabled=false` property as a system property, for example, in the `bootstrap.properties` file:
+
----
otel.sdk.disabled=false
Expand All @@ -61,7 +61,7 @@ The `otel.service.name` property creates a name for any telemetry that this Open
+
Alternatively, you can set runtime-level configuration properties by using environment variables in your `server.env` file. For any property definition, make the key name uppercase and convert any punctuation to underscores. For example, the `otel.sdk.disabled=false` property is equivalent to the `OTEL_SDK_DISABLED=false` environment variable.

.. To enable the OpenTelemetry SDK at the application level, set the `otel.sdk.disabled=false property` in the `microprofile-config.properties` file of each application.
.. To enable the OpenTelemetry SDK at the application level, set the `otel.sdk.disabled=false` property in the `microprofile-config.properties` file of each application.
+
Application 1 `microprofile-config.properties` file:
+
Expand All @@ -77,7 +77,7 @@ otel.sdk.disabled=false
otel.service.name=A2
----
+
This configuration creates all telemetry from Application 1 with the service name A1, and from Application 2 with the service name A2. It omits all runtime-level telemetry.
This configuration creates all telemetry from Application 1 with the service name `A1`, and from Application 2 with the service name `A2`. It omits all runtime-level telemetry.

.. Optionally, use a combination of application-level and runtime-level configuration.
+
Expand Down Expand Up @@ -185,7 +185,7 @@ If you set this property to `console`, all the logs are exported to standard out
+
.. Configure MicroProfile Telemetry to use the OpenTelemetry Batch LogRecord Processor.
+
By default, the SimpleLogRecordProcessor is enabled, so the records are sent immediately. However, if you want to send the records in batches, you can also configure the following logging-specific Batch LogRecord Processor properties or environment variables:
By default, the `SimpleLogRecordProcessor` is enabled, so the records are sent immediately. However, if you want to send the records in batches, you can also configure the following logging-specific Batch LogRecord Processor properties or environment variables:
+
* `otel.blrp.schedule.delay` or `OTEL_BLRP_SCHEDULE_DELAY`
* `otel.blrp.max.queue.size` or `OTEL_BLRP_MAX_QUEUE_SIZE`
Expand Down

0 comments on commit 3a3f42a

Please sign in to comment.