This is an automated email from the ASF dual-hosted git repository.
anandsubbu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/metron.git
The following commit(s) were added to refs/heads/master by this push:
new ab9241d METRON-2032 Create summary table having list of stellar
functions in README (anandsubbu) closes apache/metron#1354
ab9241d is described below
commit ab9241d3df5edcd4d6ae84a72f552b0773d50954
Author: anandsubbu <[email protected]>
AuthorDate: Fri Mar 22 12:45:06 2019 +0530
METRON-2032 Create summary table having list of stellar functions in README
(anandsubbu) closes apache/metron#1354
---
metron-platform/metron-management/README.md | 33 +++++++++++++++++++++++++++++
metron-stellar/stellar-common/README.md | 1 +
2 files changed, 34 insertions(+)
diff --git a/metron-platform/metron-management/README.md
b/metron-platform/metron-management/README.md
index f364627..9bd2c52 100644
--- a/metron-platform/metron-management/README.md
+++ b/metron-platform/metron-management/README.md
@@ -54,9 +54,42 @@ 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 | Function Name
|
+| :-------------------------: |
:---------------------------------------------------------------------------: |
+| **Grok Functions** | [`GROK_EVAL`](#grok_eval)
|
+| | [`GROK_PREDICT`](#grok_predict)
|
+| **File Functions (Local)** | [`LOCAL_LS`](#local_ls)
|
+| | [`LOCAL_RM`](#local_rm)
|
+| | [`LOCAL_READ`](#local_read)
|
+| **File Functions (HDFS)** | [`HDFS_LS`](#hdfs_ls)
|
+| | [`HDFS_RM`](#hdfs_rm)
|
+| | [`HDFS_READ`](#hdfs_read)
|
+| **Configuration Functions** | [`CONFIG_GET`](#config_get)
|
+| | [`CONFIG_PUT`](#config_put)
|
+| **Parser Functions** | [`PARSER_CONFIG`](#parser_config)
|
+| | [`PARSER_INIT`](#parser_init)
|
+| | [`PARSER_PARSE`](#parser_parse)
|
+| |
[`PARSER_STELLAR_TRANSFORM_ADD`](#parser_stellar_transform_add) |
+| |
[`PARSER_STELLAR_TRANSFORM_PRINT`](#parser_stellar_transform_print) |
+| |
[`PARSER_STELLAR_TRANSFORM_REMOVE`](#parser_stellar_transform_remove) |
+| **Threat Triage Functions** | [`THREAT_TRIAGE_INIT`](#threat_triage_init)
|
+| |
[`THREAT_TRIAGE_CONFIG`](#threat_triage_config) |
+| | [`THREAT_TRIAGE_SCORE`](#threat_triage_score)
|
+| | [`THREAT_TRIAGE_ADD`](#threat_triage_add)
|
+| |
[`THREAT_TRIAGE_REMOVE`](#threat_triage_remove) |
+| | [`THREAT_TRIAGE_PRINT`](#threat_triage_print)
|
+| |
[`THREAT_TRIAGE_SET_AGGREGATOR`](#threat_triage_set_aggregator) |
+| **Indexing Functions** | [`INDEXING_SET_BATCH`](#indexing_set_batch)
|
+| |
[`INDEXING_SET_ENABLED`](#indexing_set_enabled) |
+| | [`INDEXING_SET_INDEX`](#indexing_set_index)
|
+| **Enrichment Functions** |
[`ENRICHMENT_STELLAR_TRANSFORM_ADD`](#enrichment_stellar_transform_add) |
+| |
[`ENRICHMENT_STELLAR_TRANSFORM_PRINT`](#enrichment_stellar_transform_print) |
+| |
[`ENRICHMENT_STELLAR_TRANSFORM_REMOVE`](#enrichment_stellar_transform_remove) |
+
### Grok Functions
#### `GROK_EVAL`
diff --git a/metron-stellar/stellar-common/README.md
b/metron-stellar/stellar-common/README.md
index 333c2b5..8301f6d 100644
--- a/metron-stellar/stellar-common/README.md
+++ b/metron-stellar/stellar-common/README.md
@@ -165,6 +165,7 @@ Where:
| ----------
|
| [ `ABS`](../../metron-analytics/metron-statistics#abs)
|
| [ `APPEND_IF_MISSING`](#append_if_missing)
|
+| [ `ASN_GET`](#asn_get)
|
| [ `BIN`](../../metron-analytics/metron-statistics#bin)
|
| [ `BLOOM_ADD`](#bloom_add)
|
| [ `BLOOM_EXISTS`](#bloom_exists)
|
