metron-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (METRON-1073) Add option to limit fields returned from search query
Date Wed, 02 Aug 2017 13:32:00 GMT

    [ https://issues.apache.org/jira/browse/METRON-1073?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16110905#comment-16110905
] 

ASF GitHub Bot commented on METRON-1073:
----------------------------------------

GitHub user merrimanr opened a pull request:

    https://github.com/apache/metron/pull/677

    METRON-1073: Add option to limit fields returned from search query

    ## Contributor Comments
    This PR adds the option to explicitly declare which fields should be returned in search
results.  Adding a "fields" property to the search request with a list of fields as the value
should only return those fields (timestamp is always returned).  This is an example search
request that only returns the "ip_src_addr" field:
    ```
    {
      "fields":["ip_src_addr"],
      "from": 0,
      "indices": [
        "bro","snort"
      ],
      "query": "*",
      "size": 5
    }
    ```
    
    This can be tested in full dev through the Swagger UI.  Execute this search request in
the search-controller and fields should be returned appropriately.
    
    ## 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-1073

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

    https://github.com/apache/metron/pull/677.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 #677
    
----
commit 82e73ab9b1c076651ae5405140424c3f88a1fcf6
Author: merrimanr <merrimanr@gmail.com>
Date:   2017-08-01T22:59:28Z

    initial commit

----


> Add option to limit fields returned from search query
> -----------------------------------------------------
>
>                 Key: METRON-1073
>                 URL: https://issues.apache.org/jira/browse/METRON-1073
>             Project: Metron
>          Issue Type: New Feature
>            Reporter: Ryan Merriman
>            Assignee: Ryan Merriman
>
> We need a way to specify which search index fields should be returned.  This parameter
is optional with all fields being returned by default.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message