You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/08/02 23:44:00 UTC
[jira] [Commented] (METRON-1075) Add faceted search capabilities
[ https://issues.apache.org/jira/browse/METRON-1075?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16111928#comment-16111928 ]
ASF GitHub Bot commented on METRON-1075:
----------------------------------------
GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/679
METRON-1075: Add faceted search capabilities
## Contributor Comments
This PR adds faceted search to indexing DAO. This can be tested in full dev with Swagger. When searching with the "/api/v1/search/search" endpoint adding a "facetFields" property with a list of fields as the value will return facet counts for those fields. For example, for this request:
```
{
"facetFields": [
"ip_src_addr"
],
"from": 0,
"indices": [
"bro", "snort"
],
"query": "*",
"size": 5
}
```
A "facetCounts" property will be added to the result, looking similar to:
```
"facetCounts": {
"ip_src_addr": {
"95.163.121.204": 1913,
"72.34.49.86": 2159,
"192.168.138.158": 45167,
"188.165.164.184": 82,
"192.168.138.2": 120,
"192.168.66.1": 30771,
"62.75.195.236": 11513,
"192.168.66.121": 3793,
"204.152.254.221": 767
}
}
```
If the "facetFields" property is left out, the search will function the same.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.
Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified and tested manually?
- [x] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to verify your changes?
- [x] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/merrimanr/incubator-metron METRON-1075
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/679.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #679
----
commit afa87ae912f2139d87ac3723f82be60b7c72074b
Author: merrimanr <me...@gmail.com>
Date: 2017-08-02T14:47:45Z
initial commit
----
> Add faceted search capabilities
> -------------------------------
>
> Key: METRON-1075
> URL: https://issues.apache.org/jira/browse/METRON-1075
> Project: Metron
> Issue Type: New Feature
> Reporter: Ryan Merriman
> Assignee: Ryan Merriman
>
> We need a way to perform faceted searches against our search engine. A faceted search returns a distribution of values across search results for a given set of facet fields. This should be part of our DAO indexing abstraction.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)