You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by GitBox <gi...@apache.org> on 2019/01/25 16:50:53 UTC
[GitHub] nickwallen opened a new pull request #1325: METRON-1970 Add
Metadata to Error Messages Generated During Parsing
nickwallen opened a new pull request #1325: METRON-1970 Add Metadata to Error Messages Generated During Parsing
URL: https://github.com/apache/metron/pull/1325
A user can choose to add metadata to each parsed message using the `readMetadata` parser option. The error messages that are generated when a parser error occurs, do not include this metadata. This means that the metadata is lost when an error occurs. The metadata should be persisted with the error message.
For example, with this change the metadata field containing the Kafka topic will be included in the error message as a field named `metron.metadata.topic`.
```
{
"exception": "java.lang.IllegalStateException: Unable to parse Message: \"this is an invalid synthetic message\" }",
"stack": "java.lang.IllegalStateException: Unable to parse Message: ..",
"raw_message": "\"this is an invalid synthetic message\" }",
"error_hash": "3d498968e8df7f28d05db3037d4ad2a3a0095c22c14d881be45fac3f184dbcc3",
"message": "Unable to parse Message: \"this is an invalid synthetic message\" }",
"source.type": "error",
"failed_sensor_type": "bro",
"hostname": "node1",
"error_type": "parser_error",
"guid": "563d8d2a-1493-4758-be2f-5613bfd2d615",
"timestamp": 1548366516634,
"metron.metadata.topic": "bro"
}
```
## Testing
1. In Ambari, change the parser error topic to `parser_errors`. Then restart the parsers.
1. Launch the Stellar REPL.
1. Capture metadata for Bro by setting the value of `readMetadata` to true.
```
[Stellar]>>> conf := CONFIG_GET("PARSER","bro")
{
...
}
```
```
[Stellar]>>> conf := SHELL_EDIT(conf)
{
...
"readMetadata" : true,
...
}
```
```
[Stellar]>>>
[Stellar]>>> CONFIG_PUT("PARSER", conf, "bro")
```
1. Push a message into the `bro` topic which will fail to parser.
```
[Stellar]>>> msg := SHELL_EDIT()
"this is an invalid synthetic message" }
```
```
[Stellar]>>> KAFKA_PUT("bro", msg)
1
```
1. Wait for a bit until the message is processed. When it has been processed, pull the error message off of the error topic. The error message should contain a field `metron.metadata.topic`.
```
[Stellar]>>> KAFKA_GET("parser_errors")
[{
"exception": "java.lang.IllegalStateException: Unable to parse Message: \"this is an invalid synthetic message\" }",
"stack": "java.lang.IllegalStateException: Unable to parse Message: \"this is an invalid synthetic message\" }\n\tat org.apache.metron.parsers.bro.BasicBroParser.parse(BasicBroParser.java:145)\n\tat org.apache.metron.parsers.interfaces.MessageParser.parseOptional(MessageParser.java:54)\n\tat org.apache.metron.parsers.interfaces.MessageParser.parseOptionalResult(MessageParser.java:67)\n\tat org.apache.metron.parsers.ParserRunnerImpl.execute(ParserRunnerImpl.java:144)\n\tat org.apache.metron.parsers.bolt.ParserBolt.execute(ParserBolt.java:252)\n\tat org.apache.storm.daemon.executor$fn__10252$tuple_action_fn__10254.invoke(executor.clj:735)\n\tat org.apache.storm.daemon.executor$mk_task_receiver$fn__10171.invoke(executor.clj:466)\n\tat org.apache.storm.disruptor$clojure_handler$reify__9685.onEvent(disruptor.clj:40)\n\tat org.apache.storm.utils.DisruptorQueue.consumeBatchToCursor(DisruptorQueue.java:472)\n\tat org.apache.storm.utils.DisruptorQueue.consumeBatchWhenAvailable(DisruptorQueue.java:451)\n\tat org.apache.storm.disruptor$consume_batch_when_available.invoke(disruptor.clj:73)\n\tat org.apache.storm.daemon.executor$fn__10252$fn__10265$fn__10320.invoke(executor.clj:855)\n\tat org.apache.storm.util$async_loop$fn__553.invoke(util.clj:484)\n\tat clojure.lang.AFn.run(AFn.java:22)\n\tat java.lang.Thread.run(Thread.java:745)\nCaused by: Unexpected token RIGHT BRACE(}) at position 39.\n\tat org.json.simple.parser.JSONParser.parse(JSONParser.java:146)\n\tat org.json.simple.parser.JSONParser.parse(JSONParser.java:81)\n\tat org.json.simple.parser.JSONParser.parse(JSONParser.java:75)\n\tat org.apache.metron.parsers.bro.JSONCleaner.clean(JSONCleaner.java:49)\n\tat org.apache.metron.parsers.bro.BasicBroParser.parse(BasicBroParser.java:68)\n\t... 14 more\n",
"raw_message": "\"this is an invalid synthetic message\" }",
"error_hash": "3d498968e8df7f28d05db3037d4ad2a3a0095c22c14d881be45fac3f184dbcc3",
"message": "Unable to parse Message: \"this is an invalid synthetic message\" }",
"source.type": "error",
"failed_sensor_type": "bro",
"hostname": "node1",
"error_type": "parser_error",
"guid": "563d8d2a-1493-4758-be2f-5613bfd2d615",
"timestamp": 1548366516634,
"metron.metadata.topic": "bro"
}]
```
## 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:
- [ ] 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).
- [ ] 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](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] 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.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services