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.

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

Make search query counters dynamic to support all query types #12601

Merged

Conversation

deshsidd
Copy link
Contributor

@deshsidd deshsidd commented Mar 11, 2024

The change aims to make the search query counters dynamic to support all query types.

Description

Initially, we only incremented counters for a select few query types as part of search query categorization. Based on requests in the following issue, we want to cover ALL query types including the query types that might be included as part of plugin code.

To implement this, we create a map that stores the query builder name to Query type Counter. When we encounter a new query type we add the query to the map and create a new associated counter. We then use this counter to increment for all requests coming in for the aforementioned query type. This implementation ensures that we do not need to manually keep adding new Counters for new Query types and all future query types will be supported out of the box (including plugin query types).

Related Issues

Resolves #5983

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)
  • Public documentation issue/PR created

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions github-actions bot added enhancement Enhancement or improvement to existing feature or request good first issue Good for newcomers help wanted Extra attention is needed Plugins Search Search query, autocomplete ...etc labels Mar 11, 2024
Copy link
Contributor

github-actions bot commented Mar 11, 2024

Compatibility status:

Checks if related components are compatible with change 4654f49

Incompatible components

Incompatible components: [https://github.com/opensearch-project/security-analytics.git]

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/sql.git]

Copy link
Contributor

✅ Gradle check result for 43bd232: SUCCESS

Copy link
Contributor

✅ Gradle check result for 0c901ef: SUCCESS

Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.47%. Comparing base (b15cb0c) to head (4654f49).
Report is 21 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #12601      +/-   ##
============================================
+ Coverage     71.42%   71.47%   +0.04%     
- Complexity    59978    60055      +77     
============================================
  Files          4985     4986       +1     
  Lines        282275   282427     +152     
  Branches      40946    40973      +27     
============================================
+ Hits         201603   201852     +249     
+ Misses        63999    63810     -189     
- Partials      16673    16765      +92     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Siddhant Deshmukh <[email protected]>
Signed-off-by: Siddhant Deshmukh <[email protected]>
@deshsidd deshsidd force-pushed the sid/search-query-counters-generic branch from 43bd232 to dc1f4f3 Compare March 13, 2024 18:33
Signed-off-by: Siddhant Deshmukh <[email protected]>
Copy link
Contributor

❌ Gradle check result for 4654f49: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Copy link
Contributor

❌ Gradle check result for dc1f4f3: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Copy link
Contributor

✅ Gradle check result for 4654f49: SUCCESS

@msfroh msfroh merged commit abe270f into opensearch-project:main Mar 13, 2024
30 checks passed
@msfroh msfroh added the backport 2.x Backport to 2.x branch label Mar 14, 2024
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-12601-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 abe270f3b54c9e89d9375067509b9696a43d699a
# Push it to GitHub
git push --set-upstream origin backport/backport-12601-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-12601-to-2.x.

deshsidd added a commit to deshsidd/OpenSearch that referenced this pull request Mar 20, 2024
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
deshsidd added a commit to deshsidd/OpenSearch that referenced this pull request Apr 25, 2024
sohami pushed a commit that referenced this pull request Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch backport-failed enhancement Enhancement or improvement to existing feature or request good first issue Good for newcomers help wanted Extra attention is needed Plugins Search Search query, autocomplete ...etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Query Clause Level Stats in OpenSearch
2 participants