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

[Ingest Manager] Improve perfomance of fetching unacknowledged actions #75892

Closed
wants to merge 2 commits into from
Closed

[Ingest Manager] Improve perfomance of fetching unacknowledged actions #75892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3aeca58
[Ingest Manager] Refacto action acknowledgement to avoid KQL
nchaulet Aug 25, 2020
171f883
Fix tests
nchaulet Aug 25, 2020
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
6 changes: 4 additions & 2 deletions x-pack/plugins/ingest_manager/common/types/models/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,22 @@ export type AgentActionType = 'CONFIG_CHANGE' | 'DATA_DUMP' | 'RESUME' | 'PAUSE'
export interface NewAgentAction {
type: AgentActionType;
data?: any;
sent_at?: string;
}

export interface AgentAction extends NewAgentAction {
id: string;
agent_id: string;
created_at: string;
acknowledged_at?: string;
}

export interface AgentActionSOAttributes {
type: AgentActionType;
sent_at?: string;
timestamp?: string;
created_at: string;
agent_id: string;
data?: string;
acknowledged_at?: string;
}

export interface NewAgentEvent {
Expand Down Expand Up @@ -103,9 +103,11 @@ export interface Agent extends AgentBase {
access_api_key?: string;
status?: string;
packages: string[];
not_acknowledged_actions: string[];
}

export interface AgentSOAttributes extends AgentBase {
current_error_events?: string;
packages?: string[];
not_acknowledged_actions?: string[];
}
4 changes: 0 additions & 4 deletions x-pack/plugins/ingest_manager/server/routes/agent/actions_handlers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ describe('test actions handlers schema', () => {
NewAgentActionSchema.validate({
type: 'CONFIG_CHANGE',
data: 'data',
sent_at: '2020-03-14T19:45:02.620Z',
})
).toBeTruthy();
});
Expand All @@ -34,7 +33,6 @@ describe('test actions handlers schema', () => {
expect(() => {
NewAgentActionSchema.validate({
data: 'data',
sent_at: '2020-03-14T19:45:02.620Z',
});
}).toThrowError();
});
Expand All @@ -55,7 +53,6 @@ describe('test actions handlers', () => {
action: {
type: 'CONFIG_CHANGE',
data: 'data',
sent_at: '2020-03-14T19:45:02.620Z',
},
},
params: {
Expand All @@ -68,7 +65,6 @@ describe('test actions handlers', () => {
const agentAction = ({
type: 'CONFIG_CHANGE',
id: 'action1',
sent_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
} as unknown) as AgentAction;
Expand Down
6 changes: 4 additions & 2 deletions x-pack/plugins/ingest_manager/server/saved_objects/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ const savedObjectTypes: { [key: string]: SavedObjectsType } = {
updated_at: { type: 'date' },
current_error_events: { type: 'text', index: false },
packages: { type: 'keyword' },
not_acknowledged_actions: { type: 'keyword', index: false },
},
},
migrations: {
Expand All @@ -96,8 +97,8 @@ const savedObjectTypes: { [key: string]: SavedObjectsType } = {
agent_id: { type: 'keyword' },
type: { type: 'keyword' },
data: { type: 'binary' },
sent_at: { type: 'date' },
created_at: { type: 'date' },
acknowledged_at: { type: 'date' },
},
},
},
Expand Down Expand Up @@ -351,11 +352,12 @@ export function registerEncryptedSavedObjects(
'unenrolled_at',
'unenrollment_started_at',
'packages',
'not_acknowledged_actions',
]),
});
encryptedSavedObjects.registerType({
type: AGENT_ACTION_SAVED_OBJECT_TYPE,
attributesToEncrypt: new Set(['data']),
attributesToExcludeFromAAD: new Set(['agent_id', 'type', 'sent_at', 'created_at']),
attributesToExcludeFromAAD: new Set(['agent_id', 'acknowledged_at', 'type', 'created_at']),
});
}
26 changes: 17 additions & 9 deletions x-pack/plugins/ingest_manager/server/services/agents/acks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ describe('test agent acks services', () => {
attributes: {
type: 'CONFIG_CHANGE',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
},
Expand All @@ -56,7 +56,7 @@ describe('test agent acks services', () => {
attributes: {
type: 'CONFIG_CHANGE',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
},
Expand All @@ -70,6 +70,7 @@ describe('test agent acks services', () => {
({
id: 'id',
type: AGENT_TYPE_PERMANENT,
not_acknowledged_actions: [],
} as unknown) as Agent,
[
{
Expand All @@ -86,7 +87,7 @@ describe('test agent acks services', () => {
type: 'CONFIG_CHANGE',
id: 'action1',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
} as unknown) as AgentAction,
Expand All @@ -112,7 +113,7 @@ describe('test agent acks services', () => {
attributes: {
type: 'CONFIG_CHANGE',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
data: JSON.stringify({
Expand Down Expand Up @@ -193,7 +194,7 @@ describe('test agent acks services', () => {
attributes: {
type: 'CONFIG_CHANGE',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
},
Expand All @@ -208,6 +209,7 @@ describe('test agent acks services', () => {
id: 'id',
type: AGENT_TYPE_PERMANENT,
policy_id: 'policy1',
not_acknowledged_actions: ['actionNotAcknowledged:id', 'action1'],
} as unknown) as Agent,
[
{
Expand All @@ -224,6 +226,9 @@ describe('test agent acks services', () => {
expect(mockSavedObjectsClient.bulkUpdate.mock.calls[0][0][0]).toMatchInlineSnapshot(`
Object {
"attributes": Object {
"not_acknowledged_actions": Array [
"actionNotAcknowledged:id",
],
"packages": Array [
"system",
],
Expand Down Expand Up @@ -254,7 +259,7 @@ describe('test agent acks services', () => {
attributes: {
type: 'CONFIG_CHANGE',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
data: JSON.stringify({
Expand Down Expand Up @@ -335,7 +340,7 @@ describe('test agent acks services', () => {
attributes: {
type: 'CONFIG_CHANGE',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
},
Expand All @@ -351,6 +356,7 @@ describe('test agent acks services', () => {
type: AGENT_TYPE_PERMANENT,
policy_id: 'policy1',
policy_revision: 100,
not_acknowledged_actions: [],
} as unknown) as Agent,
[
{
Expand All @@ -363,7 +369,7 @@ describe('test agent acks services', () => {
]
);
expect(mockSavedObjectsClient.bulkUpdate).toBeCalled();
expect(mockSavedObjectsClient.bulkUpdate.mock.calls[0][0]).toHaveLength(1);
expect(mockSavedObjectsClient.bulkUpdate.mock.calls[0][0]).toHaveLength(2);
});

it('should fail for actions that cannot be found on agent actions list', async () => {
Expand All @@ -388,6 +394,7 @@ describe('test agent acks services', () => {
({
id: 'id',
type: AGENT_TYPE_PERMANENT,
not_acknowledged_actions: [],
} as unknown) as Agent,
[
({
Expand Down Expand Up @@ -418,7 +425,7 @@ describe('test agent acks services', () => {
attributes: {
type: 'CONFIG_CHANGE',
agent_id: 'id',
sent_at: '2020-03-14T19:45:02.620Z',
acknowledged_at: '2020-03-14T19:45:02.620Z',
timestamp: '2019-01-04T14:32:03.36764-05:00',
created_at: '2020-03-14T19:45:02.620Z',
},
Expand All @@ -433,6 +440,7 @@ describe('test agent acks services', () => {
({
id: 'id',
type: AGENT_TYPE_PERMANENT,
not_acknowledged_actions: [],
} as unknown) as Agent,
[
({
Expand Down
27 changes: 16 additions & 11 deletions x-pack/plugins/ingest_manager/server/services/agents/acks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,17 @@ export async function acknowledgeAgentActions(
const agentPolicy = getLatestAgentPolicyIfUpdated(agent, actions);

await soClient.bulkUpdate<AgentSOAttributes | AgentActionSOAttributes>([
...(agentPolicy ? [buildUpdateAgentPolicy(agent.id, agentPolicy)] : []),
...buildUpdateAgentActionSentAt(actionIds),
{
type: AGENT_SAVED_OBJECT_TYPE,
id: agent.id,
attributes: {
...(agentPolicy ? buildUpdateAgentPolicy(agent.id, agentPolicy) : {}),
not_acknowledged_actions: agent.not_acknowledged_actions.filter(
(actionId) => !actionIds.includes(actionId)
),
},
},
...buildUpdateAgentActionAcknowledgedAt(actionIds),
]);

return actions;
Expand Down Expand Up @@ -107,24 +116,20 @@ function buildUpdateAgentPolicy(agentId: string, agentPolicy: FullAgentPolicy) {
}, []);

return {
type: AGENT_SAVED_OBJECT_TYPE,
id: agentId,
attributes: {
policy_revision: agentPolicy.revision,
packages,
},
policy_revision: agentPolicy.revision,
packages,
};
}

function buildUpdateAgentActionSentAt(
function buildUpdateAgentActionAcknowledgedAt(
actionsIds: string[],
sentAt: string = new Date().toISOString()
acknowledgedAt: string = new Date().toISOString()
) {
return actionsIds.map((actionId) => ({
type: AGENT_ACTION_SAVED_OBJECT_TYPE,
id: actionId,
attributes: {
sent_at: sentAt,
acknowledged_at: acknowledgedAt,
},
}));
}
Expand Down
2 changes: 0 additions & 2 deletions x-pack/plugins/ingest_manager/server/services/agents/actions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ describe('test agent actions services', () => {
agent_id: 'agentid',
type: 'CONFIG_CHANGE',
data: { content: 'data' },
sent_at: '2020-03-14T19:45:02.620Z',
created_at: '2020-03-14T19:45:02.620Z',
};
mockSavedObjectsClient.create.mockReturnValue(
Expand All @@ -32,6 +31,5 @@ describe('test agent actions services', () => {
expect(createdAction).toBeDefined();
expect(createdAction?.type).toEqual(newAgentAction.type);
expect(createdAction?.data).toEqual(JSON.stringify(newAgentAction.data));
expect(createdAction?.sent_at).toEqual(newAgentAction.sent_at);
});
});
15 changes: 7 additions & 8 deletions x-pack/plugins/ingest_manager/server/services/agents/actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,21 @@ export async function createAgentAction(

export async function getAgentActionsForCheckin(
soClient: SavedObjectsClientContract,
agentId: string
agent: Agent
): Promise<AgentAction[]> {
const res = await soClient.find<AgentActionSOAttributes>({
type: AGENT_ACTION_SAVED_OBJECT_TYPE,
filter: `not ${AGENT_ACTION_SAVED_OBJECT_TYPE}.attributes.sent_at: * and ${AGENT_ACTION_SAVED_OBJECT_TYPE}.attributes.agent_id:${agentId}`,
});
if (agent.not_acknowledged_actions.length === 0) {
return [];
}

return Promise.all(
res.saved_objects.map(async (so) => {
agent.not_acknowledged_actions.map(async (actionId) => {
// Get decrypted actions
return savedObjectToAgentAction(
await appContextService
.getEncryptedSavedObjects()
.getDecryptedAsInternalUser<AgentActionSOAttributes>(
AGENT_ACTION_SAVED_OBJECT_TYPE,
so.id
actionId
)
);
})
Expand Down Expand Up @@ -80,7 +79,7 @@ export async function getAgentActionByIds(
export async function getNewActionsSince(soClient: SavedObjectsClientContract, timestamp: string) {
const res = await soClient.find<AgentActionSOAttributes>({
type: AGENT_ACTION_SAVED_OBJECT_TYPE,
filter: `not ${AGENT_ACTION_SAVED_OBJECT_TYPE}.attributes.sent_at: * AND ${AGENT_ACTION_SAVED_OBJECT_TYPE}.attributes.created_at >= "${timestamp}"`,
filter: `not ${AGENT_ACTION_SAVED_OBJECT_TYPE}.attributes.acknowledged_at: * AND ${AGENT_ACTION_SAVED_OBJECT_TYPE}.attributes.created_at >= "${timestamp}"`,
});

return res.saved_objects.map(savedObjectToAgentAction);
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/ingest_manager/server/services/agents/checkin/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export async function agentCheckin(
}

// Check if some actions are not acknowledged
let actions = await getAgentActionsForCheckin(soClient, agent.id);
let actions = await getAgentActionsForCheckin(soClient, agent);
if (actions.length > 0) {
return { actions };
}
Expand Down
5 changes: 4 additions & 1 deletion x-pack/plugins/ingest_manager/server/services/agents/checkin/state_new_actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,10 @@ async function createAgentActionFromAgentPolicy(
type: 'CONFIG_CHANGE',
data: { config: newAgentPolicy } as any,
created_at: new Date().toISOString(),
sent_at: undefined,
});

await soClient.update<AgentSOAttributes>(AGENT_SAVED_OBJECT_TYPE, agent.id, {
not_acknowledged_actions: [...agent.not_acknowledged_actions, policyChangeAction.id],
});

return [policyChangeAction];
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/ingest_manager/server/services/agents/saved_objects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export function savedObjectToAgent(so: SavedObject<AgentSOAttributes>): Agent {
access_api_key: undefined,
status: undefined,
packages: so.attributes.packages ?? [],
not_acknowledged_actions: so.attributes.not_acknowledged_actions ?? [],
};
}

Expand Down
1 change: 0 additions & 1 deletion x-pack/plugins/ingest_manager/server/types/models/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,4 @@ export const NewAgentActionSchema = schema.object({
schema.literal('PAUSE'),
]),
data: schema.maybe(schema.any()),
sent_at: schema.maybe(schema.string()),
});