github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.16] [Security assistant] Fix `invoke_assistant_*` telemetry (#198594) (#198626)

Browse source 
# Backport

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

<!--- Backport version: 9.4.3 -->

### 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-10-31T21:34:22Z","message":"[Security
assistant] Fix `invoke_assistant_*` telemetry
(#198594)","sha":"8ab30f5fcd73822d36565920dec3bc6ed663b153","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Security
Generative
AI","v8.16.0","backport:version","v8.17.0","v8.16.1"],"title":"[Security
assistant] Fix `invoke_assistant_*`
telemetry","number":198594,"url":"https://github.com/elastic/kibana/pull/198594","mergeCommit":{"message":"[Security
assistant] Fix `invoke_assistant_*` telemetry
(#198594)","sha":"8ab30f5fcd73822d36565920dec3bc6ed663b153"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198594","number":198594,"mergeCommit":{"message":"[Security
assistant] Fix `invoke_assistant_*` telemetry
(#198594)","sha":"8ab30f5fcd73822d36565920dec3bc6ed663b153"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Steph Milovic <stephanie.milovic@elastic.co>
This commit is contained in:
Kibana Machine 2024-11-01 10:19:53 +11:00 • committed by GitHub
parent 539d756b3e
commit 16eedd240b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 37 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

1
x-pack/plugins/elastic_assistant/server/routes/chat/chat_complete_route.test.ts
View file

@ -290,6 +290,7 @@ describe('chatCompleteRoute', () => {
actionTypeId: '.gen-ai',
model: 'gpt-4',
assistantStreamingEnabled: false,
isEnabledKnowledgeBase: false,
});
}),
};

21
x-pack/plugins/elastic_assistant/server/routes/chat/chat_complete_route.ts
View file

@ -25,6 +25,9 @@ import { buildResponse } from '../../lib/build_response';
import {
appendAssistantMessageToConversation,
createConversationWithUserInput,
DEFAULT_PLUGIN_NAME,
getIsKnowledgeBaseInstalled,
getPluginNameFromRequest,
langChainExecute,
performChecks,
} from '../helpers';
@ -63,9 +66,9 @@ export const chatCompleteRoute = (
const assistantResponse = buildResponse(response);
let telemetry;
let actionTypeId;
const ctx = await context.resolve(['core', 'elasticAssistant', 'licensing']);
const logger: Logger = ctx.elasticAssistant.logger;
try {
const ctx = await context.resolve(['core', 'elasticAssistant', 'licensing']);
const logger: Logger = ctx.elasticAssistant.logger;
telemetry = ctx.elasticAssistant.telemetry;
const inference = ctx.elasticAssistant.inference;
@ -219,6 +222,19 @@ export const chatCompleteRoute = (
});
} catch (err) {
const error = transformError(err as Error);
const pluginName = getPluginNameFromRequest({
request,
defaultPluginName: DEFAULT_PLUGIN_NAME,
logger,
});
const v2KnowledgeBaseEnabled =
ctx.elasticAssistant.getRegisteredFeatures(pluginName).assistantKnowledgeBaseByDefault;
const kbDataClient =
(await ctx.elasticAssistant.getAIAssistantKnowledgeBaseDataClient({
v2KnowledgeBaseEnabled,
})) ?? undefined;
const isKnowledgeBaseInstalled = await getIsKnowledgeBaseInstalled(kbDataClient);
telemetry?.reportEvent(INVOKE_ASSISTANT_ERROR_EVENT.eventType, {
actionTypeId: actionTypeId ?? '',
model: request.body.model,
@ -226,6 +242,7 @@ export const chatCompleteRoute = (
// TODO rm actionTypeId check when llmClass for bedrock streaming is implemented
// tracked here: https://github.com/elastic/security-team/issues/7363
assistantStreamingEnabled: request.body.isStream ?? false,
isEnabledKnowledgeBase: isKnowledgeBaseInstalled,
});
return assistantResponse.error({
body: error.message,

30
x-pack/plugins/elastic_assistant/server/routes/helpers.ts
View file

@ -35,7 +35,7 @@ import { FindResponse } from '../ai_assistant_data_clients/find';
import { EsPromptsSchema } from '../ai_assistant_data_clients/prompts/types';
import { AIAssistantDataClient } from '../ai_assistant_data_clients';
import { MINIMUM_AI_ASSISTANT_LICENSE } from '../../common/constants';
import { ESQL_DOCS_LOADED_QUERY } from './knowledge_base/constants';
import { SECURITY_LABS_RESOURCE, SECURITY_LABS_LOADED_QUERY } from './knowledge_base/constants';
import { buildResponse, getLlmType } from './utils';
import {
AgentExecutorParams,
@ -436,15 +436,13 @@ export const langChainExecute = async ({
executorParams
);
const { esqlExists, isModelDeployed } = await getIsKnowledgeBaseEnabled(kbDataClient);
const isKnowledgeBaseInstalled = await getIsKnowledgeBaseInstalled(kbDataClient);
telemetry.reportEvent(INVOKE_ASSISTANT_SUCCESS_EVENT.eventType, {
actionTypeId,
model: request.body.model,
// TODO rm actionTypeId check when llmClass for bedrock streaming is implemented
// tracked here: https://github.com/elastic/security-team/issues/7363
assistantStreamingEnabled: isStream && actionTypeId === '.gen-ai',
isEnabledKnowledgeBase: isModelDeployed && esqlExists,
assistantStreamingEnabled: isStream,
isEnabledKnowledgeBase: isKnowledgeBaseInstalled,
});
return response.ok<StreamResponseWithHeaders['body'] | StaticReturnType['body']>(result);
};
@ -671,23 +669,20 @@ export const isV2KnowledgeBaseEnabled = ({
* Telemetry function to determine whether knowledge base has been installed
* @param kbDataClient
*/
export const getIsKnowledgeBaseEnabled = async (
export const getIsKnowledgeBaseInstalled = async (
kbDataClient?: AIAssistantKnowledgeBaseDataClient | null
): Promise<{
esqlExists: boolean;
isModelDeployed: boolean;
}> => {
let esqlExists = false;
): Promise<boolean> => {
let securityLabsDocsExist = false;
let isModelDeployed = false;
if (kbDataClient != null) {
try {
isModelDeployed = await kbDataClient.isModelDeployed();
if (isModelDeployed) {
esqlExists =
securityLabsDocsExist =
(
await kbDataClient.getKnowledgeBaseDocumentEntries({
query: ESQL_DOCS_LOADED_QUERY,
required: true,
kbResource: SECURITY_LABS_RESOURCE,
query: SECURITY_LABS_LOADED_QUERY,
})
).length > 0;
}
@ -696,8 +691,5 @@ export const getIsKnowledgeBaseEnabled = async (
}
}
return {
esqlExists,
isModelDeployed,
};
return isModelDeployed && securityLabsDocsExist;
};

2
x-pack/plugins/elastic_assistant/server/routes/knowledge_base/constants.ts
View file

@ -13,3 +13,5 @@ export const ESQL_DOCS_LOADED_QUERY =
'You can chain processing commands, separated by a pipe character: `|`.';
export const SECURITY_LABS_RESOURCE = 'security_labs';
export const USER_RESOURCE = 'user';
// Query for determining if Security Labs docs have been loaded. Intended for use with Telemetry
export const SECURITY_LABS_LOADED_QUERY = 'What is Elastic Security Labs';

2
x-pack/plugins/elastic_assistant/server/routes/post_actions_connector_execute.test.ts
View file

@ -51,7 +51,7 @@ jest.mock('./helpers', () => {
return {
...original,
getIsKnowledgeBaseEnabled: jest.fn(),
getIsKnowledgeBaseInstalled: jest.fn(),
appendAssistantMessageToConversation: jest.fn(),
langChainExecute: jest.fn(),
getPluginNameFromRequest: jest.fn(),

7
x-pack/plugins/elastic_assistant/server/routes/post_actions_connector_execute.ts
View file

@ -24,7 +24,7 @@ import { ElasticAssistantRequestHandlerContext, GetElser } from '../types';
import {
appendAssistantMessageToConversation,
DEFAULT_PLUGIN_NAME,
getIsKnowledgeBaseEnabled,
getIsKnowledgeBaseInstalled,
getPluginNameFromRequest,
getSystemPromptFromUserConversation,
langChainExecute,
@ -170,14 +170,13 @@ export const postActionsConnectorExecuteRoute = (
(await assistantContext.getAIAssistantKnowledgeBaseDataClient({
v2KnowledgeBaseEnabled,
})) ?? undefined;
const isEnabledKnowledgeBase = await getIsKnowledgeBaseEnabled(kbDataClient);
const isKnowledgeBaseInstalled = await getIsKnowledgeBaseInstalled(kbDataClient);
telemetry.reportEvent(INVOKE_ASSISTANT_ERROR_EVENT.eventType, {
actionTypeId: request.body.actionTypeId,
model: request.body.model,
errorMessage: error.message,
assistantStreamingEnabled: request.body.subAction !== 'invokeAI',
isEnabledKnowledgeBase,
isEnabledKnowledgeBase: isKnowledgeBaseInstalled,
});
return resp.error({