metron-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <>
Subject [jira] [Commented] (METRON-1075) Add faceted search capabilities
Date Wed, 02 Aug 2017 23:44:00 GMT


ASF GitHub Bot commented on METRON-1075:

GitHub user merrimanr opened a pull request:

    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": [
      "from": 0,
      "indices": [
        "bro", "snort"
      "query": "*",
      "size": 5
    A "facetCounts" property will be added to the result, looking similar to:
    "facetCounts": {
        "ip_src_addr": {
          "": 1913,
          "": 2159,
          "": 45167,
          "": 82,
          "": 120,
          "": 30771,
          "": 11513,
          "": 3793,
          "": 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](
for the complete guide to follow for contributions.  
    Please refer also to our [Build Verification Guidelines](
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](

    - [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
    ### 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
    - [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/ 
    - [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](

    - [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]( 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 METRON-1075

Alternatively you can review and apply these changes as the patch at:

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 <>
Date:   2017-08-02T14:47:45Z

    initial commit


> Add faceted search capabilities
> -------------------------------
>                 Key: METRON-1075
>                 URL:
>             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

View raw message