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

Sessions tab improvements #131583

Merged
merged 6 commits into from
May 6, 2022
Merged

Sessions tab improvements #131583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
874659d
session tab query modified query all events, not just entry leaders. …
May 4, 2022
f78930e
snapshot updated
May 4, 2022
817a9f7
readded test
May 4, 2022
1bd434b
Default sort set to process.entry_leader.start desc
May 4, 2022
75b0b5d
sessions tab timeline id changed to cache bust localstorage for table…
May 5, 2022
fa3f93a
missed a couple spots for session tab timeline id update
May 5, 2022
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
2 changes: 1 addition & 1 deletion x-pack/plugins/security_solution/common/types/timeline/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ export enum TimelineId {
usersPageExternalAlerts = 'users-page-external-alerts',
hostsPageEvents = 'hosts-page-events',
hostsPageExternalAlerts = 'hosts-page-external-alerts',
hostsPageSessions = 'hosts-page-sessions',
hostsPageSessions = 'hosts-page-sessions-v2', // the v2 is to cache bust localstorage settings as default columns were reworked.
detectionsRulesDetailsPage = 'detections-rules-details-page',
detectionsPage = 'detections-page',
networkPageExternalAlerts = 'network-page-external-alerts',
Expand Down
22 changes: 8 additions & 14 deletions ...urity_solution/public/common/components/sessions_viewer/__snapshots__/index.test.tsx.snap
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 0 additions & 25 deletions x-pack/plugins/security_solution/public/common/components/sessions_viewer/cell_renderer.tsx
View file
Open in desktop

This file was deleted.

47 changes: 28 additions & 19 deletions x-pack/plugins/security_solution/public/common/components/sessions_viewer/default_headers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,50 +10,52 @@ import { defaultColumnHeaderType } from '../../../timelines/components/timeline/
import { DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../../../timelines/components/timeline/body/constants';
import { SubsetTimelineModel } from '../../../timelines/store/timeline/model';
import { timelineDefaults } from '../../../timelines/store/timeline/defaults';

// Using @timestamp as an way of getting the end time of the process. (Currently endpoint doesn't populate process.end)
// @timestamp of an event.action with value of "end" is what we consider that to be the end time of the process
// Current action are: 'start', 'exec', 'end', so we might have up to three events per process.
export const MAPPED_PROCESS_END_COLUMN = '@timestamp';
import {
COLUMN_SESSION_START,
COLUMN_EXECUTABLE,
COLUMN_ENTRY_USER,
COLUMN_INTERACTIVE,
COLUMN_HOST_NAME,
COLUMN_ENTRY_TYPE,
COLUMN_ENTRY_IP,
} from './translations';

export const sessionsHeaders: ColumnHeaderOptions[] = [
{
columnHeaderType: defaultColumnHeaderType,
id: 'process.start',
id: 'process.entry_leader.start',
initialWidth: DEFAULT_DATE_COLUMN_MIN_WIDTH,
display: COLUMN_SESSION_START,
},
{
columnHeaderType: defaultColumnHeaderType,
id: MAPPED_PROCESS_END_COLUMN,
display: 'process.end',
Copy link
Contributor

Choose a reason for hiding this comment

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

glad we got rid of that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I loaded some data using elf and didn't detected any degradation on performance, loaded 300k+ sessions, and sessions with 100k+ events

image

image

image

awesome, thanks for doing that @opauloh !

id: 'process.entry_leader.executable',
display: COLUMN_EXECUTABLE,
},
{
columnHeaderType: defaultColumnHeaderType,
id: 'process.executable',
id: 'process.entry_leader.user.name',
display: COLUMN_ENTRY_USER,
},
{
columnHeaderType: defaultColumnHeaderType,
id: 'user.name',
},
{
columnHeaderType: defaultColumnHeaderType,
id: 'process.interactive',
},
{
columnHeaderType: defaultColumnHeaderType,
id: 'process.pid',
id: 'process.entry_leader.interactive',
display: COLUMN_INTERACTIVE,
},
{
columnHeaderType: defaultColumnHeaderType,
id: 'host.hostname',
display: COLUMN_HOST_NAME,
},
{
columnHeaderType: defaultColumnHeaderType,
id: 'process.entry_leader.entry_meta.type',
display: COLUMN_ENTRY_TYPE,
},
{
columnHeaderType: defaultColumnHeaderType,
id: 'process.entry_leader.entry_meta.source.ip',
columnHeaderType: defaultColumnHeaderType,
display: COLUMN_ENTRY_IP,
},
];

Expand All @@ -62,4 +64,11 @@ export const sessionsDefaultModel: SubsetTimelineModel = {
columns: sessionsHeaders,
defaultColumns: sessionsHeaders,
excludedRowRendererIds: Object.values(RowRendererId),
sort: [
{
columnId: 'process.entry_leader.start',
columnType: 'date',
sortDirection: 'desc',
},
],
};
3 changes: 2 additions & 1 deletion x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,11 @@ describe('SessionsView', () => {
expect(wrapper.getByTestId(`${TEST_PREFIX}:startDate`)).toHaveTextContent(startDate);
expect(wrapper.getByTestId(`${TEST_PREFIX}:endDate`)).toHaveTextContent(endDate);
expect(wrapper.getByTestId(`${TEST_PREFIX}:timelineId`)).toHaveTextContent(
'hosts-page-sessions'
'hosts-page-sessions-v2'
);
});
});

it('passes in the right filters to TGrid', async () => {
render(
<TestProviders>
Expand Down
19 changes: 6 additions & 13 deletions x-pack/plugins/security_solution/public/common/components/sessions_viewer/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { ESBoolQuery } from '../../../../common/typed_json';
import { StatefulEventsViewer } from '../events_viewer';
import { sessionsDefaultModel } from './default_headers';
import { defaultRowRenderers } from '../../../timelines/components/timeline/body/renderers';
import { CellRenderer } from './cell_renderer';
import { DefaultCellRenderer } from '../../../timelines/components/timeline/cell_rendering/default_cell_renderer';
import * as i18n from './translations';
import { SourcererScopeName } from '../../store/sourcerer/model';
import { getDefaultControlColumn } from '../../../timelines/components/timeline/body/control_columns';
Expand All @@ -24,15 +24,8 @@ export const defaultSessionsFilter: Required<Pick<Filter, 'meta' | 'query'>> = {
bool: {
filter: [
{
bool: {
should: [
{
match: {
'process.entry_leader.same_as_process': true,
},
},
],
minimum_should_match: 1,
exists: {
field: 'process.entry_leader.entity_id', // to exclude any records which have no entry_leader.entity_id
},
},
],
Expand All @@ -41,10 +34,10 @@ export const defaultSessionsFilter: Required<Pick<Filter, 'meta' | 'query'>> = {
meta: {
alias: null,
disabled: false,
key: 'process.entry_leader.same_as_process',
key: 'process.entry_leader.entity_id',
negate: false,
params: {},
type: 'boolean',
type: 'string',
},
};

Expand Down Expand Up @@ -95,7 +88,7 @@ const SessionsViewComponent: React.FC<SessionsComponentsProps> = ({
entityType={entityType}
id={timelineId}
leadingControlColumns={leadingControlColumns}
renderCellValue={CellRenderer}
renderCellValue={DefaultCellRenderer}
rowRenderers={defaultRowRenderers}
scopeId={SourcererScopeName.default}
start={startDate}
Expand Down
49 changes: 49 additions & 0 deletions x-pack/plugins/security_solution/public/common/components/sessions_viewer/translations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,52 @@ export const SINGLE_COUNT_OF_SESSIONS = i18n.translate(
defaultMessage: 'session',
}
);

export const COLUMN_SESSION_START = i18n.translate(
'xpack.securitySolution.sessionsView.columnSessionStart',
{
defaultMessage: 'Started',
}
);

export const COLUMN_EXECUTABLE = i18n.translate(
'xpack.securitySolution.sessionsView.columnExecutable',
{
defaultMessage: 'Executable',
}
);

export const COLUMN_ENTRY_USER = i18n.translate(
'xpack.securitySolution.sessionsView.columnEntryUser',
{
defaultMessage: 'User',
}
);

export const COLUMN_INTERACTIVE = i18n.translate(
'xpack.securitySolution.sessionsView.columnInteractive',
{
defaultMessage: 'Interactive',
}
);

export const COLUMN_HOST_NAME = i18n.translate(
'xpack.securitySolution.sessionsView.columnHostName',
{
defaultMessage: 'Hostname',
}
);

export const COLUMN_ENTRY_TYPE = i18n.translate(
'xpack.securitySolution.sessionsView.columnEntryType',
{
defaultMessage: 'Type',
}
);

export const COLUMN_ENTRY_IP = i18n.translate(
'xpack.securitySolution.sessionsView.columnEntrySourceIp',
{
defaultMessage: 'Source IP',
}
);
2 changes: 1 addition & 1 deletion x-pack/plugins/timelines/common/types/timeline/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ export enum TimelineId {
usersPageExternalAlerts = 'users-page-external-alerts',
hostsPageEvents = 'hosts-page-events',
hostsPageExternalAlerts = 'hosts-page-external-alerts',
hostsPageSessions = 'hosts-page-sessions',
hostsPageSessions = 'hosts-page-sessions-v2',
detectionsRulesDetailsPage = 'detections-rules-details-page',
detectionsPage = 'detections-page',
networkPageExternalAlerts = 'network-page-external-alerts',
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/timelines/public/store/t_grid/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export enum TimelineId {
usersPageExternalAlerts = 'users-page-external-alerts',
hostsPageEvents = 'hosts-page-events',
hostsPageExternalAlerts = 'hosts-page-external-alerts',
hostsPageSessions = 'hosts-page-sessions',
hostsPageSessions = 'hosts-page-sessions-v2',
detectionsRulesDetailsPage = 'detections-rules-details-page',
detectionsPage = 'detections-page',
networkPageExternalAlerts = 'network-page-external-alerts',
Expand Down
10 changes: 3 additions & 7 deletions x-pack/plugins/timelines/server/search_strategy/timeline/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,17 +209,13 @@ const timelineSessionsSearchStrategy = <T extends TimelineFactoryQueryTypes>({
};

const collapse = {
field: 'process.entity_id',
inner_hits: {
name: 'last_event',
size: 1,
sort: [{ '@timestamp': 'desc' }],
},
field: 'process.entry_leader.entity_id',
};

const aggs = {
total: {
cardinality: {
field: 'process.entity_id',
field: 'process.entry_leader.entity_id',
},
},
};
Expand Down