From eb0772f00a90e53d2fda176eb38768a798b023f2 Mon Sep 17 00:00:00 2001 From: viktorbeck98 Date: Thu, 16 Apr 2026 13:47:02 +0200 Subject: [PATCH] update docs for clarity --- docs/detectors.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/detectors.md b/docs/detectors.md index 3366ab7..970fe09 100644 --- a/docs/detectors.md +++ b/docs/detectors.md @@ -90,7 +90,7 @@ List of detectors: ## Configuration -When `auto_config` is set to `False`, the detector expects an explicit `events` block that specifies exactly which variables to monitor: +When `auto_config` is set to `False`, the detector expects an explicit `events` or `global` block that specifies exactly which variables to monitor. `events`refers to event-specific variables while `global` refers to variables, that are not bound to events (`header_variables`can but don't have to be event bound): ```yaml detectors: @@ -116,7 +116,9 @@ detectors: ### Configuration semantics (preliminary) -**`events` key** — The integer key is the `EventID` (or `event_id`) to monitor (see the MatcherParser docs for how EventID is assigned). +**`events` key** — The integer key is the `EventID` (or `event_id`) to monitor (see the [Template Matcher](parsers/template_matcher.md) docs for how the EventID is assigned. + +**`global` key** - This one has a similar functionality as the `events` key but refers to variables, that are not bound to events (thus can only contain `header_variables`). **`variables[].pos`** — The 0-indexed position of the `<*>` wildcard in the matched template, counting from left to right starting at 0. For example, given: