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

[7.x] Adds date time query and return fields for timestamps and overrides (#79911) #79964

Merged
merged 1 commit into from
Oct 8, 2020
Merged

[7.x] Adds date time query and return fields for timestamps and overrides (#79911) #79964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions x-pack/plugins/security_solution/common/detection_engine/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export interface BaseHit<T> {
_index: string;
_id: string;
_source: T;
fields?: Record<string, SearchTypes[]>;
}

export interface EqlSequence<T> {
Expand Down
43 changes: 43 additions & 0 deletions .../plugins/security_solution/server/lib/detection_engine/signals/build_events_query.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ describe('create_signals', () => {
size: 100,
ignoreUnavailable: true,
body: {
docvalue_fields: [
{
field: '@timestamp',
format: 'strict_date_optional_time',
},
],
query: {
bool: {
filter: [
Expand All @@ -37,6 +43,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
gte: 'now-5m',
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -51,6 +58,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
lte: 'today',
format: 'strict_date_optional_time',
},
},
},
Expand Down Expand Up @@ -94,6 +102,12 @@ describe('create_signals', () => {
size: 100,
ignoreUnavailable: true,
body: {
docvalue_fields: [
{
field: '@timestamp',
format: 'strict_date_optional_time',
},
],
query: {
bool: {
filter: [
Expand All @@ -108,6 +122,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
gte: 'now-5m',
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -122,6 +137,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
lte: 'today',
format: 'strict_date_optional_time',
},
},
},
Expand Down Expand Up @@ -166,6 +182,12 @@ describe('create_signals', () => {
size: 100,
ignoreUnavailable: true,
body: {
docvalue_fields: [
{
field: '@timestamp',
format: 'strict_date_optional_time',
},
],
query: {
bool: {
filter: [
Expand All @@ -180,6 +202,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
gte: 'now-5m',
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -194,6 +217,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
lte: 'today',
format: 'strict_date_optional_time',
},
},
},
Expand Down Expand Up @@ -239,6 +263,12 @@ describe('create_signals', () => {
size: 100,
ignoreUnavailable: true,
body: {
docvalue_fields: [
{
field: '@timestamp',
format: 'strict_date_optional_time',
},
],
query: {
bool: {
filter: [
Expand All @@ -253,6 +283,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
gte: 'now-5m',
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -267,6 +298,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
lte: 'today',
format: 'strict_date_optional_time',
},
},
},
Expand Down Expand Up @@ -311,6 +343,12 @@ describe('create_signals', () => {
size: 100,
ignoreUnavailable: true,
body: {
docvalue_fields: [
{
field: '@timestamp',
format: 'strict_date_optional_time',
},
],
query: {
bool: {
filter: [
Expand All @@ -325,6 +363,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
gte: 'now-5m',
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -339,6 +378,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
lte: 'today',
format: 'strict_date_optional_time',
},
},
},
Expand Down Expand Up @@ -390,6 +430,7 @@ describe('create_signals', () => {
size: 100,
ignoreUnavailable: true,
body: {
docvalue_fields: [{ field: '@timestamp', format: 'strict_date_optional_time' }],
query: {
bool: {
filter: [
Expand All @@ -404,6 +445,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
gte: 'now-5m',
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -418,6 +460,7 @@ describe('create_signals', () => {
range: {
'@timestamp': {
lte: 'today',
format: 'strict_date_optional_time',
},
},
},
Expand Down
23 changes: 23 additions & 0 deletions x-pack/plugins/security_solution/server/lib/detection_engine/signals/build_events_query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,25 @@ export const buildEventsSearchQuery = ({
timestampOverride,
}: BuildEventsSearchQuery) => {
const timestamp = timestampOverride ?? '@timestamp';
const docFields =
timestampOverride != null
? [
{
field: '@timestamp',
format: 'strict_date_optional_time',
},
{
field: timestampOverride,
format: 'strict_date_optional_time',
},
]
: [
{
field: '@timestamp',
format: 'strict_date_optional_time',
},
];

const filterWithTime = [
filter,
{
Expand All @@ -40,6 +59,7 @@ export const buildEventsSearchQuery = ({
range: {
[timestamp]: {
gte: from,
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -54,6 +74,7 @@ export const buildEventsSearchQuery = ({
range: {
[timestamp]: {
lte: to,
format: 'strict_date_optional_time',
},
},
},
Expand All @@ -65,12 +86,14 @@ export const buildEventsSearchQuery = ({
},
},
];

const searchQuery = {
allowNoIndices: true,
index,
size,
ignoreUnavailable: true,
body: {
docvalue_fields: docFields,
query: {
bool: {
filter: [
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/security_solution/server/lib/detection_engine/signals/build_rule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export const buildRule = ({
created_by: createdBy,
updated_by: updatedBy,
threat: ruleParams.threat ?? [],
timestamp_override: ruleParams.timestampOverride, // TODO: Timestamp Override via timestamp_override
timestamp_override: ruleParams.timestampOverride,
throttle,
version: ruleParams.version,
created_at: createdAt,
Expand Down Expand Up @@ -155,7 +155,7 @@ export const buildRuleWithoutOverrides = (
created_by: ruleSO.attributes.createdBy,
updated_by: ruleSO.attributes.updatedBy,
threat: ruleParams.threat ?? [],
timestamp_override: ruleParams.timestampOverride, // TODO: Timestamp Override via timestamp_override
timestamp_override: ruleParams.timestampOverride,
throttle: ruleSO.attributes.throttle,
version: ruleParams.version,
created_at: ruleSO.attributes.createdAt,
Expand Down
9 changes: 7 additions & 2 deletions ...k/plugins/security_solution/server/lib/detection_engine/signals/find_threshold_signals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@

import { isEmpty } from 'lodash/fp';

import { Threshold } from '../../../../common/detection_engine/schemas/common/schemas';
import {
Threshold,
TimestampOverrideOrUndefined,
} from '../../../../common/detection_engine/schemas/common/schemas';
import { singleSearchAfter } from './single_search_after';

import { AlertServices } from '../../../../../alerts/server';
Expand All @@ -23,6 +26,7 @@ interface FindThresholdSignalsParams {
filter: unknown;
threshold: Threshold;
buildRuleMessage: BuildRuleMessage;
timestampOverride: TimestampOverrideOrUndefined;
}

export const findThresholdSignals = async ({
Expand All @@ -34,6 +38,7 @@ export const findThresholdSignals = async ({
filter,
threshold,
buildRuleMessage,
timestampOverride,
}: FindThresholdSignalsParams): Promise<{
searchResult: SignalSearchResponse;
searchDuration: string;
Expand All @@ -54,7 +59,7 @@ export const findThresholdSignals = async ({
return singleSearchAfter({
aggregations,
searchAfterSortId: undefined,
timestampOverride: undefined,
timestampOverride,
index: inputIndexPattern,
from,
to,
Expand Down
5 changes: 4 additions & 1 deletion ...plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,10 @@ export const searchAfterAndBulkCreate = async ({
});
toReturn = mergeReturns([
toReturn,
createSearchAfterReturnTypeFromResponse({ searchResult }),
createSearchAfterReturnTypeFromResponse({
searchResult,
timestampOverride: ruleParams.timestampOverride,
}),
createSearchAfterReturnType({
searchAfterTimes: [searchDuration],
errors: searchErrors,
Expand Down
16 changes: 11 additions & 5 deletions ...k/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ export const signalRulesAlertType = ({
from,
ruleId,
index,
eventCategoryOverride,
filters,
language,
maxSignals,
Expand All @@ -114,6 +115,7 @@ export const signalRulesAlertType = ({
threatIndex,
threatMapping,
threatLanguage,
timestampOverride,
type,
exceptionsList,
} = params;
Expand Down Expand Up @@ -313,6 +315,7 @@ export const signalRulesAlertType = ({
logger,
filter: esFilter,
threshold,
timestampOverride,
buildRuleMessage,
});

Expand Down Expand Up @@ -346,7 +349,10 @@ export const signalRulesAlertType = ({
});
result = mergeReturns([
result,
createSearchAfterReturnTypeFromResponse({ searchResult: thresholdResults }),
createSearchAfterReturnTypeFromResponse({
searchResult: thresholdResults,
timestampOverride,
}),
createSearchAfterReturnType({
success,
errors: [...errors, ...searchErrors],
Expand Down Expand Up @@ -464,12 +470,12 @@ export const signalRulesAlertType = ({
const request = buildEqlSearchRequest(
query,
inputIndex,
params.from,
params.to,
from,
to,
searchAfterSize,
params.timestampOverride,
timestampOverride,
exceptionItems ?? [],
params.eventCategoryOverride
eventCategoryOverride
);
const response: EqlSignalSearchResponse = await services.callCluster(
'transport.request',
Expand Down
Loading