Skip to content

Commit 39b0261

Browse files
committed
doc: threshold: document paramter change of pr#2155
add note to news and changelog, make parameter more clear in bots documentation section
1 parent af60b58 commit 39b0261

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ CHANGELOG
7575
- `intelmq.bots.experts.truncate_by_delimiter.expert`: Cut string if its length is higher than a maximum length (PR#1967 by Marius Karotkis).
7676
- `intelmq.bots.experts.remove_affix`: Remove prefix or postfix strings from a field (PR#1965 by Marius Karotkis).
7777
- `intelmq.bots.experts.asn_lookup.expert`: Fixes update-database script on the last few days of a month (PR#2121 by Filip Pokorný, fixes #2088).
78+
- `intelmq.bots.experts.threshold.expert`: Correctly use the standard parameter `redis_cache_ttl` instead of the previously used parameter `timeout` (PR#2155 by Karl-Johan Karlsson).
7879

7980
#### Outputs
8081
- Removed `intelmq.bots.outputs.postgresql`: this bot was marked as deprecated in 2019 announced to be removed in version 3 of IntelMQ (PR#2045 by Birger Schacht).

NEWS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- comment
2-
SPDX-FileCopyrightText: 2015-2021 Sebastian Wagner
2+
SPDX-FileCopyrightText: 2015-2022 Sebastian Wagner
33
SPDX-License-Identifier: AGPL-3.0-or-later
44
-->
55

@@ -31,6 +31,8 @@ sudo find /var/log/ -user intelmq ! -path \*intelmq\*
3131
```
3232

3333
### Configuration
34+
#### Threshold Expert
35+
The parameter `timeout` has been merged into `redis_cache_ttl`.
3436

3537
### Libraries
3638

docs/user/bots.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3194,8 +3194,6 @@ Threshold
31943194
31953195
**Information**
31963196
3197-
3198-
* **Cache parameters** (see section :ref:`common-parameters`)
31993197
* `name`: `intelmq.bots.experts.threshold.expert`
32003198
* `lookup`: redis cache
32013199
* `public`: no
@@ -3204,6 +3202,7 @@ Threshold
32043202
32053203
**Configuration Parameters**
32063204
3205+
* **Cache parameters** (see section :ref:`common-parameters`), especially ``redis_cache_ttl`` as number of seconds before threshold counter is reset. Since version 3.1 (until 3.1 `timeout` was used).
32073206
* `filter_keys`: String, comma-separated list of field names to consider or ignore when determining which messages are similar.
32083207
* `filter_type`: String, `whitelist` (consider only the fields in `filter_keys`) or `blacklist` (consider everything but the fields in `filter_keys`).
32093208
* `threshold`: Integer, number of messages required before propagating one. In forwarded messages, the threshold is saved in the message as `extra.count`.

0 commit comments

Comments
 (0)