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

Add additional event types for CrowdStrike integration #8498

Merged
merged 5 commits into from Nov 24, 2023

Conversation

alaudazzi
Copy link
Contributor

This PR adds additional event types that are now supported by the CrowdStrike integration.

Closes #123

@alaudazzi alaudazzi added the enhancement New feature or request label Nov 14, 2023
@alaudazzi alaudazzi requested a review from a team as a code owner November 14, 2023 14:08
@alaudazzi alaudazzi added the documentation Improvements or additions to documentation label Nov 14, 2023
@elasticmachine
Copy link

elasticmachine commented Nov 14, 2023

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-11-23T14:42:19.259+0000

  • Duration: 16 min 48 sec

Test stats 🧪

Test Results
Failed 0
Passed 34
Skipped 0
Total 34

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented Nov 14, 2023

We didn't talk through this together so I wouldn't expect you to know this yet, but there are a few additional steps when opening a PR to update the docs in this repo. I'll outline them here and we can talk about where these documentation-specific instructions should live.

Prerequisites
First, you should download and install the elastic-package CLI tool. (In the context of documentation, we use elastic-package to generate the reference tables from the syntax that looks like this: {{fields "falcon"}}.)

In each /integrations PR

  • Edit the README file in the package's _dev/build/docs/ directory.
    For example, in this PR you already edited packages/crowdstrike/_dev/build/docs/README.md, which is correct! 🎉
  • Add an entry to the changelog.yml. For example, in this PR:
    1. Open packages/crowdstrike/changelog.yml.
    2. Add a new version to the top of the list. Docs-only updates should always be a patch release. For example, if the last version is 1.24.0, you'll add an entry for 1.24.1.
    3. Very briefly describe the changes in description.
    4. For docs-only updates, the type should be bugfix if you're correcting a typo or correcting incorrect information or enhancement if you're adding more context/information.
    5. The link should be this PR.
  • Update the version in manifest.yml. For example, in this PR:
    1. Open packages/crowdstrike/manifest.yml.
    2. Update version to the new version you just added to the changelog.
  • Build the package. For example, in this PR:
    1. Move to the package directory using cd packages/crowdstrike.
    2. Run elastic-package build from there.
    3. Run git status, and you should see a new changed file. In this PR, it will be packages/crowdstrike/docs/README.md. Notice that this is different than the file you edited. This is a copy of the README you edited (including your edits) plus the generated reference tables that replace the syntax like this: {{fields "falcon"}}.
  • Commit changes to changelog.yml, manifest.yml, and both READMEs.
  • Push the changes to this PR and watch for passing checks! 🤞

Example
Take a look at #8240 to see what the diff looks like when you complete all these steps.

@elasticmachine
Copy link

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (2/2) 💚
Files 100.0% (15/15) 💚
Classes 100.0% (15/15) 💚
Methods 95.918% (94/98) 👎 -0.467
Lines 88.221% (3595/4075) 👎 -11.779
Conditionals 100.0% (0/0) 💚

Copy link

@jamiehynds jamiehynds left a comment

Choose a reason for hiding this comment

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

LGTM

@alaudazzi alaudazzi merged commit 249f800 into main Nov 24, 2023
4 checks passed
@elasticmachine
Copy link

Package crowdstrike - 1.25.1 containing this change is available at https://epr.elastic.co/search?package=crowdstrike

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CrowdStrike] Update docs with latest supported events
4 participants