[jira] [Commented] (METRON-1691) REST should limit the number of Pcap jobs a user can submit

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

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

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

GitHub user merrimanr opened a pull request:

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

    METRON-1691: REST should limit the number of Pcap jobs a user can submit

    ## Contributor Comments
    This PR limits users to submitting no more than a configured number of jobs at the same time.  If a user attempts to submit more than the configured amount, a 500 status code is returned with an error message in this format:
    ```
    Cannot submit job because a job is already running.  Please contact the administrator to cancel job(s) with id(s) <comma-separated list of job ids>
    ```
    The limit is a spring property in this PR but could be exposed directly in Ambari in the future.
    
    A more general method was added to get jobs in a requested state.  This is used here to detect too many running jobs but could also be used to allow the UI to continue monitoring a job on browser refresh, new tab, etc.
    
    ### Changes Included
    
    - A new PcapService method that gets a list of job statuses for jobs that match a requested state
    - A new check in the PcapService.submit method that checks the number of RUNNING jobs against the configured limit
    - A new spring `user.job.limit` property was added to control the number of jobs a user can run simultaneously
    - Opportunistically fixed several pcap model object equals methods
    - Updated the PcapControllerIntegration test to clear the job manager after each test
    - Added unit and integration tests
    
    ### Testing
    This has been tested in full dev.  Testing instructions are as follows:
    
    1. Spin up full dev and put pcap data in the `/apps/metron/pcap/input` HDFS directory
    2. Submit a pcap query:
    ```
    curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{}' 'http://node1:8082/api/v1/pcap/fixed'
    ```
    A job status should be returned as usual.
    
    3. Try to submit another query right after the first submission returns a job status.  You should now get a 500 with a response similar to:
    ```
    {
      "responseCode": 500,
      "message": "Cannot submit job because a job is already running.  Please contact the administrator to cancel job(s) with id(s) job_1532356159290_0017",
      "fullMessage": "RestException: Cannot submit job because a job is already running.  Please contact the administrator to cancel job(s) with id(s) job_1532356159290_0017"
    }
    
    ```
    4. Kill the running job:
    ```
    curl -X DELETE --header 'Accept: application/json' 'http://node1:8082/api/v1/pcap/kill/job_1532356159290_0015'
    ```
    You should now be able to submit a job again.
    
    5. Change the user job limit by setting Ambari > Metron > Configs > REST > Metron Spring options to `--user.job.limit=2`.  You should now be able to submit 2 jobs in a row.  Submitting a third should return an error similar to step 3.
    
    ## 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 && dev-utilities/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:
    - [ ] 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-1691

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

    https://github.com/apache/metron/pull/1129.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 #1129
    
----
commit 0b948ef34d3279c56125ec7d8be516f19b9935b4
Author: merrimanr <me...@...>
Date:   2018-07-24T18:49:41Z

    initial commit

----


> REST should limit the number of Pcap jobs a user can submit
> -----------------------------------------------------------
>
>                 Key: METRON-1691
>                 URL: https://issues.apache.org/jira/browse/METRON-1691
>             Project: Metron
>          Issue Type: Sub-task
>            Reporter: Ryan Merriman
>            Priority: Major
>
> The REST app should keep users from submitting an unbounded number of simultaneous jobs and overwhelming the cluster.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)