ソースを参照

update parser and scenari doc (#116)

Co-authored-by: AlteredCoder <AlteredCoder>
AlteredCoder 5 年 前
コミット
672785ba17
2 ファイル変更11 行追加3 行削除
  1. 5 1
      docs/references/parsers.md
  2. 6 2
      docs/references/scenarios.md

+ 5 - 1
docs/references/parsers.md

@@ -151,10 +151,14 @@ It is meant to help understanding parser node behaviour by providing contextual
 filter: expression
 ```
 
-`filter` must be a valid {{expr.htmlname}} expression that will be evaluated against the {{event.name}}.
+`filter` must be a valid {{expr.htmlname}} expression that will be evaluated against the {{event.htmlname}}.
+
 If `filter` evaluation returns true or is absent, node will be processed.
+
 If `filter` returns `false` or a non-boolean, node won't be processed.
 
+Here is the [expr documentation](https://github.com/antonmedv/expr/tree/master/docs).
+
 Examples :
 
  - `filter: "evt.Meta.foo == 'test'"`

+ 6 - 2
docs/references/scenarios.md

@@ -87,12 +87,16 @@ The name must be unique (and will define the scenario's name in the hub), and th
 ### filter
 
 ```yaml
-filter: evt.Meta.log_type == 'telnet_new_session'
+filter: expression
 ```
 
+`filter` must be a valid {{expr.htmlname}} expression that will be evaluated against the {{event.htmlname}}.
 
-an {{expr.htmlname}} that must return true if the event is eligible for the bucket.
+If `filter` evaluation returns true or is absent, event will be pour in the bucket.
 
+If `filter` returns `false` or a non-boolean, the event will be skip for this bucket.
+
+Here is the [expr documentation](https://github.com/antonmedv/expr/tree/master/docs).
 
 Examples :