From 4c139e9e90ce3ec69e400fec45871676657e51a1 Mon Sep 17 00:00:00 2001 From: Siddhant Deshmukh Date: Fri, 26 Jul 2024 13:31:58 -0700 Subject: [PATCH 1/9] Add documentation for query insigts - query metrics feature Signed-off-by: Siddhant Deshmukh --- _observing-your-data/query-insights/index.md | 1 + .../query-insights/query-metrics.md | 87 +++++++++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 _observing-your-data/query-insights/query-metrics.md diff --git a/_observing-your-data/query-insights/index.md b/_observing-your-data/query-insights/index.md index 7bad169d1d..be3d054c6b 100644 --- a/_observing-your-data/query-insights/index.md +++ b/_observing-your-data/query-insights/index.md @@ -36,3 +36,4 @@ For information about installing plugins, see [Installing plugins]({{site.url}}{ Query insights features support the following settings: - [Top n queries]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/top-n-queries/) +- [Query Metrics]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/query-metrics/) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md new file mode 100644 index 0000000000..7c8dc63236 --- /dev/null +++ b/_observing-your-data/query-insights/query-metrics.md @@ -0,0 +1,87 @@ +--- +layout: default +title: Query Metrics +parent: Query insights +nav_order: 65 +--- + +# Query Metrics + +Query Metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics) such as types of aggregations, query types, latency and resource usage per query type. +Open Telemetry is used to instrument the above and the telemetry data can be consumed using the [otel metrics exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/). + + +## Configuring query metrics + +The following are needed to configure query metrics: + +- [Enable Query Insights plugin](#enable-query-insights-plugin) +- [Enable Otel plugin](#enable-otel-plugin) +- [Configuration](#configuration) + +### Enable Query Insights plugin +- Need to install the query-insights plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/index/) for more details. + +### Enable OpenTelemetry plugin +- Need to install the telemetry-otel plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/) for more details. + +### Configuration +Configuration to enable the query metrics feature: +``` +telemetry.feature.metrics.enabled: true +search.query.metrics.enabled: true +``` +{% include copy-curl.html %} + +Sample configuration including the telemetry configuration: +``` +# Enable query metrics feature +search.query.metrics.enabled: true +telemetry.feature.metrics.enabled: true + +# Otel related confuration +opensearch.experimental.feature.telemetry.enabled: true +telemetry.tracer.sampler.probability: 1.0 +telemetry.feature.tracer.enabled: true +``` +{% include copy-curl.html %} + +Configure the query metrics feature using API: +```json +PUT _cluster/settings +{ + "persistent" : { + "search.query.metrics.enabled" : true + } +} +``` +{% include copy-curl.html %} + +Configuration to export metrics and traces using GRPC exporter (can skip this step if you use to use the [default logging exporter](#default-logging-exporter)): +``` +telemetry.otel.tracer.span.exporter.class: io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter +telemetry.otel.metrics.exporter.class: io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter +``` +{% include copy-curl.html %} + + +## Metrics +Following instrumentation has been added as part of this feature: +- Count of the number of queries per query type (Eg: count of match, regex queries) +- Count of the number of queries per aggregation type (Eg: count of TermsAggregation queries) +- Count of the number of queries per sort order (Eg: count of asc, desc sort queries) +- Histogram for the latency per query type, aggregation type and sort order +- Histogram for the cpu per query type, aggregation type and sort order +- Histogram for the memory query type, aggregation type and sort order + +## Default Logging Exporter +If no grpc exporters are configured the metrics and traces are exported to the logs files by default. +Under `opensearch/logs` the telemetry data can be found in the following files: +1. opensearch_otel_metrics.log +2. opensearch_otel_traces.log + + + + + + From e5827ec0b9b924acac6bc832362c88e4f3b694c2 Mon Sep 17 00:00:00 2001 From: Siddhant Deshmukh Date: Fri, 26 Jul 2024 13:42:43 -0700 Subject: [PATCH 2/9] Address auto comments Signed-off-by: Siddhant Deshmukh --- .../query-insights/query-metrics.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index 7c8dc63236..e100ea36d4 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -5,10 +5,10 @@ parent: Query insights nav_order: 65 --- -# Query Metrics +# Query metrics Query Metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics) such as types of aggregations, query types, latency and resource usage per query type. -Open Telemetry is used to instrument the above and the telemetry data can be consumed using the [otel metrics exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/). +Open Telemetry is used as the framework for instrumentation and the telemetry data can be consumed using the [oTel metrics exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/). ## Configuring query metrics @@ -16,14 +16,14 @@ Open Telemetry is used to instrument the above and the telemetry data can be con The following are needed to configure query metrics: - [Enable Query Insights plugin](#enable-query-insights-plugin) -- [Enable Otel plugin](#enable-otel-plugin) +- [Enable OTel plugin](#enable-otel-plugin) - [Configuration](#configuration) -### Enable Query Insights plugin +### Enable query insights plugin - Need to install the query-insights plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/index/) for more details. -### Enable OpenTelemetry plugin -- Need to install the telemetry-otel plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/) for more details. +### Enable openTelemetry plugin +- Need to install the `telemetry-otel` plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/) for more details. ### Configuration Configuration to enable the query metrics feature: @@ -69,16 +69,16 @@ telemetry.otel.metrics.exporter.class: io.opentelemetry.exporter.otlp.metrics.Ot Following instrumentation has been added as part of this feature: - Count of the number of queries per query type (Eg: count of match, regex queries) - Count of the number of queries per aggregation type (Eg: count of TermsAggregation queries) -- Count of the number of queries per sort order (Eg: count of asc, desc sort queries) -- Histogram for the latency per query type, aggregation type and sort order -- Histogram for the cpu per query type, aggregation type and sort order -- Histogram for the memory query type, aggregation type and sort order +- Count of the number of queries per sort order (Eg: count of ascending, descending sort queries) +- Histogram for the `latency` per query type, aggregation type and sort order +- Histogram for the `cpu` per query type, aggregation type and sort order +- Histogram for the `memory` query type, aggregation type and sort order -## Default Logging Exporter +## Default logging exporter If no grpc exporters are configured the metrics and traces are exported to the logs files by default. Under `opensearch/logs` the telemetry data can be found in the following files: -1. opensearch_otel_metrics.log -2. opensearch_otel_traces.log +1. `opensearch_otel_metrics.log` +2. `opensearch_otel_traces.log` From 4c795f9b37d811d9fb07b4ab2a12117910b890b8 Mon Sep 17 00:00:00 2001 From: Siddhant Deshmukh Date: Fri, 26 Jul 2024 13:47:39 -0700 Subject: [PATCH 3/9] Fix dead link Signed-off-by: Siddhant Deshmukh --- _observing-your-data/query-insights/query-metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index e100ea36d4..36be261ac1 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -16,7 +16,7 @@ Open Telemetry is used as the framework for instrumentation and the telemetry da The following are needed to configure query metrics: - [Enable Query Insights plugin](#enable-query-insights-plugin) -- [Enable OTel plugin](#enable-otel-plugin) +- [Enable OTel plugin](#enable-opentelemetry-plugin) - [Configuration](#configuration) ### Enable query insights plugin From 9144ebd25d4c663aad1446e627afb3bee424b72e Mon Sep 17 00:00:00 2001 From: Siddhant Deshmukh Date: Fri, 26 Jul 2024 15:25:18 -0700 Subject: [PATCH 4/9] Address auto comments Signed-off-by: Siddhant Deshmukh --- _observing-your-data/query-insights/query-metrics.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index 36be261ac1..0468f712a3 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -8,7 +8,7 @@ nav_order: 65 # Query metrics Query Metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics) such as types of aggregations, query types, latency and resource usage per query type. -Open Telemetry is used as the framework for instrumentation and the telemetry data can be consumed using the [oTel metrics exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/). +Open Telemetry is used as the framework for instrumentation and the telemetry data can be consumed using the [`otel metrics exporters`]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/). ## Configuring query metrics @@ -19,10 +19,10 @@ The following are needed to configure query metrics: - [Enable OTel plugin](#enable-opentelemetry-plugin) - [Configuration](#configuration) -### Enable query insights plugin +### Enable Query Insights plugin - Need to install the query-insights plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/index/) for more details. -### Enable openTelemetry plugin +### Enable OpenTelemetry plugin - Need to install the `telemetry-otel` plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/) for more details. ### Configuration @@ -75,7 +75,7 @@ Following instrumentation has been added as part of this feature: - Histogram for the `memory` query type, aggregation type and sort order ## Default logging exporter -If no grpc exporters are configured the metrics and traces are exported to the logs files by default. +If no `grpc` exporters are configured the metrics and traces are exported to the logs files by default. Under `opensearch/logs` the telemetry data can be found in the following files: 1. `opensearch_otel_metrics.log` 2. `opensearch_otel_traces.log` From 5bbd709573aa4c6857fff8dea89bf38c7426fe4d Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Mon, 29 Jul 2024 17:55:37 -0400 Subject: [PATCH 5/9] Doc review Signed-off-by: Fanit Kolchina --- _observing-your-data/query-insights/index.md | 4 +- .../query-insights/query-metrics.md | 77 +++++++++---------- .../query-insights/top-n-queries.md | 2 +- 3 files changed, 40 insertions(+), 43 deletions(-) diff --git a/_observing-your-data/query-insights/index.md b/_observing-your-data/query-insights/index.md index be3d054c6b..851048ecdb 100644 --- a/_observing-your-data/query-insights/index.md +++ b/_observing-your-data/query-insights/index.md @@ -33,7 +33,7 @@ For information about installing plugins, see [Installing plugins]({{site.url}}{ ## Query insights settings -Query insights features support the following settings: +You can obtain the following information using Query Insights: - [Top n queries]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/top-n-queries/) -- [Query Metrics]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/query-metrics/) +- [Query metrics]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/query-metrics/) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index 0468f712a3..47db1cfe0a 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -1,52 +1,52 @@ --- layout: default -title: Query Metrics +title: Query metrics parent: Query insights -nav_order: 65 +nav_order: 20 --- # Query metrics -Query Metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics) such as types of aggregations, query types, latency and resource usage per query type. -Open Telemetry is used as the framework for instrumentation and the telemetry data can be consumed using the [`otel metrics exporters`]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/). - +Query metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics), such as aggregation types, query types, latency, and resource usage per query type. Open Telemetry (oTel) is the instrumentation framework. The telemetry data can be consumed using oTel metrics [exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). ## Configuring query metrics -The following are needed to configure query metrics: +To configure query metrics, use the following steps. -- [Enable Query Insights plugin](#enable-query-insights-plugin) -- [Enable OTel plugin](#enable-opentelemetry-plugin) -- [Configuration](#configuration) +### Step 1: Install the Query Insights plugin -### Enable Query Insights plugin -- Need to install the query-insights plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/index/) for more details. +For information about installing the Query Insights plugin, see [Installing the Query Insights plugin]({{site.url}}{{site.baseurl}}/observing-your-data/query-insights/index/#installing-the-query-insights-plugin). -### Enable OpenTelemetry plugin -- Need to install the `telemetry-otel` plugin. See the [following]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/) for more details. +### Step 2: Install the OpenTelemetry plugin -### Configuration -Configuration to enable the query metrics feature: -``` +For information about installing the OpenTelemetry plugin, see [Distributed tracing]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/). + +### Step 3: Enable query metrics + +Enable query metrics by configuring the following `opensearch.yml` settings: + +```yaml telemetry.feature.metrics.enabled: true search.query.metrics.enabled: true ``` -{% include copy-curl.html %} +{% include copy.html %} -Sample configuration including the telemetry configuration: -``` +The following is a complete sample configuration that includes telemetry configuration: + +```yaml # Enable query metrics feature search.query.metrics.enabled: true telemetry.feature.metrics.enabled: true -# Otel related confuration +# oTel-related confuration opensearch.experimental.feature.telemetry.enabled: true telemetry.tracer.sampler.probability: 1.0 telemetry.feature.tracer.enabled: true ``` -{% include copy-curl.html %} +{% include copy.html %} + +Alternatively, you can configure query metrics using the API: -Configure the query metrics feature using API: ```json PUT _cluster/settings { @@ -57,31 +57,28 @@ PUT _cluster/settings ``` {% include copy-curl.html %} -Configuration to export metrics and traces using GRPC exporter (can skip this step if you use to use the [default logging exporter](#default-logging-exporter)): -``` +Configure the export of metrics and traces using a gRPC exporter. For more information, see [Exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). You can skip this step if you use the [default logging exporter](#default-logging-exporter): + +```yaml telemetry.otel.tracer.span.exporter.class: io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter telemetry.otel.metrics.exporter.class: io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter ``` -{% include copy-curl.html %} - +{% include copy.html %} ## Metrics -Following instrumentation has been added as part of this feature: -- Count of the number of queries per query type (Eg: count of match, regex queries) -- Count of the number of queries per aggregation type (Eg: count of TermsAggregation queries) -- Count of the number of queries per sort order (Eg: count of ascending, descending sort queries) -- Histogram for the `latency` per query type, aggregation type and sort order -- Histogram for the `cpu` per query type, aggregation type and sort order -- Histogram for the `memory` query type, aggregation type and sort order - -## Default logging exporter -If no `grpc` exporters are configured the metrics and traces are exported to the logs files by default. -Under `opensearch/logs` the telemetry data can be found in the following files: -1. `opensearch_otel_metrics.log` -2. `opensearch_otel_traces.log` - +Query metrics support the following measurements: +- The number of queries per query type (for example, the number of `match` or `regex` queries). +- The number of queries per aggregation type (for example, the number of `terms` aggregation queries). +- The number of queries per sort order (for example, the number of ascending and descending `sort` queries). +- Histograms of `latency` for each query type, aggregation type, and sort order. +- Histograms of `cpu` for each query type, aggregation type, and sort order. +- Histograms of `memory` for each query type, aggregation type, and sort order. +## Default logging exporter +By default, if no gRPC exporters are configured, then the metrics and traces are exported to log files. The data is saved under the `opensearch/logs` directory in the following files: +- `opensearch_otel_metrics.log` +- `opensearch_otel_traces.log` diff --git a/_observing-your-data/query-insights/top-n-queries.md b/_observing-your-data/query-insights/top-n-queries.md index e6dadf33c5..f07fd2dfef 100644 --- a/_observing-your-data/query-insights/top-n-queries.md +++ b/_observing-your-data/query-insights/top-n-queries.md @@ -2,7 +2,7 @@ layout: default title: Top N queries parent: Query insights -nav_order: 65 +nav_order: 10 --- # Top N queries From e5a0af10c327b7a589b07a194c85b43e0d53bbcb Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Wed, 31 Jul 2024 09:55:19 -0400 Subject: [PATCH 6/9] Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _observing-your-data/query-insights/index.md | 2 +- .../query-insights/query-metrics.md | 26 +++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/_observing-your-data/query-insights/index.md b/_observing-your-data/query-insights/index.md index 851048ecdb..549371240f 100644 --- a/_observing-your-data/query-insights/index.md +++ b/_observing-your-data/query-insights/index.md @@ -31,7 +31,7 @@ bin/opensearch-plugin install query-insights ``` For information about installing plugins, see [Installing plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/). -## Query insights settings +## Query Insights settings You can obtain the following information using Query Insights: diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index 47db1cfe0a..e550f205e4 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -7,11 +7,11 @@ nav_order: 20 # Query metrics -Query metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics), such as aggregation types, query types, latency, and resource usage per query type. Open Telemetry (oTel) is the instrumentation framework. The telemetry data can be consumed using oTel metrics [exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). +Query metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics), such as aggregation types, query types, latency, and resource usage per query type. OpenTelemetry (OTel) is the instrumentation framework. The telemetry data can be consumed using OTel metrics [exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). -## Configuring query metrics +## Configuring query metric generation -To configure query metrics, use the following steps. +To configure query metric generation, use the following steps. ### Step 1: Install the Query Insights plugin @@ -31,7 +31,7 @@ search.query.metrics.enabled: true ``` {% include copy.html %} -The following is a complete sample configuration that includes telemetry configuration: +The following is a complete sample configuration that includes a telemetry configuration: ```yaml # Enable query metrics feature @@ -45,7 +45,7 @@ telemetry.feature.tracer.enabled: true ``` {% include copy.html %} -Alternatively, you can configure query metrics using the API: +Alternatively, you can configure query metric generation using the API: ```json PUT _cluster/settings @@ -67,18 +67,18 @@ telemetry.otel.metrics.exporter.class: io.opentelemetry.exporter.otlp.metrics.Ot ## Metrics -Query metrics support the following measurements: +Query metrics provide the following measurements: -- The number of queries per query type (for example, the number of `match` or `regex` queries). -- The number of queries per aggregation type (for example, the number of `terms` aggregation queries). -- The number of queries per sort order (for example, the number of ascending and descending `sort` queries). -- Histograms of `latency` for each query type, aggregation type, and sort order. -- Histograms of `cpu` for each query type, aggregation type, and sort order. -- Histograms of `memory` for each query type, aggregation type, and sort order. +- The number of queries per query type (for example, the number of `match` or `regex` queries) +- The number of queries per aggregation type (for example, the number of `terms` aggregation queries) +- The number of queries per sort order (for example, the number of ascending and descending `sort` queries) +- Histograms of `latency` for each query type, aggregation type, and sort order +- Histograms of `cpu` for each query type, aggregation type, and sort order +- Histograms of `memory` for each query type, aggregation type, and sort order ## Default logging exporter -By default, if no gRPC exporters are configured, then the metrics and traces are exported to log files. The data is saved under the `opensearch/logs` directory in the following files: +By default, if no gRPC exporters are configured, then the metrics and traces are exported to log files. The data is saved in the `opensearch/logs` directory in the following files: - `opensearch_otel_metrics.log` - `opensearch_otel_traces.log` From 021e53c20e30df734dcab064cdcfb001f0807eba Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Wed, 31 Jul 2024 09:58:14 -0400 Subject: [PATCH 7/9] Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _observing-your-data/query-insights/query-metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index e550f205e4..5faa5b4568 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -38,7 +38,7 @@ The following is a complete sample configuration that includes a telemetry confi search.query.metrics.enabled: true telemetry.feature.metrics.enabled: true -# oTel-related confuration +# OTel-related configuration opensearch.experimental.feature.telemetry.enabled: true telemetry.tracer.sampler.probability: 1.0 telemetry.feature.tracer.enabled: true From ddfca643c02ddf9b5684002091f525e6924510d5 Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Wed, 31 Jul 2024 13:57:54 -0400 Subject: [PATCH 8/9] Update _observing-your-data/query-insights/query-metrics.md Co-authored-by: Nathan Bower Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _observing-your-data/query-insights/query-metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index 5faa5b4568..8bc8668353 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -7,7 +7,7 @@ nav_order: 20 # Query metrics -Query metrics involves comprehensive instrumentation along the search path to capture key [metrics](#metrics), such as aggregation types, query types, latency, and resource usage per query type. OpenTelemetry (OTel) is the instrumentation framework. The telemetry data can be consumed using OTel metrics [exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). +Key query [metrics](https://github.com/opensearch-project/documentation-website/pull/7846#metrics), such as aggregation types, query types, latency, and resource usage per query type, are captured along the search path by using the OpenTelemetry (OTel) instrumentation framework. The telemetry data can be consumed using OTel metrics [exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). ## Configuring query metric generation From a123fa6addee7d2bac6ac44fa84e0f493d745da4 Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Wed, 31 Jul 2024 17:17:06 -0400 Subject: [PATCH 9/9] Update _observing-your-data/query-insights/query-metrics.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _observing-your-data/query-insights/query-metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_observing-your-data/query-insights/query-metrics.md b/_observing-your-data/query-insights/query-metrics.md index 8bc8668353..c8caf21d65 100644 --- a/_observing-your-data/query-insights/query-metrics.md +++ b/_observing-your-data/query-insights/query-metrics.md @@ -7,7 +7,7 @@ nav_order: 20 # Query metrics -Key query [metrics](https://github.com/opensearch-project/documentation-website/pull/7846#metrics), such as aggregation types, query types, latency, and resource usage per query type, are captured along the search path by using the OpenTelemetry (OTel) instrumentation framework. The telemetry data can be consumed using OTel metrics [exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). +Key query [metrics](#metrics), such as aggregation types, query types, latency, and resource usage per query type, are captured along the search path by using the OpenTelemetry (OTel) instrumentation framework. The telemetry data can be consumed using OTel metrics [exporters]({{site.url}}{{site.baseurl}}/observing-your-data/trace/distributed-tracing/#exporters). ## Configuring query metric generation