Skip to content

Commit

Permalink
Merge pull request #7767 from OpenLiberty/staging
Browse files Browse the repository at this point in the history
Staging to vNExt 240012 docs
  • Loading branch information
ramkumar-k-9286 authored Dec 2, 2024
2 parents 10636fe + 2fa0888 commit 6afbeb4
Show file tree
Hide file tree
Showing 33 changed files with 1,104 additions and 422 deletions.
11 changes: 6 additions & 5 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@
** xref:distributed-session-caching.adoc[Distributed session caching]
** xref:configuring-infinispan-support.adoc[Configuring Infinispan as a JCache provider]
* xref:observability.adoc[Observability]
** xref:prepare-mptelemetry.adoc[Prepare your development environment for MicroProfile Telemetry]
// ** xref:prepare-mptelemetry.adoc[Prepare your development environment for MicroProfile Telemetry]
** xref:custom-mptelemetry-metrics.adoc[Define custom MicroProfile Telemetry metrics]
** xref:telemetry-trace.adoc[Code instrumentation for MicroProfile Telemetry tracing]
** xref:mptelemetry-logging.adoc[Write logs with MicroProfile Telemetry logging]
** xref:microservice-observability-metrics.adoc[Microservice observability with with MicroProfile Metrics]
** xref:micrometer-metrics.adoc[Choose your own monitoring tools with MicroProfile Metrics]
// ** xref:mptelemetry-logging.adoc[Write logs with MicroProfile Telemetry logging]
** xref:microservice-observability-metrics.adoc[Microservice observability with MicroProfile Metrics]
*** xref:micrometer-metrics.adoc[Choose your own monitoring tools with MicroProfile Metrics]
** xref:health-check-microservices.adoc[Health checks for microservices]
** https://openliberty.io/guides/#observability[Guides: Observability]
* xref:integration-testing.adoc[Testing]
Expand Down Expand Up @@ -116,7 +116,6 @@
// Begin operations section
.Operations
* xref:microprofile-telemetry.adoc[Enable observability with MicroProfile Telemetry]
* xref:log-trace-configuration.adoc[Logs]
** xref:log-management.adoc[Log management]
** xref:access-logging.adoc[HTTP access logging]
Expand All @@ -132,6 +131,8 @@
** xref:metrics-list.adoc[MicroProfile Metrics reference list]
** xref:configuring-jmx-connection.adoc[Configuring JMX connections]
** xref:jmx-metrics-list.adoc[JMX metrics reference list]
* xref:microprofile-telemetry.adoc[OpenTelemetry]
** xref:telemetry-troubleshooting.adoc[Troubleshooting OpenTelemetry]
* xref:slow-hung-request-detection.adoc[Slow and hung request detection]
* xref:validating-server-connections.adoc[Validating server connections]
* xref:admin-center.adoc[Admin Center GUI]
Expand Down
8 changes: 4 additions & 4 deletions modules/ROOT/pages/custom-mptelemetry-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@

You can use the OpenTelemetry metrics API to define custom metrics in your application code. When you enable the MicroProfile Telemetry feature 2.0 or later, you can then collect and emit these metrics to customize the observability of your application.

For more information about collecting and emitting metrics with MicroProfile Telemetry, see xref:microprofile-telemetry.adoc#metrics[Configuring Open Liberty to use MicroProfile Telemetry to collect metrics].
For more information about collecting and emitting metrics with MicroProfile Telemetry, see xref:microprofile-telemetry.adoc[Collect logs, metrics, and traces with OpenTelemetry].

For more information about OpenTelemetry metrics, see the link:https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api/1.39.0/io/opentelemetry/api/metrics/package-summary.html[OpenTelemetry metrics API documentation].

Before you can use MicroProfile Telemetry to define custom metrics metrics, you must enable MicroProfile Telemetry in your development environment by editing your runtime configuration. You must also add the OpenTelemetry API and annotations as a dependency on your build path. For more information, see xref:prepare-mptelemetry.adoc[Prepare your development environment for MicroProfile Telemetry].
Before you can use OpenTelemetry to define custom metrics metrics, you must make 3rd party APIs visible in your runtime environment by editing your runtime configuration. For more information, see link:/docs/latest/reference/feature/mpTelemetry-2.0.html#dev[Customize your application telemetry with the OpenTelemetry API].

The following example defines a custom counter metric:

Expand Down Expand Up @@ -49,3 +47,5 @@ class WithCounter {
In this example, `Meter` is used to define an instrument, in this case a Counter. Application code then can record measurement values along with other attributes. Measurement aggregations are computed separately for each unique combination of attributes.

For a full list of available metrics, see link:https://opentelemetry.io/docs/specs/otel/metrics/api/#meter-operations[Meter operations] in the OpenTelemetry documentation.

For more information about OpenTelemetry metrics, see the link:https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api/1.39.0/io/opentelemetry/api/metrics/package-summary.html[OpenTelemetry metrics API documentation].
Loading

0 comments on commit 6afbeb4

Please sign in to comment.