[8.x] feat(investigation): add usage collector (#197659)

x-pack/plugins/observability_solution/investigate_app/kibana.jsonc

@@ -23,7 +23,8 @@
       "security",
       "observability",
       "licensing",
-      "ruleRegistry"
+      "ruleRegistry",
+      "usageCollection"
     ],
     "requiredBundles": [
       "esql",

x-pack/plugins/observability_solution/investigate_app/server/lib/collectors/fetcher.test.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { ElasticsearchClientMock, savedObjectsRepositoryMock } from '@kbn/core/server/mocks';
+import { CollectorFetchContext } from '@kbn/usage-collection-plugin/server';
+import { fetcher } from './fetcher';
+
+let savedObjectClient: ReturnType<typeof savedObjectsRepositoryMock.create>;
+
+let closeMock: jest.Mock;
+let esClient: ElasticsearchClientMock;
+
+describe('Investigation usage collector fetcher', () => {
+  beforeEach(() => {
+    savedObjectClient = savedObjectsRepositoryMock.create();
+    closeMock = jest.fn();
+  });
+
+  it('without any existing investigation', async () => {
+    savedObjectClient.createPointInTimeFinder.mockReturnValue({
+      find: async function* find() {
+        return {
+          [Symbol.asyncIterator]: async () => {},
+          next: () => {},
+        };
+      },
+      close: closeMock,
+    });
+
+    const results = await fetcher({
+      soClient: savedObjectClient,
+      esClient,
+    } as CollectorFetchContext);
+
+    expect(closeMock).toHaveBeenCalled();
+    expect(results.investigation).toMatchInlineSnapshot(`
+      Object {
+        "by_origin": Object {
+          "alert": 0,
+          "blank": 0,
+        },
+        "by_status": Object {
+          "active": 0,
+          "cancelled": 0,
+          "mitigated": 0,
+          "resolved": 0,
+          "triage": 0,
+        },
+        "items": Object {
+          "avg": 0,
+          "max": 0,
+          "min": 0,
+          "p90": 0,
+          "p95": 0,
+        },
+        "notes": Object {
+          "avg": 0,
+          "max": 0,
+          "min": 0,
+          "p90": 0,
+          "p95": 0,
+        },
+        "total": 0,
+      }
+    `);
+  });
+});

x-pack/plugins/observability_solution/investigate_app/server/lib/collectors/fetcher.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 { CollectorFetchContext } from '@kbn/usage-collection-plugin/server';
+import { StoredInvestigation } from '../../models/investigation';
+import { SO_INVESTIGATION_TYPE } from '../../saved_objects/investigation';
+import { computeMetrics } from './helpers/metrics';
+import { Usage } from './type';
+
+export const fetcher = async (context: CollectorFetchContext) => {
+  const finder = context.soClient.createPointInTimeFinder<StoredInvestigation>({
+    type: SO_INVESTIGATION_TYPE,
+    perPage: 10,
+  });
+
+  let usage: Usage['investigation'] = {
+    total: 0,
+    by_status: {
+      triage: 0,
+      active: 0,
+      mitigated: 0,
+      resolved: 0,
+      cancelled: 0,
+    },
+    by_origin: {
+      alert: 0,
+      blank: 0,
+    },
+    items: {
+      avg: 0,
+      p90: 0,
+      p95: 0,
+      max: 0,
+      min: 0,
+    },
+    notes: {
+      avg: 0,
+      p90: 0,
+      p95: 0,
+      max: 0,
+      min: 0,
+    },
+  };
+
+  const items: number[] = [];
+  const notes: number[] = [];
+
+  for await (const response of finder.find()) {
+    usage = response.saved_objects.reduce((acc, so) => {
+      items.push(so.attributes.items.length);
+      notes.push(so.attributes.notes.length);
+
+      return {
+        ...acc,
+        total: acc.total + 1,
+        by_status: {
+          ...acc.by_status,
+          ...(so.attributes.status === 'triage' && { triage: acc.by_status.triage + 1 }),
+          ...(so.attributes.status === 'active' && { active: acc.by_status.active + 1 }),
+          ...(so.attributes.status === 'mitigated' && { mitigated: acc.by_status.mitigated + 1 }),
+          ...(so.attributes.status === 'resolved' && { resolved: acc.by_status.resolved + 1 }),
+          ...(so.attributes.status === 'cancelled' && { cancelled: acc.by_status.cancelled + 1 }),
+        },
+        by_origin: {
+          ...acc.by_origin,
+          ...(so.attributes.origin.type === 'alert' && { alert: acc.by_origin.alert + 1 }),
+          ...(so.attributes.origin.type === 'blank' && { blank: acc.by_origin.blank + 1 }),
+        },
+      };
+    }, usage);
+  }
+
+  usage.items = computeMetrics(items.sort());
+  usage.notes = computeMetrics(notes.sort());
+
+  await finder.close();
+
+  return {
+    investigation: usage,
+  };
+};

x-pack/plugins/observability_solution/investigate_app/server/lib/collectors/helpers/metrics.test.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { computeMetrics } from './metrics';
+
+describe('ComputeMetrics', () => {
+  it('computes the metrics correctly', async () => {
+    expect(computeMetrics([])).toMatchInlineSnapshot(`
+      Object {
+        "avg": 0,
+        "max": 0,
+        "min": 0,
+        "p90": 0,
+        "p95": 0,
+      }
+    `);
+    expect(computeMetrics([10, 10, 100])).toMatchInlineSnapshot(`
+      Object {
+        "avg": 40,
+        "max": 100,
+        "min": 10,
+        "p90": 100,
+        "p95": 100,
+      }
+    `);
+
+    const arr = Array.from({ length: 100 }, (_, i) => i);
+    expect(computeMetrics(arr)).toMatchInlineSnapshot(`
+      Object {
+        "avg": 49.5,
+        "max": 99,
+        "min": 0,
+        "p90": 90,
+        "p95": 95,
+      }
+    `);
+  });
+});

x-pack/plugins/observability_solution/investigate_app/server/lib/collectors/helpers/metrics.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 { sum } from 'lodash';
+
+export function computeMetrics(arr: number[]) {
+  if (arr.length === 0) {
+    return {
+      avg: 0,
+      p90: 0,
+      p95: 0,
+      max: 0,
+      min: 0,
+    };
+  }
+
+  const total = sum(arr);
+  const r90 = (90 / 100) * (arr.length - 1) + 1;
+  const r95 = (95 / 100) * (arr.length - 1) + 1;
+
+  return {
+    avg: total / arr.length,
+    p90: arr[Math.floor(r90)],
+    p95: arr[Math.floor(r95)],
+    max: arr[arr.length - 1],
+    min: arr[0],
+  };
+}

x-pack/plugins/observability_solution/investigate_app/server/lib/collectors/register.ts

@@ -0,0 +1,147 @@
+/*
+ * 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 { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server';
+import { fetcher } from './fetcher';
+import type { Usage } from './type';
+
+export function registerUsageCollector(usageCollection?: UsageCollectionSetup): void {
+  if (!usageCollection) {
+    return;
+  }
+
+  const usageCollector = usageCollection.makeUsageCollector<Usage>({
+    type: 'investigation',
+    schema: {
+      investigation: {
+        total: {
+          type: 'long',
+          _meta: {
+            description: 'The total number of investigations in the cluster',
+          },
+        },
+        by_status: {
+          triage: {
+            type: 'long',
+            _meta: {
+              description: 'The number of investigations in triage status in the cluster',
+            },
+          },
+          active: {
+            type: 'long',
+            _meta: { description: 'The number of investigations in active status in the cluster' },
+          },
+          mitigated: {
+            type: 'long',
+            _meta: {
+              description: 'The number of investigations in mitigated status in the cluster',
+            },
+          },
+          resolved: {
+            type: 'long',
+            _meta: {
+              description: 'The number of investigations in resolved status in the cluster',
+            },
+          },
+          cancelled: {
+            type: 'long',
+            _meta: {
+              description: 'The number of investigations in cancelled status in the cluster',
+            },
+          },
+        },
+        by_origin: {
+          alert: {
+            type: 'long',
+            _meta: {
+              description: 'The number of investigations created from alerts in the cluster',
+            },
+          },
+          blank: {
+            type: 'long',
+            _meta: {
+              description: 'The number of investigations created from scratch in the cluster',
+            },
+          },
+        },
+        items: {
+          avg: {
+            type: 'long',
+            _meta: {
+              description: 'The average number of items across all investigations in the cluster',
+            },
+          },
+          p90: {
+            type: 'long',
+            _meta: {
+              description:
+                'The 90th percentile of the number of items across all investigations in the cluster',
+            },
+          },
+          p95: {
+            type: 'long',
+            _meta: {
+              description:
+                'The 95th percentile of the number of items across all investigations in the cluster',
+            },
+          },
+          max: {
+            type: 'long',
+            _meta: {
+              description: 'The maximum number of items across all investigations in the cluster',
+            },
+          },
+          min: {
+            type: 'long',
+            _meta: {
+              description: 'The minimum number of items across all investigations in the cluster',
+            },
+          },
+        },
+        notes: {
+          avg: {
+            type: 'long',
+            _meta: {
+              description: 'The average number of notes across all investigations in the cluster',
+            },
+          },
+          p90: {
+            type: 'long',
+            _meta: {
+              description:
+                'The 90th percentile of the number of notes across all investigations in the cluster',
+            },
+          },
+          p95: {
+            type: 'long',
+            _meta: {
+              description:
+                'The 95th percentile of the number of notes across all investigations in the cluster',
+            },
+          },
+          max: {
+            type: 'long',
+            _meta: {
+              description: 'The maximum number of notes across all investigations in the cluster',
+            },
+          },
+          min: {
+            type: 'long',
+            _meta: {
+              description: 'The minimum number of notes across all investigations in the cluster',
+            },
+          },
+        },
+      },
+    },
+    isReady: () => true,
+    fetch: fetcher,
+  });
+
+  // register usage collector
+  usageCollection.registerCollector(usageCollector);
+}