From 2699f170c07f54fa9cc373da607e881e40237375 Mon Sep 17 00:00:00 2001
From: Steph Milovic <stephanie.milovic@elastic.co>
Date: Tue, 17 Dec 2024 14:24:18 -0700
Subject: [PATCH] [8.16] [Security assistant] Fix `invoke_assistant_success `
 telemetry schema (#204280) (#204454)

# Backport

This will backport the following commits from `main` to `8.16`:
- [[Security assistant] Fix `invoke_assistant_success ` telemetry schema
(#204280)](https://github.com/elastic/kibana/pull/204280)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Steph
Milovic","email":"stephanie.milovic@elastic.co"},"sourceCommit":{"committedDate":"2024-12-16T17:00:59Z","message":"[Security
assistant] Fix `invoke_assistant_success ` telemetry schema
(#204280)","sha":"86fe148e963f2afaaa02cc1160a58bb959904a5c","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:
SecuritySolution","backport:prev-major","Team:Security Generative
AI"],"number":204280,"url":"https://github.com/elastic/kibana/pull/204280","mergeCommit":{"message":"[Security
assistant] Fix `invoke_assistant_success ` telemetry schema
(#204280)","sha":"86fe148e963f2afaaa02cc1160a58bb959904a5c"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/204280","number":204280,"mergeCommit":{"message":"[Security
assistant] Fix `invoke_assistant_success ` telemetry schema
(#204280)","sha":"86fe148e963f2afaaa02cc1160a58bb959904a5c"}},{"url":"https://github.com/elastic/kibana/pull/204451","number":204451,"branch":"8.x","state":"OPEN"}]}]
BACKPORT-->

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
---
 .../lib/telemetry/event_based_telemetry.ts    | 122 ++++++++++--------
 1 file changed, 68 insertions(+), 54 deletions(-)

diff --git a/x-pack/plugins/elastic_assistant/server/lib/telemetry/event_based_telemetry.ts b/x-pack/plugins/elastic_assistant/server/lib/telemetry/event_based_telemetry.ts
index 1087703ba13a4..06564be238fcb 100644
--- a/x-pack/plugins/elastic_assistant/server/lib/telemetry/event_based_telemetry.ts
+++ b/x-pack/plugins/elastic_assistant/server/lib/telemetry/event_based_telemetry.ts
@@ -77,13 +77,16 @@ export const INVOKE_ASSISTANT_SUCCESS_EVENT: EventTypeOpts<{
   actionTypeId: string;
   isEnabledKnowledgeBase: boolean;
   durationMs: number;
-  ['toolsInvoked.AlertCountsTool']?: number;
-  ['toolsInvoked.NaturalLanguageESQLTool']?: number;
-  ['toolsInvoked.KnowledgeBaseRetrievalTool']?: number;
-  ['toolsInvoked.KnowledgeBaseWriteTool']?: number;
-  ['toolsInvoked.OpenAndAcknowledgedAlertsTool']?: number;
-  ['toolsInvoked.SecurityLabsKnowledgeBaseTool']?: number;
-  ['toolsInvoked.CustomTool']?: number;
+  toolsInvoked: {
+    AlertCountsTool?: number;
+    NaturalLanguageESQLTool?: number;
+    KnowledgeBaseRetrievalTool?: number;
+    KnowledgeBaseWriteTool?: number;
+    OpenAndAcknowledgedAlertsTool?: number;
+    SecurityLabsKnowledgeBaseTool?: number;
+    ProductDocumentationTool?: number;
+    CustomTool?: number;
+  };
   model?: string;
   isOssModel?: boolean;
 }> = {
@@ -127,53 +130,64 @@ export const INVOKE_ASSISTANT_SUCCESS_EVENT: EventTypeOpts<{
         description: 'The duration of the request.',
       },
     },
-    'toolsInvoked.AlertCountsTool': {
-      type: 'long',
-      _meta: {
-        description: 'Number of times tool was invoked.',
-        optional: true,
-      },
-    },
-    'toolsInvoked.NaturalLanguageESQLTool': {
-      type: 'long',
-      _meta: {
-        description: 'Number of times tool was invoked.',
-        optional: true,
-      },
-    },
-    'toolsInvoked.KnowledgeBaseRetrievalTool': {
-      type: 'long',
-      _meta: {
-        description: 'Number of times tool was invoked.',
-        optional: true,
-      },
-    },
-    'toolsInvoked.KnowledgeBaseWriteTool': {
-      type: 'long',
-      _meta: {
-        description: 'Number of times tool was invoked.',
-        optional: true,
-      },
-    },
-    'toolsInvoked.OpenAndAcknowledgedAlertsTool': {
-      type: 'long',
-      _meta: {
-        description: 'Number of times tool was invoked.',
-        optional: true,
-      },
-    },
-    'toolsInvoked.SecurityLabsKnowledgeBaseTool': {
-      type: 'long',
-      _meta: {
-        description: 'Number of times tool was invoked.',
-        optional: true,
-      },
-    },
-    'toolsInvoked.CustomTool': {
-      type: 'long',
-      _meta: {
-        description: 'Number of times tool was invoked.',
-        optional: true,
+    toolsInvoked: {
+      properties: {
+        AlertCountsTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
+        NaturalLanguageESQLTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
+        ProductDocumentationTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
+        KnowledgeBaseRetrievalTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
+        KnowledgeBaseWriteTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
+        OpenAndAcknowledgedAlertsTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
+        SecurityLabsKnowledgeBaseTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
+        CustomTool: {
+          type: 'long',
+          _meta: {
+            description: 'Number of times tool was invoked.',
+            optional: true,
+          },
+        },
       },
     },
   },