Skip to content

Commit

Permalink
update the document to fix style checks
Browse files Browse the repository at this point in the history 
Signed-off-by: Chenyang Ji <[email protected]>
  • Loading branch information
@ansjcy
ansjcy committed Jun 10, 2024
1 parent 3714679 commit 9681846
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions _observing-your-data/query-insights/top-n-queries.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,10 @@ GET /_insights/top_queries?type=latency
{% include copy-curl.html %}

## Export the top N queries data
You can configure your desired exporter to export the top n queries data to different sinks. Currently, supported exportors are debug exporter and local index exporter.
You can configure your desired exporter to export the top N queries data to different sinks. Currently, supported exporters are the debug exporter and the local index exporter.

Configure the debug exporter for top queries by latency with
### Configuring the Debug Exporter

Check failure on line 87 in _observing-your-data/query-insights/top-n-queries.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingCapitalization] 'Configuring the Debug Exporter' is a heading and should be in sentence case.

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'Configuring the Debug Exporter' is a heading and should be in sentence case.", "location": {"path": "_observing-your-data/query-insights/top-n-queries.md", "range": {"start": {"line": 87, "column": 5}}}, "severity": "ERROR"}
To export the top queries by latency using the debug exporter, use the following configuration:
```json
PUT _cluster/settings
{
Expand All @@ -95,7 +96,7 @@ PUT _cluster/settings
```
{% include copy-curl.html %}

You can also configure the debug exporter for other metrics like cpu with
To configure the debug exporter for other metrics such as `CPU`, use:
```json
PUT _cluster/settings
{
Expand All @@ -106,7 +107,8 @@ PUT _cluster/settings
```
{% include copy-curl.html %}

Local index exporter is also supported to export the top n queries to local OpenSearch indices. You can configure the local index exporter with
### Configuring the Local Index Exporter

Check failure on line 110 in _observing-your-data/query-insights/top-n-queries.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingCapitalization] 'Configuring the Local Index Exporter' is a heading and should be in sentence case.

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'Configuring the Local Index Exporter' is a heading and should be in sentence case.", "location": {"path": "_observing-your-data/query-insights/top-n-queries.md", "range": {"start": {"line": 110, "column": 5}}}, "severity": "ERROR"}
The local index exporter allows you to export the top N queries to local OpenSearch indexes. To configure the local index exporter for latency, use:
```json
PUT _cluster/settings
{
Expand All @@ -118,9 +120,9 @@ PUT _cluster/settings
```
{% include copy-curl.html %}

For a reference on the date pattern format, see the [Joda DateTimeFormat documentation](https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html).
For reference on the date pattern format, see the [Joda DateTimeFormat documentation](https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html).

Check failure on line 123 in _observing-your-data/query-insights/top-n-queries.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: Joda. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: Joda. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_observing-your-data/query-insights/top-n-queries.md", "range": {"start": {"line": 123, "column": 52}}}, "severity": "ERROR"}

You can also configure the local index exporter for other metrics like cpu with
To configure the local index exporter for other metrics such as `CPU`, use:
```json
PUT _cluster/settings
{
Expand All @@ -130,4 +132,6 @@ PUT _cluster/settings
}
}
```
{% include copy-curl.html %}
{% include copy-curl.html %}

By configuring these settings, you can direct the query insights data to the appropriate sink, allowing for better monitoring and analysis of your OpenSearch queries.

0 comments on commit 9681846

Please sign in to comment.