[
https://issues.apache.org/jira/browse/METRON-1661?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16551153#comment-16551153
]
ASF GitHub Bot commented on METRON-1661:
----------------------------------------
GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/1125
METRON-1661: Create Pcap Query Filter endpoint
## Contributor Comments
This PR adds a REST endpoint for submitting a query filter type Pcap query
request.
### Changed Included
- A new Pcap query request endpoint that submits a query filter query
- Slight refactor of the PcapService and PcapServiceImpl class that changes
the fixed method to a submit method that can handle either a fixed pcap request
of query pcap request
- Unit and integration tests
### Testing
This has been tested in full dev. Testing instructions are as follows:
1. Spin up full dev
2. Create the HDFS directories specified in application.yml
- /apps/metron/pcap/input
- /apps/metron/pcap/interim
- /apps/metron/pcap/output
3. Put pcap data in `/apps/metron/pcap/input`
4. Run a query pcap query to generate results (note the query property):
```
curl -X POST --header 'Content-Type: application/json' --header 'Accept:
application/json' -d '{
"endTimeMs": 1458240269424,
"startTimeMs": 1458240269419,
"query":"ip_dst_port == 22"
}' 'http://node1:8082/api/v1/pcap/query'
```
5. Monitor the job with the get status endpoint until the job has SUCCEEDED
and returns a pageTotal:
```
{
"jobId": "job_1532012905403_0001",
"jobStatus": "SUCCEEDED",
"description": "map: 20.0%, reduce: 0.0%",
"percentComplete": 100,
"pageTotal": 1
}
```
Once the job has finished results should be present in HDFS in a location
that is similar to
`/apps/metron/pcap/output/user/MAP_REDUCE/job_1532012905403_0001/page-1.pcap`
(job id will be different). The pcaps in the results should match the
condition specified in the "query" property in the request.
## 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-1661
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1125.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 #1125
----
commit 8b226691057d100ed5ff61dfa88c2e6ed984ec8a
Author: merrimanr <merrimanr@...>
Date: 2018-07-10T17:17:51Z
initial commit
commit c53ca24d40cb57743e85ce9dc58d5caa9e93588c
Author: merrimanr <merrimanr@...>
Date: 2018-07-20T16:30:24Z
Merge remote-tracking branch 'mirror/feature/METRON-1554-pcap-query-panel'
into METRON-1661
# Conflicts:
#
metron-interface/metron-rest/src/main/java/org/apache/metron/rest/controller/PcapController.java
#
metron-interface/metron-rest/src/main/java/org/apache/metron/rest/service/PcapService.java
#
metron-interface/metron-rest/src/main/java/org/apache/metron/rest/service/impl/PcapServiceImpl.java
#
metron-interface/metron-rest/src/test/java/org/apache/metron/rest/controller/PcapControllerIntegrationTest.java
#
metron-interface/metron-rest/src/test/java/org/apache/metron/rest/mock/MockPcapJob.java
#
metron-interface/metron-rest/src/test/java/org/apache/metron/rest/service/impl/PcapServiceImplTest.java
commit 8c9a635076f672f0f5e666b8762e3be700935cb1
Author: merrimanr <merrimanr@...>
Date: 2018-07-20T19:00:48Z
resolved more merge conflicts
----
> Create Pcap Query Filter endpoint
> ---------------------------------
>
> Key: METRON-1661
> URL: https://issues.apache.org/jira/browse/METRON-1661
> Project: Metron
> Issue Type: Sub-task
> Reporter: Ryan Merriman
> Assignee: Ryan Merriman
> Priority: Major
>
> A REST endpont is needed to expose a way to submit a Pcap query filter job:
> POST /api/v1/pcap/query - This endpoint would accept a query pcap request,
> submit a pcap job, and return a job id. The request would be an object
> containing the options documented here for the query filter:
> [https://github.com/apache/metron/tree/master/metron-platform/metron-pcap-backend#query-filter-utility].
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
