Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

METRON-1866: Improve metron-bro-plugin-kafka documentation #17

Closed
wants to merge 4 commits into from

Conversation

JonZeolla
Copy link
Member

Contributor Comments

This depends on METRON-1304. Pure documentation change

Copy link
Contributor

@nickwallen nickwallen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JonZeolla . This looks really good. Just one suggestion for the end of the bro-pkg instructions.

Installed "bro/apache/metron-bro-plugin-kafka" (master)
Loaded "bro/apache/metron-bro-plugin-kafka"
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to add the same sanity check that we have at the end of the manual installation instructions, as the last step here.

[root@localhost ~]#  bro -N Apache::Kafka
Apache::Kafka - Writes logs to Kafka (dynamic, version 0.3)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, added a final step to validate manually. Initially, I left that out since bro-pkg does a very similar test, among others

README.md Outdated
* You can also filter IPv6 logs from within your Metron cluster [using Stellar](https://github.com/apache/metron/tree/master/metron-stellar/stellar-common#is_ip). In that case, you wouldn't apply a predicate in your bro configuration, and instead Stellar would filter the logs out before they were processed by the enrichment layer of Metron.
* It is also possible to use the `is_v6_subnet()` bro function in your predicate, as of their [2.5 release](https://www.bro.org/sphinx-git/install/release-notes.html#bro-2-5), however the above example should work on [bro 2.4](https://www.bro.org/sphinx-git/install/release-notes.html#bro-2-4) and newer, which has been the focus of the kafka plugin.

## Settings

### `kafka_conf`
### `logs_to_send`

This comment was marked as resolved.

This comment was marked as resolved.

@nickwallen
Copy link
Contributor

+1

@asfgit asfgit closed this in 37f05f8 Nov 10, 2018
JonZeolla added a commit to JonZeolla/metron-bro-plugin-kafka that referenced this pull request Nov 10, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants