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

Jump to bottom

Update detection rule telemetry field name. #100256

Merged
merged 5 commits into from
May 18, 2021
Merged

Update detection rule telemetry field name. #100256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a78156f
Changing variable name of cases_count_daily to cases_count_total.
clburn-elastic May 18, 2021
e91118a
Merge branch 'master' into update-cases-key-and-telemetry-testing
kibanamachine May 18, 2021
7960faa
Taking comments out of tests and reverting tests to previosu state.
clburn-elastic May 18, 2021
d1fcd5e
Changing meta description to be more descriptive.
clburn-elastic May 18, 2021
9877464
Changing meta description to be more descriptive.
clburn-elastic May 18, 2021
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: 2 additions & 2 deletions x-pack/plugins/security_solution/server/usage/collector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,9 @@ export const registerCollector: RegisterCollector = ({
type: 'long',
_meta: { description: 'The number of daily alerts generated by a rule' },
},
cases_count_daily: {
cases_count_total: {
type: 'long',
_meta: { description: 'The number of daily cases generated by a rule' },
_meta: { description: 'The number of total cases generated by a rule' },
},
},
},
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/security_solution/server/usage/detections/dectections_metrics_helpers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const createStubRule = (
created_on: uuid(),
updated_on: uuid(),
alert_count_daily: alertCount,
cases_count_daily: caseCount,
cases_count_total: caseCount,
});

describe('Detections Usage and Metrics', () => {
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/security_solution/server/usage/detections/detections.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ describe('Detections Usage and Metrics', () => {
detection_rule_detail: [
{
alert_count_daily: 3400,
cases_count_daily: 1,
cases_count_total: 1,
created_on: '2021-03-23T17:15:59.634Z',
elastic_rule: true,
enabled: false,
Expand Down Expand Up @@ -327,7 +327,7 @@ describe('Detections Usage and Metrics', () => {
detection_rule_detail: [
{
alert_count_daily: 0,
cases_count_daily: 1,
cases_count_total: 1,
created_on: '2021-03-23T17:15:59.634Z',
elastic_rule: true,
enabled: false,
Expand Down
16 changes: 8 additions & 8 deletions x-pack/plugins/security_solution/server/usage/detections/detections_metrics_helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export const updateDetectionRuleUsage = (
enabled: detectionRuleMetric.enabled ? usage.query.enabled + 1 : usage.query.enabled,
disabled: !detectionRuleMetric.enabled ? usage.query.disabled + 1 : usage.query.disabled,
alerts: usage.query.alerts + detectionRuleMetric.alert_count_daily,
cases: usage.query.cases + detectionRuleMetric.cases_count_daily,
cases: usage.query.cases + detectionRuleMetric.cases_count_total,
},
};
} else if (detectionRuleMetric.rule_type === 'threshold') {
Expand All @@ -100,7 +100,7 @@ export const updateDetectionRuleUsage = (
? usage.threshold.disabled + 1
: usage.threshold.disabled,
alerts: usage.threshold.alerts + detectionRuleMetric.alert_count_daily,
cases: usage.threshold.cases + detectionRuleMetric.cases_count_daily,
cases: usage.threshold.cases + detectionRuleMetric.cases_count_total,
},
};
} else if (detectionRuleMetric.rule_type === 'eql') {
Expand All @@ -111,7 +111,7 @@ export const updateDetectionRuleUsage = (
enabled: detectionRuleMetric.enabled ? usage.eql.enabled + 1 : usage.eql.enabled,
disabled: !detectionRuleMetric.enabled ? usage.eql.disabled + 1 : usage.eql.disabled,
alerts: usage.eql.alerts + detectionRuleMetric.alert_count_daily,
cases: usage.eql.cases + detectionRuleMetric.cases_count_daily,
cases: usage.eql.cases + detectionRuleMetric.cases_count_total,
},
};
} else if (detectionRuleMetric.rule_type === 'machine_learning') {
Expand All @@ -126,7 +126,7 @@ export const updateDetectionRuleUsage = (
? usage.machine_learning.disabled + 1
: usage.machine_learning.disabled,
alerts: usage.machine_learning.alerts + detectionRuleMetric.alert_count_daily,
cases: usage.machine_learning.cases + detectionRuleMetric.cases_count_daily,
cases: usage.machine_learning.cases + detectionRuleMetric.cases_count_total,
},
};
} else if (detectionRuleMetric.rule_type === 'threat_match') {
Expand All @@ -141,7 +141,7 @@ export const updateDetectionRuleUsage = (
? usage.threat_match.disabled + 1
: usage.threat_match.disabled,
alerts: usage.threat_match.alerts + detectionRuleMetric.alert_count_daily,
cases: usage.threat_match.cases + detectionRuleMetric.cases_count_daily,
cases: usage.threat_match.cases + detectionRuleMetric.cases_count_total,
},
};
}
Expand All @@ -158,7 +158,7 @@ export const updateDetectionRuleUsage = (
? updatedUsage.elastic_total.disabled + 1
: updatedUsage.elastic_total.disabled,
alerts: updatedUsage.elastic_total.alerts + detectionRuleMetric.alert_count_daily,
cases: updatedUsage.elastic_total.cases + detectionRuleMetric.cases_count_daily,
cases: updatedUsage.elastic_total.cases + detectionRuleMetric.cases_count_total,
},
};
} else {
Expand All @@ -173,7 +173,7 @@ export const updateDetectionRuleUsage = (
? updatedUsage.custom_total.disabled + 1
: updatedUsage.custom_total.disabled,
alerts: updatedUsage.custom_total.alerts + detectionRuleMetric.alert_count_daily,
cases: updatedUsage.custom_total.cases + detectionRuleMetric.cases_count_daily,
cases: updatedUsage.custom_total.cases + detectionRuleMetric.cases_count_total,
},
};
}
Expand Down Expand Up @@ -263,7 +263,7 @@ export const getDetectionRuleMetrics = async (
created_on: hit._source?.alert.createdAt,
updated_on: hit._source?.alert.updatedAt,
alert_count_daily: alertsCache.get(ruleId) || 0,
cases_count_daily: casesCache.get(ruleId) || 0,
cases_count_total: casesCache.get(ruleId) || 0,
} as DetectionRuleMetric;
});

Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/security_solution/server/usage/detections/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ export interface DetectionRuleMetric {
created_on: string;
updated_on: string;
alert_count_daily: number;
cases_count_daily: number;
cases_count_total: number;
}

export interface DetectionRuleAdoption {
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4862,10 +4862,10 @@
"description": "The number of daily alerts generated by a rule"
}
},
"cases_count_daily": {
"cases_count_total": {
"type": "long",
"_meta": {
"description": "The number of daily cases generated by a rule"
"description": "The number of total cases generated by a rule"
}
}
}
Expand Down