[
https://issues.apache.org/jira/browse/METRON-1700?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16559946#comment-16559946
]
ASF GitHub Bot commented on METRON-1700:
----------------------------------------
GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/1135
METRON-1700: Create REST endpoint to get job configuration
## Contributor Comments
This PR adds a REST endpoint that returns the job configuration for a
submitted job. The endpoint returns a static list of properties that can be
serialized and are useful for frontend applications. Changes outside of REST
were trivial because the PcapJob class already stores the configuration.
### Changes Included
- Added a method to the Statusable interface that returns a configuration
map
- Added a method to the PcapService that filters the Statusable
configuration and returns a subset of properties
- Update 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. Now the configuration can be retrieved with the get configuration
endpoint:
```
curl -X GET --header 'Accept: application/json'
'http://node1:8082/api/v1/pcap/job_1532356159290_0052/configuration'
```
A subset of properties, including those in the pcap query:
```
{
"finalOutputPath": "/apps/metron/pcap/output",
"ipSrcPort": "",
"includeReverse": false,
"startTimeMs": 1449010818000,
"endTimeMs": 1532642418000,
"protocol": "",
"ipDstAddr": "",
"basePath": "/apps/metron/pcap/input",
"packetFilter": "",
"ipSrcAddr": "",
"ipDstPort": "",
"numReducers": 10,
}
```
## 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-1700
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1135.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 #1135
----
commit ecec4cb5c7e9f7991f37a34517203769934bf764
Author: merrimanr <merrimanr@...>
Date: 2018-07-27T15:44:55Z
initial commit
----
> Create REST endpoint to get job configuration
> ---------------------------------------------
>
> Key: METRON-1700
> URL: https://issues.apache.org/jira/browse/METRON-1700
> Project: Metron
> Issue Type: Sub-task
> Reporter: Ryan Merriman
> Priority: Major
>
> We need a REST endpoint that will allow us to retrieve the job configuration
> properties.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
