[ResponseOps][OnWeek] Connector logs view

x-pack/plugins/actions/common/execution_log_types.ts

@@ -0,0 +1,61 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { estypes } from '@elastic/elasticsearch';
+
+export interface IExecutionLog {
+  id: string;
+  timestamp: string;
+  duration_ms: number;
+  status: string;
+  message: string;
+  version: string;
+  schedule_delay_ms: number;
+  space_ids: string[];
+  connector_name: string;
+  connector_id: string;
+  timed_out: boolean;
+}
+
+export interface IExecutionLogResult {
+  total: number;
+  data: IExecutionLog[];
+}
+
+export interface GetGlobalExecutionLogParams {
+  dateStart: string;
+  dateEnd?: string;
+  filter?: string;
+  page: number;
+  perPage: number;
+  sort: estypes.Sort;
+  namespaces?: Array<string | undefined>;
+}
+
+export interface GetGlobalExecutionKPIParams {
+  dateStart: string;
+  dateEnd?: string;
+  filter?: string;
+  namespaces?: Array<string | undefined>;
+}
+
+export const EMPTY_EXECUTION_KPI_RESULT = {
+  success: 0,
+  unknown: 0,
+  failure: 0,
+  warning: 0,
+};
+
+export type IExecutionKPIResult = typeof EMPTY_EXECUTION_KPI_RESULT;
+
+export const executionLogSortableColumns = [
+  'timestamp',
+  'execution_duration',
+  'schedule_delay',
+] as const;
+
+export type ExecutionLogSortFields = typeof executionLogSortableColumns[number];

x-pack/plugins/actions/common/index.ts

@@ -14,6 +14,7 @@ export * from './rewrite_request_case';
 export * from './mustache_template';
 export * from './validate_email_addresses';
 export * from './connector_feature_config';
+export * from './execution_log_types';
 
 export const BASE_ACTION_API_PATH = '/api/actions';
 export const INTERNAL_BASE_ACTION_API_PATH = '/internal/actions';

x-pack/plugins/actions/server/actions_client.mock.ts

@@ -27,6 +27,8 @@ const createActionsClientMock = () => {
     listTypes: jest.fn(),
     isActionTypeEnabled: jest.fn(),
     isPreconfigured: jest.fn(),
+    getGlobalExecutionKpiWithAuth: jest.fn(),
+    getGlobalExecutionLogWithAuth: jest.fn(),
   };
   return mocked;
 };

x-pack/plugins/actions/server/actions_client.test.ts

@@ -44,6 +44,8 @@ import { inMemoryMetricsMock } from './monitoring/in_memory_metrics.mock';
 import { getOAuthJwtAccessToken } from './lib/get_oauth_jwt_access_token';
 import { getOAuthClientCredentialsAccessToken } from './lib/get_oauth_client_credentials_access_token';
 import { OAuthParams } from './routes/get_oauth_access_token';
+import { eventLogClientMock } from '@kbn/event-log-plugin/server/event_log_client.mock';
+import { GetGlobalExecutionKPIParams, GetGlobalExecutionLogParams } from '../common';
 
 jest.mock('@kbn/core-saved-objects-utils-server', () => {
   const actual = jest.requireActual('@kbn/core-saved-objects-utils-server');
@@ -81,6 +83,10 @@ jest.mock('./lib/get_oauth_client_credentials_access_token', () => ({
   getOAuthClientCredentialsAccessToken: jest.fn(),
 }));
 
+jest.mock('uuid', () => ({
+  v4: () => 'uuidv4',
+}));
+
 const defaultKibanaIndex = '.kibana';
 const unsecuredSavedObjectsClient = savedObjectsClientMock.create();
 const scopedClusterClient = elasticsearchServiceMock.createScopedClusterClient();
@@ -96,6 +102,8 @@ const mockUsageCounter = mockUsageCountersSetup.createUsageCounter('test');
 const logger = loggingSystemMock.create().get() as jest.Mocked<Logger>;
 const mockTaskManager = taskManagerMock.createSetup();
 const configurationUtilities = actionsConfigMock.create();
+const eventLogClient = eventLogClientMock.create();
+const getEventLogClient = jest.fn();
 
 let actionsClient: ActionsClient;
 let mockedLicenseState: jest.Mocked<ILicenseState>;
@@ -139,11 +147,13 @@ beforeEach(() => {
     auditLogger,
     usageCounter: mockUsageCounter,
     connectorTokenClient,
+    getEventLogClient,
   });
   (getOAuthJwtAccessToken as jest.Mock).mockResolvedValue(`Bearer jwttokentokentoken`);
   (getOAuthClientCredentialsAccessToken as jest.Mock).mockResolvedValue(
     `Bearer clienttokentokentoken`
   );
+  getEventLogClient.mockResolvedValue(eventLogClient);
 });
 
 describe('create()', () => {
@@ -566,6 +576,7 @@ describe('create()', () => {
       request,
       authorization: authorization as unknown as ActionsAuthorization,
       connectorTokenClient: connectorTokenClientMock.create(),
+      getEventLogClient,
     });
 
     const savedObjectCreateResult = {
@@ -687,6 +698,7 @@ describe('get()', () => {
           },
         ],
         connectorTokenClient: connectorTokenClientMock.create(),
+        getEventLogClient,
       });
 
       await actionsClient.get({ id: 'testPreconfigured' });
@@ -747,6 +759,7 @@ describe('get()', () => {
           },
         ],
         connectorTokenClient: connectorTokenClientMock.create(),
+        getEventLogClient,
       });
 
       authorization.ensureAuthorized.mockRejectedValue(
@@ -869,6 +882,7 @@ describe('get()', () => {
         },
       ],
       connectorTokenClient: connectorTokenClientMock.create(),
+      getEventLogClient,
     });
 
     const result = await actionsClient.get({ id: 'testPreconfigured' });
@@ -942,6 +956,7 @@ describe('getAll()', () => {
           },
         ],
         connectorTokenClient: connectorTokenClientMock.create(),
+        getEventLogClient,
       });
       return actionsClient.getAll();
     }
@@ -1084,6 +1099,7 @@ describe('getAll()', () => {
         },
       ],
       connectorTokenClient: connectorTokenClientMock.create(),
+      getEventLogClient,
     });
     const result = await actionsClient.getAll();
     expect(result).toEqual([
@@ -1166,6 +1182,7 @@ describe('getBulk()', () => {
           },
         ],
         connectorTokenClient: connectorTokenClientMock.create(),
+        getEventLogClient,
       });
       return actionsClient.getBulk(['1', 'testPreconfigured']);
     }
@@ -1302,6 +1319,7 @@ describe('getBulk()', () => {
         },
       ],
       connectorTokenClient: connectorTokenClientMock.create(),
+      getEventLogClient,
     });
     const result = await actionsClient.getBulk(['1', 'testPreconfigured']);
     expect(result).toEqual([
@@ -1361,6 +1379,7 @@ describe('getOAuthAccessToken()', () => {
         },
       ],
       connectorTokenClient: connectorTokenClientMock.create(),
+      getEventLogClient,
     });
     return actionsClient.getOAuthAccessToken(requestBody, configurationUtilities);
   }
@@ -2194,6 +2213,7 @@ describe('execute()', () => {
 
   test('calls the actionExecutor with the appropriate parameters', async () => {
     const actionId = uuidv4();
+    const actionExecutionId = uuidv4();
     actionExecutor.execute.mockResolvedValue({ status: 'ok', actionId });
     await expect(
       actionsClient.execute({
@@ -2210,6 +2230,7 @@ describe('execute()', () => {
       params: {
         name: 'my name',
       },
+      actionExecutionId,
     });
 
     await expect(
@@ -2241,6 +2262,7 @@ describe('execute()', () => {
           type: 'some-type',
         },
       ],
+      actionExecutionId,
     });
 
     await expect(
@@ -2274,6 +2296,7 @@ describe('execute()', () => {
           namespace: 'some-namespace',
         },
       ],
+      actionExecutionId,
     });
   });
 });
@@ -2525,6 +2548,7 @@ describe('isPreconfigured()', () => {
         encryptedSavedObjectsClient: encryptedSavedObjectsMock.createClient(),
         logger,
       }),
+      getEventLogClient,
     });
 
     expect(actionsClient.isPreconfigured('testPreconfigured')).toEqual(true);
@@ -2563,8 +2587,125 @@ describe('isPreconfigured()', () => {
         encryptedSavedObjectsClient: encryptedSavedObjectsMock.createClient(),
         logger,
       }),
+      getEventLogClient,
     });
 
     expect(actionsClient.isPreconfigured(uuidv4())).toEqual(false);
   });
 });
+
+describe('getGlobalExecutionLogWithAuth()', () => {
+  const opts: GetGlobalExecutionLogParams = {
+    dateStart: '2023-01-09T08:55:56-08:00',
+    dateEnd: '2023-01-10T08:55:56-08:00',
+    page: 1,
+    perPage: 50,
+    sort: [{ timestamp: { order: 'desc' } }],
+  };
+  const results = {
+    aggregations: {
+      executionLogAgg: {
+        doc_count: 5,
+        executionUuid: {
+          doc_count_error_upper_bound: 0,
+          sum_other_doc_count: 0,
+          buckets: [],
+        },
+        executionUuidCardinality: { doc_count: 5, executionUuidCardinality: { value: 5 } },
+      },
+    },
+  };
+  describe('authorization', () => {
+    test('ensures user is authorised to access logs', async () => {
+      eventLogClient.aggregateEventsWithAuthFilter.mockResolvedValue(results);
+
+      (getAuthorizationModeBySource as jest.Mock).mockImplementationOnce(() => {
+        return AuthorizationMode.RBAC;
+      });
+      await actionsClient.getGlobalExecutionLogWithAuth(opts);
+      expect(authorization.ensureAuthorized).toHaveBeenCalledWith('get');
+    });
+
+    test('throws when user is not authorised to access logs', async () => {
+      (getAuthorizationModeBySource as jest.Mock).mockImplementationOnce(() => {
+        return AuthorizationMode.RBAC;
+      });
+      authorization.ensureAuthorized.mockRejectedValue(new Error(`Unauthorized to access logs`));
+
+      await expect(actionsClient.getGlobalExecutionLogWithAuth(opts)).rejects.toMatchInlineSnapshot(
+        `[Error: Unauthorized to access logs]`
+      );
+
+      expect(authorization.ensureAuthorized).toHaveBeenCalledWith('get');
+    });
+  });
+
+  test('calls the eventLogClient with the appropriate parameters', async () => {
+    eventLogClient.aggregateEventsWithAuthFilter.mockResolvedValue(results);
+
+    await expect(actionsClient.getGlobalExecutionLogWithAuth(opts)).resolves.toMatchInlineSnapshot(`
+      Object {
+        "data": Array [],
+        "total": 5,
+      }
+    `);
+    expect(eventLogClient.aggregateEventsWithAuthFilter).toHaveBeenCalled();
+  });
+});
+
+describe('getGlobalExecutionKpiWithAuth()', () => {
+  const opts: GetGlobalExecutionKPIParams = {
+    dateStart: '2023-01-09T08:55:56-08:00',
+    dateEnd: '2023-01-10T08:55:56-08:00',
+  };
+  const results = {
+    aggregations: {
+      executionKpiAgg: {
+        doc_count: 5,
+        executionUuid: {
+          doc_count_error_upper_bound: 0,
+          sum_other_doc_count: 0,
+          buckets: [],
+        },
+      },
+    },
+  };
+  describe('authorization', () => {
+    test('ensures user is authorised to access kpi', async () => {
+      eventLogClient.aggregateEventsWithAuthFilter.mockResolvedValue(results);
+
+      (getAuthorizationModeBySource as jest.Mock).mockImplementationOnce(() => {
+        return AuthorizationMode.RBAC;
+      });
+      await actionsClient.getGlobalExecutionKpiWithAuth(opts);
+      expect(authorization.ensureAuthorized).toHaveBeenCalledWith('get');
+    });
+
+    test('throws when user is not authorised to access kpi', async () => {
+      (getAuthorizationModeBySource as jest.Mock).mockImplementationOnce(() => {
+        return AuthorizationMode.RBAC;
+      });
+      authorization.ensureAuthorized.mockRejectedValue(new Error(`Unauthorized to access kpi`));
+
+      await expect(actionsClient.getGlobalExecutionKpiWithAuth(opts)).rejects.toMatchInlineSnapshot(
+        `[Error: Unauthorized to access kpi]`
+      );
+
+      expect(authorization.ensureAuthorized).toHaveBeenCalledWith('get');
+    });
+  });
+
+  test('calls the eventLogClient with the appropriate parameters', async () => {
+    eventLogClient.aggregateEventsWithAuthFilter.mockResolvedValue(results);
+
+    await expect(actionsClient.getGlobalExecutionKpiWithAuth(opts)).resolves.toMatchInlineSnapshot(`
+      Object {
+        "failure": 0,
+        "success": 0,
+        "unknown": 0,
+        "warning": 0,
+      }
+    `);
+    expect(eventLogClient.aggregateEventsWithAuthFilter).toHaveBeenCalled();
+  });
+});