Skip to content

Document force_actions priority option and composite promotion - #124

Open
c-rosenberg wants to merge 2 commits into
rspamd:masterfrom
c-rosenberg:feature/force_actions_docs
Open

c-rosenberg wants to merge 2 commits into
rspamd:masterfrom
c-rosenberg:feature/force_actions_docs

Conversation

@c-rosenberg

Copy link
Copy Markdown
Contributor

Summary

Documents the new force_actions priority arbitration and automatic composite promotion. Companion to rspamd/rspamd#.

Changes (docs/modules/force_actions.md)

  • New priority option: low, normal (default), high, critical, or 0-3.
  • New "Priority" section: highest priority match wins regardless of registration order; invalid values are warned about and ignored, fractions are floored, out of range values are clamped. Also covers the least combination and the priority:N symbol option.
  • "Execution Order": rules that reference a composite are registered as postfilters, with the caveat that an earlier pre-result without process_all stops composite evaluation.
  • process_all: clearer description of what it does.
  • "Symbol names": the rule name is used as is. The page previously said it was uppercased, which was wrong.
  • "Legacy configuration": priority is not available in the legacy actions {} format.

- add the priority option (low/normal/high/critical or 0-3) and a
  Priority section: the highest priority match wins regardless of
  registration order, invalid values are ignored with a warning,
  fractions are floored and out of range values are clamped
- document the priority:N symbol option and the warning for combining
  priority with least
- explain that rules referencing a composite are registered as
  postfilters, and that they are still starved if an earlier pre-result
  lacks process_all
- explain that same action rules still record their result, with
  process_all implied, once any rule sets a priority
- correct the symbol name rule: the rule name is used as is, it is not
  uppercased
- note that priority is not available in the legacy actions format
- mark the new behaviour as available since 4.2.3
- a rule without priority skips an already selected action but keeps
  it: a lower-priority rule matching later cannot replace it
- a rule with its own priority records the selected action too, keeps
  the previous reply and makes the verdict passthrough
- process_all is implied only for filter-stage rules below another
  non-least rule, not module-wide
- composite rules run right after the composites, before greylisting
  and the require_action/honor_action rules, which run by priority
- note the composites that cannot be detected, and that rules without
  priority now record at normal while least rules stay at low

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants