Add documentation for query insights - query metrics feature #7846
Conversation
deshsidd
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com>
Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com>
Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com>
deshsidd
force-pushed
the
sid/query-categorization-docs
branch
from
d597701
to
4c795f9
Compare
|
@hdhalter Please review |
|
Thanks so much, @deshsidd ! I'll assign it to @kolchfa-aws for a doc review. In the meantime, can you please review the Vale errors to see if you can address them? Thanks! |
hdhalter
added
4 - Doc review
Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com>
Done! |
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
|
@deshsidd I rewrote and pushed to this PR. Could you make sure I preserved technical accuracy of the content? Also, one question:
|
There was a problem hiding this comment.
@deshsidd @kolchfa-aws Please see my comments and changes and tag me for approval once addressed. Thanks!
|
|
||
| # 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). |
There was a problem hiding this comment.
The first phrase of the first sentence is too vague and doesn't entirely work. How/in what way does "query metrics" involve something? What comprehensive instrumentation (is this information necessary?)? I would just combine the first two sentences.
There was a problem hiding this comment.
@natebower "Instrumentations" refers to the tools and processes used to collect, measure, and report data about the performance and behavior of a system. How about "Query metrics uses comprehensive instrumentation along the search path to capture key metrics, such as aggregation types, query types, latency, and resource usage per query type."
There was a problem hiding this comment.
If "query metrics" are a generic noun, then it should be "Query metrics use", but that still reads oddly because we have metrics capturing other metrics. As written, we seem to be treating "Query Metrics" as a proper noun syntactically.
There was a problem hiding this comment.
OK, let's ask @deshsidd: Could you please address this comment? Thanks.
There was a problem hiding this comment.
I think what we mean is "Key query 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."
There was a problem hiding this comment.
Agree with @natebower last comment. @kolchfa-aws you can go forward with this change and we can merge this.
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
There was a problem hiding this comment.
@deshsidd @kolchfa-aws LGTM with one pending suggestion. Thanks!
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
hdhalter
added
3 - Done
…rch-project#7846) * Add documentation for query insigts - query metrics feature Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com> * Address auto comments Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com> * Fix dead link Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com> * Address auto comments Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _observing-your-data/query-insights/query-metrics.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _observing-your-data/query-insights/query-metrics.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
Description
Add documentation for query insights - query metrics feature : opensearch-project/OpenSearch#11596
Issues Resolved
resolves: #7798
Version
2.16
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.