[jira] [Commented] (METRON-1218) Metron REST should return better error messages

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

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

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

GitHub user merrimanr opened a pull request:

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

    METRON-1218: Metron REST should return better error messages

    ## Contributor Comments
    This PR improves the error handling in the REST app and adds logging to failed searches in the ElasticsearchDao.  This can be tested in full dev by executing a search against REST with a value for "from" that is larger than the index.  For example:
    `{
      "from": 1000000000,
      "indices": [
        "bro"
      ],
      "query": "*",
      "size": 0
    }`
    
    Before it would just return:
    `{
      "responseCode": 500,
      "message": "Could not execute search",
      "fullMessage": "Could not execute search"
    }`
    
    but after this change it should instead include the root cause:
    `{
      "responseCode": 500,
      "message": "Could not execute search",
      "fullMessage": "Result window is too large, from + size must be less than or equal to: [10000] but was [100000005]. See the scroll api for a more efficient way to request large data sets. This limit can be set by changing the [index.max_result_window] index level parameter."
    }`
    
    There should also be the full stacktrace in /var/log/metron/metron-rest.log.  
    
    This change should improve all error messages that are returned from REST and are not limited to this case.  I also added a unit test for the REST exception handler class.
    
    ## 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-1218

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

    https://github.com/apache/metron/pull/779.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 #779
    
----
commit 0f061223bc2f0e0a8fb6eedcc3cc56427993c005
Author: merrimanr <me...@gmail.com>
Date:   2017-09-28T21:53:40Z

    initial commit

----


> Metron REST should return better error messages
> -----------------------------------------------
>
>                 Key: METRON-1218
>                 URL: https://issues.apache.org/jira/browse/METRON-1218
>             Project: Metron
>          Issue Type: Bug
>            Reporter: Ryan Merriman
>            Assignee: Ryan Merriman
>
> Currently, Metron REST does not provide enough detail when an error happens.  For example, an error that happens in the search endpoint will simply return "Could not execute search" with no detail and nothing in the metron-rest.log.



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