Skip to content

Commit de91558

Browse files
author
Jacek Kolezynski
committed
[Security Solution] Fix naming inconsistency for telemetry events (#238088)
**Partially resolves: #140369** ## Summary This PR fixes naming inconsistency that creeped in my previous PRs. We should use always 'hasBaseVersion' (currently there is a mixture of hasBaseVersion and hasMissingBaseVersion). In order to be sure that the visualizations (which need to be updated) use only the event with the new shape, I am adding 'v2' to the name. (cherry picked from commit 207cb36)
1 parent 9a953b2 commit de91558

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

x-pack/solutions/security/plugins/security_solution/public/common/lib/telemetry/events/rule_upgrade/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const ruleUpgradeFlyoutButtonClickEvent: RuleUpgradeTelemetryEvent = {
1818
optional: false,
1919
},
2020
},
21-
hasMissingBaseVersion: {
21+
hasBaseVersion: {
2222
type: 'boolean',
2323
_meta: {
2424
description: 'Indicates if the rule has a missing base version',
@@ -44,7 +44,7 @@ export const ruleUpgradeSingleButtonClickEvent: RuleUpgradeTelemetryEvent = {
4444
export const ruleUpgradeOpenFlyoutEvent: RuleUpgradeTelemetryEvent = {
4545
eventType: RuleUpgradeEventTypes.RuleUpgradeFlyoutOpen,
4646
schema: {
47-
hasMissingBaseVersion: {
47+
hasBaseVersion: {
4848
type: 'boolean',
4949
_meta: {
5050
description: 'Indicates if the rule has a missing base version',

x-pack/solutions/security/plugins/security_solution/public/common/lib/telemetry/events/rule_upgrade/types.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@
77
import type { RootSchema } from '@kbn/core/public';
88

99
export enum RuleUpgradeEventTypes {
10-
RuleUpgradeFlyoutButtonClick = 'Click Rule Upgrade Flyout Button',
10+
RuleUpgradeFlyoutButtonClick = 'Click Rule Upgrade Flyout Button v2',
1111
RuleUpgradeSingleButtonClick = 'Click Rule Upgrade Single Button',
12-
RuleUpgradeFlyoutOpen = 'Open Rule Upgrade Flyout',
12+
RuleUpgradeFlyoutOpen = 'Open Rule Upgrade Flyout v2',
1313
}
1414
interface ReportRuleUpgradeFlyoutButtonClickParams {
1515
type: 'update' | 'dismiss';
16-
hasMissingBaseVersion: boolean;
16+
hasBaseVersion: boolean;
1717
}
1818

1919
interface ReportRuleUpgradeSingleButtonClickParams {
2020
hasBaseVersion: boolean;
2121
}
2222

2323
interface ReportRuleUpgradeFlyoutOpenParams {
24-
hasMissingBaseVersion: boolean;
24+
hasBaseVersion: boolean;
2525
}
2626

2727
export interface RuleUpgradeTelemetryEventsMap {

x-pack/solutions/security/plugins/security_solution/public/detection_engine/rule_management/hooks/use_prebuilt_rules_upgrade.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -353,16 +353,16 @@ export function usePrebuiltRulesUpgrade({
353353
);
354354
const closeRulePreviewAction = (rule: RuleResponse, reason: RulePreviewFlyoutCloseReason) => {
355355
const ruleUpgradeState = rulesUpgradeState[rule.rule_id];
356-
const hasMissingBaseVersion = ruleUpgradeState.has_base_version === false;
356+
const hasBaseVersion = ruleUpgradeState.has_base_version === true;
357357
if (reason === 'dismiss') {
358358
telemetry.reportEvent(RuleUpgradeEventTypes.RuleUpgradeFlyoutButtonClick, {
359359
type: 'dismiss',
360-
hasMissingBaseVersion,
360+
hasBaseVersion,
361361
});
362362
} else {
363363
telemetry.reportEvent(RuleUpgradeEventTypes.RuleUpgradeFlyoutButtonClick, {
364364
type: 'update',
365-
hasMissingBaseVersion,
365+
hasBaseVersion,
366366
});
367367
}
368368
};
@@ -382,9 +382,9 @@ export function usePrebuiltRulesUpgrade({
382382
(ruleId: string) => {
383383
openRulePreviewDefault(ruleId);
384384
const ruleUpgradeState = rulesUpgradeState[ruleId];
385-
const hasMissingBaseVersion = ruleUpgradeState.has_base_version === false;
385+
const hasBaseVersion = ruleUpgradeState.has_base_version === true;
386386
telemetry.reportEvent(RuleUpgradeEventTypes.RuleUpgradeFlyoutOpen, {
387-
hasMissingBaseVersion,
387+
hasBaseVersion,
388388
});
389389
},
390390
[openRulePreviewDefault, rulesUpgradeState, telemetry]

0 commit comments

Comments
 (0)