Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace master doc URLs with current #4433

Closed
wants to merge 1 commit into from
Closed

Conversation

lcawl
Copy link

@lcawl lcawl commented Jan 31, 2025

Pull Request

Issue link(s):
Related to elastic/docs#3160

Summary - What I changed

We are going to be retiring the "master" documentation, so this PR is intended to fix the hard-coded links to that version of the docs.

Note that this PR seems like it will need to be backported to at least 8.9, since errors like this appear in our doc build test:

...
/tmp/docsbuild/target_repo/html/en/security/8.9/persistence-via-update-orchestrator-service-hijack.html contains broken links to:
--
  | INFO:build_docs:   - en/security/master/invest-guide-run-osquery.html
  | INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/security/8.9/persistence-via-wmi-standard-registry-provider.html contains broken links to:
  | INFO:build_docs:   - en/security/master/invest-guide-run-osquery.html
  | INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/security/8.9/persistent-scripts-in-the-startup-directory.html contains broken links to:
  | INFO:build_docs:   - en/security/master/invest-guide-run-osquery.html
  | INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/security/8.9/potential-antimalware-scan-interface-bypass-via-powershell.html contains broken links to:
  | INFO:build_docs:   - en/security/master/invest-guide-run-osquery.html
...

Note that we are moving to a new doc system that will use a new style of URLs for V9 and later. Thus the links for V9 and later targets will need to be updated again at that time.

How To Test

I'm not sure what steps are required to generate pages like https://www.elastic.co/guide/en/security/current/wireless-credential-dumping-using-netsh-command.html but that is where links for "Osquery Markdown Plugin" were targeting https://www.elastic.co/guide/en/security/master/invest-guide-run-osquery.html and should target https://www.elastic.co/guide/en/security/current/invest-guide-run-osquery.html instead.

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

Contributor checklist

@botelastic botelastic bot added bbr Building Block Rules Domain: Cloud Domain: Endpoint Integration: AWS AWS related rules Integration: Okta okta related rules ML machine learning related rule OS: Linux OS: macOS OS: Windows windows related rules python Internal python for the repository labels Jan 31, 2025
@Mikaayenson Mikaayenson added the Rule: Tuning tweaking or tuning an existing rule label Jan 31, 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.

Copy link
Contributor

@Mikaayenson Mikaayenson left a comment

Choose a reason for hiding this comment

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

Other than the small linting, this lgtm

2s
Run python -m flake8 tests detection_rules --ignore D203,N815 --max-line-length 120
tests/test_all_rules.py:1344:121: E501 line too long (121 > 120 characters)
Error: Process completed with exit code 1.

Since we're touching the unit tests AND rules, we need to open a maintenance window to address the release branches when they backport. cc. @shashank-elastic

@shashank-elastic
Copy link
Contributor

shashank-elastic commented Feb 3, 2025

This was created from a fork. This might cause issues when we merge upstream ( although I am not sure, never seen a fork merge into our main before) .

image @lcawl I would suggest we make a new branch on detection-rules and apply this change.

cc @Mikaayenson

@shashank-elastic
Copy link
Contributor

We have replicated this PR for merging to our main via #4439

This can be closed. We have cherry-picked the commit so as file changes are identical

@shashank-elastic
Copy link
Contributor

shashank-elastic commented Feb 3, 2025

Fix is merged via - #4439. Since this PR was opened as a fork as opposed to a branch.

Closing this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport: auto bbr Building Block Rules community Domain: Cloud Domain: Endpoint Integration: AWS AWS related rules Integration: Okta okta related rules ML machine learning related rule OS: Linux OS: macOS OS: Windows windows related rules python Internal python for the repository Rule: Tuning tweaking or tuning an existing rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants