Skip to content

Commit e3000b8

Browse files
authored
Update README.adoc (#40)
1 parent 80f92c5 commit e3000b8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Learn how to enable the collection of traces, metrics, and logs from microservic
3636

3737
In a microservices architecture, it can be difficult to understand how services interact, where latency occurs, and what causes failures. Without visibility across service boundaries, diagnosing issues and tuning performance can become slow and error-prone.
3838

39-
Observability helps address these challenges by capturing telemetry data such as logs, metrics, and traces. https://opentelemetry.io/[OpenTelemetry^] is an open source framework that provides APIs, SDKs, and tools for generating and managing this data. MicroProfile Telemetry adopts OpenTelemetry to enable both automatic and manual instrumentation in MicroProfile applications. Traces and metrics, along with runtime and application logs, can be exported in a standardized format through an OpenTelemetry Collector to any compatible backend.
39+
Observability helps address these challenges by capturing telemetry data such as logs, metrics, and traces. https://opentelemetry.io/[OpenTelemetry^] is an open source framework that provides APIs, SDKs, and tools for generating and managing this data. MicroProfile Telemetry uses OpenTelemetry to enable both automatic and manual instrumentation in MicroProfile applications. Traces and metrics, along with runtime and application logs, can be exported in a standardized format through an OpenTelemetry Collector to any compatible backend.
4040

4141
In this guide, you'll use the https://github.com/grafana/docker-otel-lgtm/?tab=readme-ov-file#docker-otel-lgtm[Grafana Docker OpenTelemetry LGTM^] image (`grafana/otel-lgtm`), an open source Docker image that provides a preconfigured observability backend for OpenTelemetry, based on the https://grafana.com/about/grafana-stack/[Grafana stack^]. This setup includes:
4242

@@ -296,7 +296,7 @@ inventory/bootstrap.properties
296296
include::finish/inventory/src/main/liberty/config/bootstrap.properties[]
297297
----
298298

299-
Setting the [hotspot=disabled file=2]`otel.sdk.disabled` property to `false` property in the https://openliberty.io/docs/latest/reference/bootstrap-properties.html[bootstrap properties^] file enables telemetry collection at the runtime level. This allows both runtime and application telemetry to be collected. If you instead configure this property at the application level, runtime telemetry will not be included. For more information, refer to the https://openliberty.io/docs/latest/microprofile-telemetry.html#global[MicroProfile Telemetry configuration documentation^].
299+
Setting the [hotspot=disabled file=2]`otel.sdk.disabled` property to `false` in the https://openliberty.io/docs/latest/reference/bootstrap-properties.html[bootstrap properties^] file enables telemetry collection at the runtime level. This allows both runtime and application telemetry to be collected. If you instead configure this property at the application level, runtime telemetry will not be included. For more information, refer to the https://openliberty.io/docs/latest/microprofile-telemetry.html#global[MicroProfile Telemetry configuration documentation^].
300300

301301
The [hotspot=service file=2]`otel.service.name` property sets the service name to `inventory`, helping identify the source of the telemetry data in monitoring tools like Grafana.
302302

@@ -395,7 +395,7 @@ When you see the following message, your Liberty instances are ready in dev mode
395395

396396
Dev mode holds your command-line session to listen for file changes. Open another command-line session to continue, or open the project in your editor.
397397

398-
Telemetry such as Liberty startup logs and JVM metrics is generated when the servers start. To see request-scoped telemetry, interact with the services.
398+
When the servers start, telemetry such as Liberty startup logs and JVM metrics is generated. To see request-scoped telemetry, interact with the services.
399399

400400
Visit the http://localhost:9081/inventory/systems/localhost URL to fetch and store the `localhost` system information in `inventory`, which triggers the `inventory` service to call the `system` service at `\http://localhost:9080/system/systemLoad`.
401401

@@ -420,7 +420,7 @@ View the trace that was automatically created from your request:
420420
+
421421
image::inventory_systems_localhost_trace.png[`GET /inventory/systems/{hostname}` trace,align="center"]
422422

423-
6. In the **Service & Operation** table, click each span to view detailed metadata. The `Kind` attribute identifies the span type. The first span is from the `inventory` service server handled by its Jakarta RESTful Web Services endpoint. The second span is from the MicroProfile REST Client in the `inventory` service with kind client calling the `system` service. The third span is from the `system` service server handled by its Jakarta RESTful Web Services endpoint.
423+
6. In the **Service & Operation** table, click each span to view detailed metadata. The `Kind` property identifies the span type. The first span is from the `inventory` service server, handled by its Jakarta RESTful Web Services endpoint. The second span is from the MicroProfile REST Client in the `inventory` service, with the `Kind` property set to `client`, calling the `system` service. The third span is from the `system` service server, handled by its Jakarta RESTful Web Services endpoint.
424424
+
425425
Each span includes details such as when the request was received, when the response was sent, the HTTP method, status code, and endpoint path, allowing you to trace the full request flow across services.
426426
+
@@ -482,7 +482,7 @@ image::red_metrics.png[RED Metrics,align="center"]
482482

483483
**Viewing application metrics**
484484

485-
View application-level metrics.
485+
View application-level metrics:
486486

487487
1. Navigate to **Drilldown -> Metrics** from the menu.
488488

0 commit comments

Comments
 (0)