From a99cad7e51f904896a9e92f95543cf3c6b58c668 Mon Sep 17 00:00:00 2001 From: David Mueller Date: Fri, 6 Sep 2024 15:15:50 -0400 Subject: [PATCH] edits per review #7459 --- .../ROOT/pages/introduction-monitoring-metrics.adoc | 2 +- modules/ROOT/pages/mptelemetry-logging.adoc | 2 +- modules/ROOT/pages/mptelemetry-metrics-list.adoc | 12 ++---------- 3 files changed, 4 insertions(+), 12 deletions(-) diff --git a/modules/ROOT/pages/introduction-monitoring-metrics.adoc b/modules/ROOT/pages/introduction-monitoring-metrics.adoc index 4f53ad876..eabc13614 100644 --- a/modules/ROOT/pages/introduction-monitoring-metrics.adoc +++ b/modules/ROOT/pages/introduction-monitoring-metrics.adoc @@ -16,7 +16,7 @@ Three kinds of metrics are available to monitor your Open Liberty applications: OpenTelemetry metrics from MicroProfile Telemetry, REST endpoint-style metrics from MicroProfile Metrics, and Java Management Extensions (JMX) metrics. MicroProfile Metrics and JMX metrics can be used separately or in conjunction to improve the observability of your application systems. -MicroProfile Telemetry 2.0 and later exports metrics to OTLP or another configured OpenTelemetry metrics exporter. You might prefer this option if you also use MicroPRofile Telemetry to manage your logs and traces. +MicroProfile Telemetry 2.0 and later exports metrics to OTLP or another configured OpenTelemetry metrics exporter. You might prefer this option if you also use MicroProfile Telemetry to manage your logs and traces. MicroProfile Metrics can be accessed by monitoring tools, such as Prometheus, or by any client that can make REST requests. <<#jmx,JMX metrics>> are suitable for use by Java-based monitoring tools that can communicate with JMX servers, or by custom JMX clients. diff --git a/modules/ROOT/pages/mptelemetry-logging.adoc b/modules/ROOT/pages/mptelemetry-logging.adoc index cbdcd9b9e..4b3797b5f 100644 --- a/modules/ROOT/pages/mptelemetry-logging.adoc +++ b/modules/ROOT/pages/mptelemetry-logging.adoc @@ -12,7 +12,7 @@ :seo-description: The MicroProfile Telemetry logging events that can be captured from the Open Liberty server runtime environment and applications. = Write logs with MicroProfile Telemetry logging -You can use MicroProfile Telemetry to mange your logs, along with traces and metrics. When you enable the MicroProfile Telemetry 2.0 or later and the OpenTelemetry SDK, MicroProfile Telemetry automatically collects any logs that are sent to the `java.util.logging` API. +You can use MicroProfile Telemetry to mange your logs, along with traces and metrics. When you enable the MicroProfile Telemetry 2.0 or later, MicroProfile Telemetry automatically collects any logs that are sent to the `java.util.logging` API. Any messages that are logged at a `java.util.logging.Level` log level of `INFO` and above are considered messages. Levels below `INFO` are considered trace. By default, MicroProfile Telemetry automatically collects messages, but you can configure the sources that it collects from in your `server.xml` file. For more information, see link:/docs/latest/reference/feature/mpTelemetry-2.0.html#_collect_logs_from_a_specified_source[Collect logs from a specified source]. diff --git a/modules/ROOT/pages/mptelemetry-metrics-list.adoc b/modules/ROOT/pages/mptelemetry-metrics-list.adoc index ef57615ce..79b23d104 100644 --- a/modules/ROOT/pages/mptelemetry-metrics-list.adoc +++ b/modules/ROOT/pages/mptelemetry-metrics-list.adoc @@ -36,7 +36,7 @@ When you enable the feature:mpTelemetry-2.0[display=MicroProfile Telemetry] feat == Filter metrics to gather only the data you need -By default, all monitoring components are enabled. If your server is collecting more metrics data than you need, you can improve the server performance by collecting only those vendor metrics that you intend to use. To configure only a subset of vendor metrics to be reported, specify the components that you want to monitor in the `filter` attribute for the `monitor` configuration element in your `server.xml` file. You can identify the relevant monitoring component for each vendor metric by referencing the **Monitoring component** column of the metrics reference tables. +By default, all monitoring components are enabled. If your server is collecting more metrics data than you need, you can improve the server performance by collecting only those metrics that you intend to use. To configure only a subset of metrics to be reported, specify the components that you want to monitor in the `filter` attribute for the `monitor` configuration element in your `server.xml` file. You can identify the relevant monitoring component for each metric by referencing the **Monitoring component** column of the metrics reference tables. To enable only the monitoring components that are used by MicroProfile Telemetry, add the following code to your `server.xml` file. @@ -45,7 +45,7 @@ To enable only the monitoring components that are used by MicroProfile Telemetry ---- -To disable all vendor metrics but keep the `Session` base metrics, add the following code to your `server.xml` file: +To disable all metrics but the `Session` metrics, add the following code to your `server.xml` file: [source,xml] ---- @@ -307,11 +307,3 @@ The **Version introduced** column specifies the minimum version of the feature t |=== {empty} + - - - -== See also - -* Guide: link:/guides/microprofile-metrics.html[Providing metrics from a microservice] -* xref:reference:diff/mp-21-22-diff.adoc[Differences between MicroProfile 2.1 and 2.2] -* xref:microservice-observability-metrics.adoc[Microservice observability with metrics]