-
Notifications
You must be signed in to change notification settings - Fork 178
PPL command expression implementation for geoip
#3228
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
PPL command expression implementation for geoip
#3228
Conversation
6138a91 to
16a8f8f
Compare
c972d60 to
b7acfe1
Compare
|
As per the offline discussion, I have separated out the integration related changes into #3244, in order to minimise the diff. |
af264c2 to
590e405
Compare
core/src/main/java/org/opensearch/sql/expression/ip/GeoIPFunctions.java
Outdated
Show resolved
Hide resolved
integ-test/src/test/java/org/opensearch/sql/ppl/GeoIpFunctionsIT.java
Outdated
Show resolved
Hide resolved
integ-test/src/test/java/org/opensearch/sql/ppl/GeoIpFunctionsIT.java
Outdated
Show resolved
Hide resolved
integ-test/src/test/java/org/opensearch/sql/security/CrossClusterSearchIT.java
Outdated
Show resolved
Hide resolved
...rch/src/main/java/org/opensearch/sql/opensearch/planner/physical/OpenSearchEvalOperator.java
Outdated
Show resolved
Hide resolved
...rch/src/main/java/org/opensearch/sql/opensearch/planner/physical/OpenSearchEvalOperator.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Andy Kwok <[email protected]>
Signed-off-by: Andy Kwok <[email protected]>
96fdaea to
241ea63
Compare
core/src/main/java/org/opensearch/sql/expression/function/OpenSearchFunctions.java
Show resolved
Hide resolved
core/src/main/java/org/opensearch/sql/expression/function/OpenSearchFunctions.java
Show resolved
Hide resolved
core/src/main/java/org/opensearch/sql/expression/ip/IPFunctions.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Andy Kwok <[email protected]>
Signed-off-by: Andy Kwok <[email protected]>
Signed-off-by: Andy Kwok <[email protected]>
Signed-off-by: Andy Kwok <[email protected]>
normanj-bitquill
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
...rch/src/main/java/org/opensearch/sql/opensearch/planner/physical/OpenSearchEvalOperator.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Andy Kwok <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]> Signed-off-by: Andy Kwok <[email protected]>
…/physical/OpenSearchEvalOperator.java Co-authored-by: Andrew Carbonetto <[email protected]> Signed-off-by: Andy Kwok <[email protected]>
4aa00c7 to
1b41d5f
Compare
Signed-off-by: Andy Kwok <[email protected]>
Signed-off-by: Andy Kwok <[email protected]>
Signed-off-by: Andy Kwok <[email protected]>
Signed-off-by: Andy Kwok <[email protected]>
acarbonetto
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
|
The backport to 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/sql/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/sql/backport-2.x
# Create a new branch
git switch --create backport/backport-3228-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 3bf19ef6d5fc931d89b0b9ec08840ec643f8e790
# Push it to GitHub
git push --set-upstream origin backport/backport-3228-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/sql/backport-2.xThen, create a pull request where the |
Signed-off-by: Andy Kwok <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]> Signed-off-by: xinyual <[email protected]>
Description
Introduce a new PPL command expression
geoip, to perform geo-spatial information lookup with the provided IPv4 || IPv6 addresses, result of the lookup is formatted into a tuple with attribute as key and location detail as value.In this particular setting, SQL plugin will act as a thin client, by relaying the IPEnrichment request to OpenSearch Geo-Spatial plugin, WITHIN the same cluster.
Detail implementation and interface that exposed on Geo-Spatial side can be found:
opensearch-project/geospatial#700
Internally this functionality is achieved by:
OpenSearchFunctionExpressionmarker to identify this is an expression has no default implement on other runtime (Ex: Prometheus)OpenSearchIndexin order to provide an OpenSearch specific handler forevaloperator and its expressions, when OS being used as the storage engine.During runtime, all eval expressions, will being passed to
OpenSearchIndex.visitEval( ), thenOpenSearchEvalOperatorclass will pick up the call, by evaluating allevalexpression as it is, and then handle all occasion ofOpenSearchFunctionExpressionseparately, by reading the function name and argument, and execute the appropriate business logic.Marker class
OpenSearchFunctionExpressionis being used in this case because the actual implementation require runtime OpenSearch client connectivity, howevercoremodule is mean to be generic, hence this workaround is being deployed, by tagging it asOpenSearchFunctionExpressiononcoreand only handle it on theopensearchCradle module .Related Issues
Resolves: #3037
Check List
--signoff.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.