anandsubbu commented on a change in pull request #1354: METRON-2032: Create
summary table having list of stellar functions in README
URL: https://github.com/apache/metron/pull/1354#discussion_r266879332
##########
File path: metron-platform/metron-management/README.md
##########
@@ -54,9 +54,22 @@ The functions are split roughly into a few sections:
* File functions - Functions around interacting with local or HDFS files
* Configuration functions - Functions surrounding pulling and pushing configs
from zookeeper
* Parser functions - Functions surrounding adding, viewing, and removing
Parser functions.
+* Indexing functions - Functions surrounding setting indexing parameters
(batch size and timeout), setting the index, enabling/disabling index writer
for sensors.
* Enrichment functions - Functions surrounding adding, viewing and removing
Stellar enrichments as well as managing batch size, batch timeout, and index
names for the enrichment topology configuration
* Threat Triage functions - Functions surrounding adding, viewing and removing
threat triage functions.
+| Type | List of Functions |
| |
| | | |
+| :-----------------------: | :-------------------------------: |
:--------------------------------: |
:---------------------------------------------: | :---------: | :---------: |
:----------: | :------------: |
+| Grok Functions | [`GROK_EVAL`](#grok_eval) |
[`GROK_PREDICT`](#grok_predict) | | | | | |
Review comment:
I want to make sure I understood you correctly. Are you suggesting a long
vertical list of functions for the summary, like
[here](https://github.com/apache/metron/tree/74ec7fedd48135123092b2a638ed1f2e2f57530c/metron-stellar/stellar-common#stellar-core-functions)
? In which case, we might not be able to add the function classification
(Parser functions, Grok functions etc.). Or are you suggesting separate lists
for each classification? Something like the below?
| **Grok functions** |
| Function 1 |
| Function 2 |
| .... |
| **Parser functions** |
| Function 1 |
| Function 2 |
| .... |
In stellar common, I found that the long list of vertical functions is a bit
overwhelming for someone who wants a quick 'table of contents' for the list of
functions. I created this summary so it will give me a quick snapshot of the
available functions.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
