METRON-1674: Create REST endpoint for job status abstraction #1109

merrimanr · 2018-07-16T21:45:36Z

Contributor Comments

This PR is built on top of #1108 and should be merged and final review done after that is accepted into the feature branch. This exposes the job manager and job status abstraction through a REST endpoint.

A summary of the changes included:

Adjustments to the existing PcapService to accommodate the new JobManager abstraction
- JobManager is now a Spring bean and job submission/status is done through that
- New properties were added to application.yml and PcapServiceImpl
- PcapJobSupplier was added that allows switching to a mock pcap job during integration testing
- Unit and integration tests were adjusted to match
- Time parameters are now startTimeMs and endTimeMs
FixedPcapRequest now matches the pattern used in PcapRequest
Addition of a PcapStatus object to return status in a simple, consumable structure for the UI
Endpoint to get job status was added
ConfigOption was adjusted to automatically handle type conversions in cases where Jackson deserialization is used (Integer to Long for example)
InMemoryJobManager now throws a JobNotFoundException when jobs don't exist for a username/job id combination
PcapJob will automatically convert PcapOptions.START_TIME_MS to PcapOptions.START_TIME_NS when START_TIME_NS is not set (same goes for END_TIME_NS)
New unit and integration tests added for get status endpoint and service

This has been tested in full dev. The HDFS paths must be created manually for the paths specified in application.yml:

/apps/metron/pcap/input
/apps/metron/pcap/interim
/apps/metron/pcap/output

To test in full dev, create the HDFS directories mentioned above and put pcap data in /apps/metron/pcap/input. Submit a fixed pcap query:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
  "endTimeMs": 1458240269424,
  "startTimeMs": 1458240269419
}' 'http://node1:8082/api/v1/pcap/fixed'

A job id should be returned in the response:

{
  "jobId": "job_1531258337010_0021",
  "jobStatus": "RUNNING",
  "description": "map: 0.0%, reduce: 0.0%",
  "percentComplete": 0,
  "size": 0
}

Job status can now be retrieved using the get job status endpoint:

curl -X GET --header 'Accept: application/json' 'http://node1:8082/api/v1/pcap/job_1531258337010_0021'

Check the job status with this endpoint for the next minute or so. The percentComplete field in the response should increase over time:

{
  "jobId": "job_1531258337010_0021",
  "jobStatus": "RUNNING",
  "description": "map: 20.0%, reduce: 0.0%",
  "percentComplete": 10,
  "size": 0
}

The jobStatus field should transition from RUNNING > FINALIZING > SUCCEEDED. Once the job is in the SUCCEEDED state, the results should be available in HDFS. The result path will follow this pattern:

/apps/metron/pcap/output/{user}/{jobType}/{jobId}/page-*

Depending on the page size, the output should look something like:

Found 2 items
-rw-r--r--   1 metron metron       2236 2018-07-15 16:51 /apps/metron/pcap/output/user/MAP_REDUCE/job_1531258337010_0021/page-1
-rw-r--r--   1 metron metron       1388 2018-07-15 16:51 /apps/metron/pcap/output/user/MAP_REDUCE/job_1531258337010_0021/page-2

A full, comprehensive review should be done after #1108 has been merged.

Pull Request Checklist

Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines 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:

Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
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.
Has your PR been rebased against the latest commit within the target branch (typically master)?

For code changes:

Have you included steps to reproduce the behavior or problem that is being changed or addressed?
Have you included steps or a guide to how the change may be verified and tested manually?
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 
```
Have you written or updated unit tests and or integration tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
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 is set up for your personal repository such that your branches are built there before submitting a pull request.

…in config as Map

Pcap job manager generics from cestella

…letely

…r for synchronicity. Kill remnants of the job service.

…into pcap-job-manager

Get PcapTopologyIntegrationTest working

cestella · 2018-07-17T14:36:04Z

metron-interface/metron-rest/src/main/java/org/apache/metron/rest/config/PcapJobSupplier.java

+      return pcapJob.submit(PcapFinalizerStrategies.REST, pcapRequest);
+    } catch (JobException e) {
+      return null;
+      //return new JobStatus().withState(JobStatus.State.FAILED).withDescription(JobStatus.State.FAILED.toString());


Is this intended? Seems like we should be passing back info about the exception or at the very least throwing a runtime exception, right?

Yes this was a mistake. A runtime exception is thrown now.

cestella · 2018-07-17T14:37:20Z

metron-platform/metron-common/src/main/java/org/apache/metron/common/utils/HDFSUtils.java

+
+  public static byte[] readBytes(Path inPath) throws IOException {
+    FileSystem fs = FileSystem.get(inPath.toUri(), new Configuration());
+    FSDataInputStream inputStream = fs.open(inPath);


This should be in a try with resources block otherwise you're leaving streams open.

I retract this, it originated in @mmiklavc 's PR. I moved the comment there.

cestella

This is looking good, I'm going to try to pick out the parts that are unique to this and not @mmiklavc 's ticket for review. I'll make another pass in a bit.

…into pcap-job-manager

james-sirota · 2018-07-18T06:03:19Z

Here is what I've done so far:

Capture a random PCAP using tcpdump, place that PCAP into /apps/metron/pcap/input on HDFS, run the service in Swager under POST /api/v1/pcap/fixed

I send

{
"endTime":1531892977000,
"startTime":1458240269424
}

which are the right timestamps for my PCAP, and get back an error:

{
"timestamp": "2018-07-18 06:00:45",
"status": 500,
"error": "Internal Server Error",
"message": "-1",
"path": "/api/v1/pcap/fixed"
}

Which in metron-rest.log corresponds to:

Jul 18, 2018 6:00:45 AM org.apache.catalina.core.StandardWrapperValve invoke
SEVERE: Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.ArrayIndexOutOfBoundsException: -1] with root cause
java.lang.ArrayIndexOutOfBoundsException: -1
at org.apache.metron.pcap.PcapFilenameHelper.getKafkaPartition(PcapFilenameHelper.java:66)
at org.apache.metron.pcap.utils.FileFilterUtil.getFilesByPartition(FileFilterUtil.java:63)
at org.apache.metron.pcap.utils.FileFilterUtil.getPathsInTimeRange(FileFilterUtil.java:50)
at org.apache.metron.pcap.mr.PcapJob.createJob(PcapJob.java:382)
at org.apache.metron.pcap.mr.PcapJob.query(PcapJob.java:276)
at org.apache.metron.pcap.mr.PcapJob.submit(PcapJob.java:235)
at org.apache.metron.rest.config.PcapJobSupplier.get(PcapJobSupplier.java:38)
at org.apache.metron.rest.config.PcapJobSupplier.get(PcapJobSupplier.java:30)
at org.apache.metron.job.manager.InMemoryJobManager.submit(InMemoryJobManager.java:48)
at org.apache.metron.rest.service.impl.PcapServiceImpl.fixed(PcapServiceImpl.java:64)
at org.apache.metron.rest.controller.PcapController.fixed(PcapController.java:58)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:209)
at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:136)

merrimanr · 2018-07-18T13:06:12Z

The latest commit addresses feedback received so far. I also changed the structure of the HDFS paths to avoid issues around reading input and also to output data to unique locations. Previously all data was written to /apps/metron/pcap/output/page-* which obviously won't work. I will update the PR description with new testing instructions.

@james-sirota this should resolve the error you were getting.

james-sirota · 2018-07-18T18:09:46Z

+1 works great. I was able to put the output of the pcap topology into a directory in HDFS, run a query over it, got a page in the output directory (with status correctly updating while the job was running), was able to open the page in wireshark

cestella · 2018-07-18T19:32:16Z

...n-platform/metron-pcap/src/main/java/org/apache/metron/pcap/finalizer/PcapRestFinalizer.java

+  @Override
+  protected Path getOutputPath(Map<String, Object> config, int partition) {
+    String jobId = PcapOptions.JOB_ID.get(config, String.class);
+    String finalOutputPath = PcapOptions.FINAL_OUTPUT_PATH.get(config, String.class);


Why isn't the user passed into the config rather than being in a member variable? This seems inconsistent. I'd expect a PcapOptions.USERNAME.get(config, String.class) rather than a member variable.

The reason I did it that way is because that user property is only used here. Happy to change it to a config.

@merrimanr Yeah, let's do what we did with the interim output path. We've gone down the Map config path so I think we should keep that consistent. There may be some brainstorming we can do around creating pointed option validation (e.g. specific to a finalizer), but for now the PcapOptions route seems sufficient to me.

…r cestella request.

…into pcap-job-manager

…anel' into pcap-job-manager

tiborm · 2018-07-19T15:31:53Z

Is it necessary to have /{user}/{jobType}/ in the output url?
Right now our UI calling this:
/apps/metron/pcap/output/{jobId}/{pageId}

On our side, pageId is a simple int at the moment. Is "page-*" at the end of the URL pattern means the service expecting something like "page-5"?

merrimanr · 2018-07-19T15:34:29Z

@tiborm That is an HDFS path, not a URL. It's of no concern to the UI.

tiborm · 2018-07-19T15:47:48Z

I see, thanks. Is there an endpoint for the PDML output?
Or it is out of the scope of this PR?

merrimanr · 2018-07-19T15:50:43Z

That PR should be up for review soon.

closes #1109

mmiklavc and others added 30 commits June 26, 2018 23:48

Add metron-job project. Update pcap to be Statusable.

41ecf36

Save progress on Pageable implementation

a83b472

Rev metron-job to 0.5.1 after merge with master

976e1bc

Move result writing code to pcapjob. Get pcapclitest working again.

f9fc106

Add Pageable results.

8b4ef9c

change pom change with spaces to tabs

cd302a9

Address review comments. Fix local FS write path problem.

7c1d4a0

Let's try this again.

a00e300

Job manager and job service implementations

ba6cf90

Refactor jobs to have a finalize step

157aa1e

Prototyping rest api bits

9fb3a81

merge with feature branch

2bca32e

Redo the pcap asychronicity to use a Timer for checking status. Pass …

36456d6

…in config as Map

Refactoring the config options to translate between object and map.

6e0b64c

Redoing some stuff

0aa8e6e

Removed some duplication

9c6eaea

forgot licenses

e52c5f0

Merge pull request #24 from cestella/pcap-job-manager-generics

d4faf56

Pcap job manager generics from cestella

initial commit

7971ecb

Move pcap config to metron-pcap module. Remove metron-api module comp…

720dab6

…letely

Move pcapoptions to config package

69cb964

Revert PcapServiceImpl

0615ae6

Get job manager working. Fix pcap cli tests. Make pcap pageable bette…

433d0a3

…r for synchronicity. Kill remnants of the job service.

Merge branch 'pcap-job-manager' of https://github.com/mmiklavc/metron …

935dfc8

…into pcap-job-manager

updated pcap integration test

71f3871

Merge pull request #25 from merrimanr/pcap-job-manager

3e05b7a

Get PcapTopologyIntegrationTest working

Add README to metron-job

7052982

rest endpoint for job status

bcb2af0

fixed failing tests

61ed1ad

Address code review comments

a68930b

cestella reviewed Jul 17, 2018

View reviewed changes

mmiklavc and others added 4 commits July 17, 2018 11:59

Remove pcap service from Ansible deployment scripts.

3fa118f

Fix try with resources in read methods

d588519

Fix iterim path option. Fix timer thread and synchronization issues.

7b3dfbf

Merge branch 'pcap-job-manager' of https://github.com/mmiklavc/metron …

f873410

…into pcap-job-manager

mmiklavc mentioned this pull request Jul 17, 2018

METRON-1614: Create job status abstraction #1108

Closed

10 tasks

merrimanr added 2 commits July 18, 2018 07:34

fixed interim path error

72e8ee0

pr feedback

6e6fb61

merrimanr added 2 commits July 18, 2018 08:26

fixed default numReducers in test

a813f34

added pageTotal to pcap status

6a4df3e

Fix additional internal interim result path

aa8d92e

cestella reviewed Jul 18, 2018

View reviewed changes

mmiklavc and others added 4 commits July 18, 2018 13:32

Fix config option in pcap integration test. Add finalizer comments pe…

374fe2e

…r cestella request.

Merge branch 'pcap-job-manager' of https://github.com/mmiklavc/metron …

d981a19

…into pcap-job-manager

added username to pcap options

38edfd7

Merge remote-tracking branch 'mirror/feature/METRON-1554-pcap-query-p…

c2f265a

…anel' into pcap-job-manager

mmiklavc mentioned this pull request Jul 19, 2018

METRON-1686: Create stop job endpoint for Pcap queries #1115

Closed

10 tasks

asfgit pushed a commit that referenced this pull request Jul 19, 2018

METRON-1674 Create REST endpoint for job status abstraction (merrimanr)

39ae9f4

closes #1109

merrimanr closed this Jul 19, 2018

This was referenced Jul 24, 2018

METRON-1690: Add more context to PcapJob JobStatus #1128

Closed

METRON-1693: Fix Pcap CLI local FS finalizer #1130

Closed

METRON-1674: Create REST endpoint for job status abstraction #1109

METRON-1674: Create REST endpoint for job status abstraction #1109

Uh oh!

Conversation

merrimanr commented Jul 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contributor Comments

Pull Request Checklist

For all changes:

For code changes:

For documentation related changes:

Note:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cestella left a comment

Choose a reason for hiding this comment

Uh oh!

james-sirota commented Jul 18, 2018

Uh oh!

merrimanr commented Jul 18, 2018

Uh oh!

james-sirota commented Jul 18, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tiborm commented Jul 19, 2018

Uh oh!

merrimanr commented Jul 19, 2018

Uh oh!

tiborm commented Jul 19, 2018

Uh oh!

merrimanr commented Jul 19, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

merrimanr commented Jul 16, 2018 •

edited

Loading