Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update default .enabled and exporter.type settings #217

Merged
merged 1 commit into from
Jan 28, 2025
Merged

Update default .enabled and exporter.type settings #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ For information about installing plugins, see [Installing plugins](https://opens

### Enabling top N query monitoring

When you install the `query-insights` plugin, top N query monitoring is disabled by default. To enable top N query monitoring, update the dynamic settings for the desired monitoring types. These settings enable the corresponding collectors and aggregators in the running cluster. For example, to enable monitoring top N queries by latency, update the `search.insights.top_queries.latency.enabled` setting:
When you install the `query-insights` plugin, top N query monitoring is enabled by default. To disable top N query monitoring, update the dynamic cluster settings for the desired metric types. For example, to disable monitoring top N queries by latency, update the `search.insights.top_queries.latency.enabled` setting:

```
PUT _cluster/settings
{
"persistent" : {
"search.insights.top_queries.latency.enabled" : true
"search.insights.top_queries.latency.enabled" : false
}
}
```
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/org/opensearch/plugin/insights/settings/QueryInsightsSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public class QueryInsightsSettings {
*/
public static final Setting<Boolean> TOP_N_LATENCY_QUERIES_ENABLED = Setting.boolSetting(
TOP_N_LATENCY_QUERIES_PREFIX + ".enabled",
false,
true,
Setting.Property.Dynamic,
Setting.Property.NodeScope
);
Expand Down Expand Up @@ -159,7 +159,7 @@ public class QueryInsightsSettings {
*/
public static final Setting<Boolean> TOP_N_CPU_QUERIES_ENABLED = Setting.boolSetting(
TOP_N_CPU_QUERIES_PREFIX + ".enabled",
false,
true,
Setting.Property.Dynamic,
Setting.Property.NodeScope
);
Expand Down Expand Up @@ -189,7 +189,7 @@ public class QueryInsightsSettings {
*/
public static final Setting<Boolean> TOP_N_MEMORY_QUERIES_ENABLED = Setting.boolSetting(
TOP_N_MEMORY_QUERIES_PREFIX + ".enabled",
false,
true,
Setting.Property.Dynamic,
Setting.Property.NodeScope
);
Expand Down Expand Up @@ -229,7 +229,7 @@ public class QueryInsightsSettings {
/**
* Default exporter type of top queries
*/
public static final String DEFAULT_TOP_QUERIES_EXPORTER_TYPE = SinkType.NONE.toString();
public static final String DEFAULT_TOP_QUERIES_EXPORTER_TYPE = SinkType.LOCAL_INDEX.toString();
/**
* Default Top N local indices retention period in days
*/
Expand Down
Loading