Skip to content

Conversation

Mikaayenson
Copy link
Contributor

@Mikaayenson Mikaayenson commented Jan 22, 2025

Pull Request

Issue link(s): Follow up to #4358

Summary - What I changed

How To Test

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, maintenance, Rule: New, Rule: Deprecation, Rule: Tuning, Hunt: New, or Hunt: Tuning so guidelines can be generated
  • Added the meta:rapid-merge label if planning to merge within 24 hours
  • Secret and sensitive material has been managed correctly
  • Automated testing was updated or added to match the most common scenarios
  • Documentation and comments were added for features that require explanation
Copy link
Contributor

@eric-forte-elastic eric-forte-elastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Peer review, LGTM 👍

@Mikaayenson Mikaayenson added the Rule: Tuning tweaking or tuning an existing rule label Jan 22, 2025
@Mikaayenson Mikaayenson self-assigned this Jan 22, 2025
Copy link
Contributor

Rule: Tuning - Guidelines

These guidelines serve as a reminder set of considerations when tuning an existing rule.

Documentation and Context

  • Detailed description of the suggested changes.
  • Provide example JSON data or screenshots.
  • Provide evidence of reducing benign events mistakenly identified as threats (False Positives).
  • Provide evidence of enhancing detection of true threats that were previously missed (False Negatives).
  • Provide evidence of optimizing resource consumption and execution time of detection rules (Performance).
  • Provide evidence of specific environment factors influencing customized rule tuning (Contextual Tuning).
  • Provide evidence of improvements made by modifying sensitivity by changing alert triggering thresholds (Threshold Adjustments).
  • Provide evidence of refining rules to better detect deviations from typical behavior (Behavioral Tuning).
  • Provide evidence of improvements of adjusting rules based on time-based patterns (Temporal Tuning).
  • Provide reasoning of adjusting priority or severity levels of alerts (Severity Tuning).
  • Provide evidence of improving quality integrity of our data used by detection rules (Data Quality).
  • Ensure the tuning includes necessary updates to the release documentation and versioning.

Rule Metadata Checks

  • updated_date matches the date of tuning PR merged.
  • min_stack_version should support the widest stack versions.
  • name and description should be descriptive and not include typos.
  • query should be inclusive, not overly exclusive. Review to ensure the original intent of the rule is maintained.

Testing and Validation

  • Validate that the tuned rule's performance is satisfactory and does not negatively impact the stack.
  • Ensure that the tuned rule has a low false positive rate.
@Mikaayenson Mikaayenson merged commit 7c6c779 into main Jan 22, 2025
32 of 38 checks passed
@Mikaayenson Mikaayenson deleted the remaining_guides branch January 22, 2025 20:43
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Mikaayenson added a commit that referenced this pull request Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

3 participants