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.

Sign up for GitHub

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][Detection Engine] adds EBT telemetry for rule preview #194326

Merged
merged 10 commits into from
Oct 10, 2024
Merged

[Security Solution][Detection Engine] adds EBT telemetry for rule preview #194326

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
595ad23
[Security Solution][Detection Engine] adds UI counters telemetry for …
vitaliidm Sep 27, 2024
0ea8c50
Merge branch 'main' into de_8_16/preview-rule-telemetry
vitaliidm Sep 27, 2024
34a609f
fix types
vitaliidm Sep 30, 2024
39a6689
Merge branch 'de_8_16/preview-rule-telemetry' of https://github.com/v…
vitaliidm Sep 30, 2024
faf1f73
Merge branch 'main' into de_8_16/preview-rule-telemetry
vitaliidm Sep 30, 2024
1051e66
Merge branch 'main' into de_8_16/preview-rule-telemetry
vitaliidm Oct 9, 2024
b2bd024
switch to EBT
vitaliidm Oct 9, 2024
ffaa4f8
Merge branch 'main' into de_8_16/preview-rule-telemetry
vitaliidm Oct 9, 2024
e3b96a2
EBT browser
vitaliidm Oct 9, 2024
bb5dda9
Merge branch 'de_8_16/preview-rule-telemetry' of https://github.com/v…
vitaliidm Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions x-pack/plugins/security_solution/public/common/lib/telemetry/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ export enum TELEMETRY_EVENT {

// AI assistant on rule creation form
OPEN_ASSISTANT_ON_RULE_QUERY_ERROR = 'open_assistant_on_rule_query_error',

// Rule preview
PREVIEW_RULE_ALL = 'preview_rule_all',
PREVIEW_RULE_WITH_LOGGED_REQUESTS = 'preview_rule_with_logged_requests',
}

export enum TelemetryEventTypes {
Expand Down
9 changes: 9 additions & 0 deletions ...tion/public/detection_engine/rule_creation_ui/components/rule_preview/use_preview_rule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,21 @@ import type {
RuleCreateProps,
RulePreviewResponse,
} from '../../../../../common/api/detection_engine';
import { METRIC_TYPE, TELEMETRY_EVENT, track } from '../../../../common/lib/telemetry';

import { previewRule } from '../../../rule_management/api/api';
import { transformOutput } from '../../../../detections/containers/detection_engine/rules/transforms';
import type { TimeframePreviewOptions } from '../../../../detections/pages/detection_engine/rules/types';
import { usePreviewInvocationCount } from './use_preview_invocation_count';
import * as i18n from './translations';

const trackPreview = (enableLoggedRequests: boolean) => {
track(METRIC_TYPE.COUNT, TELEMETRY_EVENT.PREVIEW_RULE_ALL);
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: maybe using event based telemetry here can be a bit simlier.

it will be just 1 event with property for enabled logs

Copy link
Contributor Author

@vitaliidm vitaliidm Oct 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@nkhristinin

Considered it, but went first with UI counters. On the second thought - it does not look to complicated to add EBT.
So, I reimplemented it. So need another approval here

if (enableLoggedRequests) {
track(METRIC_TYPE.COUNT, TELEMETRY_EVENT.PREVIEW_RULE_WITH_LOGGED_REQUESTS);
}
};

const emptyPreviewRule: RulePreviewResponse = {
previewId: undefined,
logs: [],
Expand Down Expand Up @@ -57,6 +65,7 @@ export const usePreviewRule = ({
const createPreviewId = async () => {
if (rule != null) {
try {
trackPreview(enableLoggedRequests ?? false);
setIsLoading(true);
const previewRuleResponse = await previewRule({
rule: {
Expand Down