Skip to content

[DOCS] Document event_match_type option for master and minion configuration files #58891

@ScriptAutomate

Description

@ScriptAutomate

Description

This was discovered as part of working on #58112

How is event_match_type used, when listed in the minion and master config files?

salt/conf/minion

Lines 929 to 932 in 8afbb8e

###### Miscellaneous settings ######
############################################
# Default match type for filtering events tags: startswith, endswith, find, regex, fnmatch
#event_match_type: startswith

Suggested Fix

Define how it is used, and what the available values mean, at least somewhere in the master and minion docs (*.rst files)

  • startswith
  • endswith
  • find
  • regex
  • fnmatch

Type of documentation

  • minion/master configuration files
  • Salt Documentation (.rst) for master/minion configuration files

Location or format of documentation

Master:

Minion:

Additional context

15:28 $ grep -nr "event_match_type"| grep -v "Binary file"
salt/utils/event.py:450:            match_type = self.opts["event_match_type"]
salt/utils/event.py:618:            Default is opts['event_match_type'] or 'startswith'
salt/config/__init__.py:438:        "event_match_type": str,
salt/config/__init__.py:1225:        "event_match_type": "startswith",
salt/config/__init__.py:1469:        "event_match_type": "startswith",      "event_match_type": "startswith",

Potentially related results come from grep -nr "match_type"

Metadata

Metadata

Assignees

No one assigned

    Labels

    doc-requestnet new docs requesteddocumentationRelates to Salt documentationseverity-medium3rd level, incorrect or bad functionality, confusing and lacks a work aroundtime-estimate-sprint

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions