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

[Security Solution] Collect usage statistics for prebuilt rule customization #140369

Open
Tracked by #174168
xcrzx opened this issue Sep 9, 2022 · 3 comments
Open
Tracked by #174168
Assignees
Labels
8.18 candidate Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area needs product Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. telemetry Issues related to the addition of telemetry to a feature

Comments

@xcrzx
Copy link
Contributor

xcrzx commented Sep 9, 2022

Epics: https://github.com/elastic/security-team/issues/1974 (internal), #174168

Summary

As part of the prebuilt rule customization epic, we need to implement custom telemetry data collection to get essential insights into the usage of the feature.

We want to collect the following data:

  • Breakdown of a number of Elastic prebuilt rules ("stock"), Elastic custom rules (prebuilt rules with customizations), and fully custom rules (user-defined) per cluster. We can use snapshot telemetry here with daily granularity.

  • Breakdown of which fields are being customized. Send a telemetry event once users save a rule with all customized fields and the rule information: rule_id, type, version.

    • Including bulk actions
  • Number of field conflicts for customised Elastic rules with updates, break down by with/without prepopulated final version. Event based, collect this information inside the perform upgrade API. For every customized field, collect the selected version (base, target, merged, resolved) and conflict.

  • Check if rule names or other sensitive info is gathered by snapshot telementry and remove

Future improvements:

  • Collect information on used bulk upgrade options, like upgrade all rules without conflicts
@xcrzx xcrzx added Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. telemetry Issues related to the addition of telemetry to a feature Team:Detection Rule Management Security Detection Rule Management Team Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area labels Sep 9, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@banderror
Copy link
Contributor

banderror commented Sep 12, 2022

Once we have some draft implementation of prebuilt rule customization (likely hidden behind a feature flag) we will need more details on telemetry to be collected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.18 candidate Feature:Prebuilt Detection Rules Security Solution Prebuilt Detection Rules area needs product Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. telemetry Issues related to the addition of telemetry to a feature
Projects
None yet
Development

No branches or pull requests

4 participants