DmesgPlugin: custom priority rules

[niratner]

Summary

Added the ability to provide custom rules to the dmesg plugin analyzer to control the priority of specific regex events. An argument called "priority_override_rules" can be provided to the dmesg plugin's analysis_args which should contain a list of rules. The rules are then compared in order to each error regex and when a rule fully matches, the new_priority field of the rule gets applied to that error regex. The rules accept as keys any attribute of the ErrorRegex class for filtering, "new_priority" as the priority to update to, and "match_all" as a boolean if the rule should always match (can be used for default rules).

Example Usage (this is the full plugin_config.json):

{
  "global_args": {},
  "plugins": {
    "DmesgPlugin": {
      "collection": true,
      "analysis": true,
      "system_interaction_level": "INTERACTIVE",
      "data": null,
      "collection_args": {
        "collect_rotated_logs": false,
        "skip_sudo": false,
        "log_dmesg_data": true
      },
      "analysis_args": {
        "analysis_range_start": null,
        "analysis_range_end": null,
        "check_unknown_dmesg_errors": true,
        "exclude_category": null,
        "interval_to_collapse_event": 60,
        "num_timestamps": 3,
        "error_regex": null,
        "priority_override_rules": [
          {
            "message": ["Page Fault", "My Custom Error Detected"],
            "new_priority": "NO_CHANGE"
          },
          {
            "event_category": "OS",
            "new_priority": "WARNING"
          },
          {
            "match_all": true,
            "new_priority": "INFO"
          }
        ]
      }
    }
  },
  "result_collators": {},
  "name": "plugin_config",
  "desc": "Auto generated config"
}

To run this json use this command:

node-scraper --sys-name <SYSTEM_NAME> --sys-location REMOTE --connection-config ./connection_config.json --plugin-configs plugin_config.json

In this example 3 rules are provided. The first sets prevents priority changes to any errors where the message is either "Page Fault" or "My Custom Error Detected". The second sets the priority of all errors with event_category "OS" to "WARNING". The third sets all other events (due to match_all: true) to priority "INFO".

Test plan

• pytest test/unit
• pytest test/functional (if applicable)
• pre-commit run --all-files

Checklist

• Added/updated tests (or explained why not)
• Updated docs/README if behavior changed
• No secrets or credentials committed

[alexandraBara]

The README needs an update to show an example of how to overwrite, please add it in the same plugin_config displayed in this section of the README: Custom Error Regex Example.

Also update the PR Description with command to run the plugin and a sample plugin_config.json to use, which shows how to use the overwrite

[alexandraBara]

update the docstrings to contain:

• description
• Args
• Returns
  See other files for example.

[alexandraBara]

notice that this ErrorRegex for unknown_dmesg_errors is applied after your priority changes. This will then not take in account your changes and there is no way with the current code to update priority or other fields on this regex. I think whatever changes you add should also apply to this regex.

[alexandraBara]

works as expected