-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor query insight components into plugin
Signed-off-by: Chenyang Ji <[email protected]>
- Loading branch information
Showing
51 changed files
with
823 additions
and
551 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| * | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| //apply plugin: 'opensearch.java-rest-test' | ||
| //apply plugin: 'opensearch.internal-cluster-test' | ||
|
|
||
| import org.opensearch.gradle.testclusters.RunTask | ||
| import org.opensearch.gradle.test.RestIntegTestTask | ||
| apply plugin: 'opensearch.testclusters' | ||
|
|
||
| opensearchplugin { | ||
| description 'OpenSearch Query Insights Plugin.' | ||
| classname 'org.opensearch.plugin.insights.QueryInsightsPlugin' | ||
| } | ||
|
|
||
| dependencies { | ||
| } | ||
|
|
||
| task integTest(type: RestIntegTestTask) { | ||
| description = "Run tests against a cluster" | ||
| testClassesDirs = sourceSets.test.output.classesDirs | ||
| classpath = sourceSets.test.runtimeClasspath | ||
| } | ||
| tasks.named("check").configure { dependsOn(integTest) } | ||
|
|
||
| integTest { | ||
| // The --debug-jvm command-line option makes the cluster debuggable; this makes the tests debuggable | ||
| if (System.getProperty("test.debug") != null) { | ||
| jvmArgs '-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005' | ||
| } | ||
| } | ||
|
|
||
| testClusters.integTest { | ||
| testDistribution = "INTEG_TEST" | ||
|
|
||
| // This installs our plugin into the testClusters | ||
| plugin(project.tasks.bundlePlugin.archiveFile) | ||
| } | ||
|
|
||
| run { | ||
| useCluster testClusters.integTest | ||
| } | ||
|
|
104 changes: 104 additions & 0 deletions
104
plugins/query-insights/src/main/java/org/opensearch/plugin/insights/QueryInsightsPlugin.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.plugin.insights; | ||
|
|
||
| import org.opensearch.action.ActionRequest; | ||
| import org.opensearch.client.Client; | ||
| import org.opensearch.cluster.metadata.IndexNameExpressionResolver; | ||
| import org.opensearch.cluster.node.DiscoveryNodes; | ||
| import org.opensearch.cluster.service.ClusterService; | ||
| import org.opensearch.common.settings.ClusterSettings; | ||
| import org.opensearch.common.settings.IndexScopedSettings; | ||
| import org.opensearch.common.settings.Setting; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.common.settings.SettingsFilter; | ||
| import org.opensearch.core.action.ActionResponse; | ||
| import org.opensearch.core.common.io.stream.NamedWriteableRegistry; | ||
| import org.opensearch.core.xcontent.NamedXContentRegistry; | ||
| import org.opensearch.env.Environment; | ||
| import org.opensearch.env.NodeEnvironment; | ||
| import org.opensearch.plugin.insights.core.listener.SearchQueryLatencyListener; | ||
| import org.opensearch.plugin.insights.core.service.TopQueriesByLatencyService; | ||
| import org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesAction; | ||
| import org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction; | ||
| import org.opensearch.plugin.insights.rules.transport.top_queries.TransportTopQueriesAction; | ||
| import org.opensearch.plugin.insights.settings.QueryInsightsSettings; | ||
| import org.opensearch.plugins.ActionPlugin; | ||
| import org.opensearch.plugins.EnginePlugin; | ||
| import org.opensearch.plugins.Plugin; | ||
| import org.opensearch.plugins.SearchPlugin; | ||
| import org.opensearch.repositories.RepositoriesService; | ||
| import org.opensearch.rest.RestController; | ||
| import org.opensearch.rest.RestHandler; | ||
| import org.opensearch.script.ScriptService; | ||
| import org.opensearch.threadpool.ThreadPool; | ||
| import org.opensearch.watcher.ResourceWatcherService; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.List; | ||
| import java.util.function.Supplier; | ||
|
|
||
| /** | ||
| * Plugin class for Query Insights. | ||
| */ | ||
| public class QueryInsightsPlugin extends Plugin implements ActionPlugin, SearchPlugin, EnginePlugin { | ||
| /** | ||
| * Default constructor | ||
| */ | ||
| public QueryInsightsPlugin() {} | ||
|
|
||
| @Override | ||
| public Collection<Object> createComponents( | ||
| Client client, | ||
| ClusterService clusterService, | ||
| ThreadPool threadPool, | ||
| ResourceWatcherService resourceWatcherService, | ||
| ScriptService scriptService, | ||
| NamedXContentRegistry xContentRegistry, | ||
| Environment environment, | ||
| NodeEnvironment nodeEnvironment, | ||
| NamedWriteableRegistry namedWriteableRegistry, | ||
| IndexNameExpressionResolver indexNameExpressionResolver, | ||
| Supplier<RepositoriesService> repositoriesServiceSupplier | ||
| ) { | ||
| // create top n queries service | ||
| TopQueriesByLatencyService topQueriesByLatencyService = new TopQueriesByLatencyService(threadPool, clusterService, client); | ||
| // top n queries listener | ||
| SearchQueryLatencyListener searchQueryLatencyListener = new SearchQueryLatencyListener(clusterService, topQueriesByLatencyService); | ||
| return List.of(topQueriesByLatencyService, searchQueryLatencyListener); | ||
| } | ||
|
|
||
| @Override | ||
| public List<RestHandler> getRestHandlers( | ||
| Settings settings, | ||
| RestController restController, | ||
| ClusterSettings clusterSettings, | ||
| IndexScopedSettings indexScopedSettings, | ||
| SettingsFilter settingsFilter, | ||
| IndexNameExpressionResolver indexNameExpressionResolver, | ||
| Supplier<DiscoveryNodes> nodesInCluster | ||
| ) { | ||
| return List.of(new RestTopQueriesAction()); | ||
| } | ||
|
|
||
| @Override | ||
| public List<ActionHandler<? extends ActionRequest, ? extends ActionResponse>> getActions() { | ||
| return List.of(new ActionPlugin.ActionHandler<>(TopQueriesAction.INSTANCE, TransportTopQueriesAction.class)); | ||
| } | ||
|
|
||
| @Override | ||
| public List<Setting<?>> getSettings() { | ||
| return List.of( | ||
| // Settings for top N queries | ||
| QueryInsightsSettings.TOP_N_LATENCY_QUERIES_ENABLED, | ||
| QueryInsightsSettings.TOP_N_LATENCY_QUERIES_SIZE, | ||
| QueryInsightsSettings.TOP_N_LATENCY_QUERIES_WINDOW_SIZE | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.