Skip to content

Conversation

shashank-elastic
Copy link
Contributor

Pull Request

Issue link(s): A task in issue https://github.com/elastic/ia-trade-team/issues/456#issuecomment-2445705638

Summary - What I changed

  • Added Investigation Guides for Amazon Bedrock Guardrails

How To Test

  • Unit test should pass

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, 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

Contributor checklist

@shashank-elastic shashank-elastic added the Rule: Tuning tweaking or tuning an existing rule label Nov 5, 2024
@shashank-elastic shashank-elastic self-assigned this Nov 5, 2024
@protectionsmachine
Copy link
Collaborator

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.
Copy link
Contributor

@terrancedejesus terrancedejesus left a comment

Choose a reason for hiding this comment

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

Couple comments. LGTM

@terrancedejesus terrancedejesus merged commit 6a39009 into main Nov 6, 2024
9 checks passed
@terrancedejesus terrancedejesus deleted the investigation_guide_bedrock branch November 6, 2024 17:58
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
* Add investigation guide for Amazon Bedrock Rules * updated date * review comments * review comments --------- Co-authored-by: Terrance DeJesus <99630311+terrancedejesus@users.noreply.github.com> (cherry picked from commit 6a39009)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
* Add investigation guide for Amazon Bedrock Rules * updated date * review comments * review comments --------- Co-authored-by: Terrance DeJesus <99630311+terrancedejesus@users.noreply.github.com> (cherry picked from commit 6a39009)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
* Add investigation guide for Amazon Bedrock Rules * updated date * review comments * review comments --------- Co-authored-by: Terrance DeJesus <99630311+terrancedejesus@users.noreply.github.com> (cherry picked from commit 6a39009)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport: auto Rule: Tuning tweaking or tuning an existing rule

4 participants