Skip to content

[9.3] [Entity Analytics] Adding event based telemetry for entity highlights API usage (#250101) #250258

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

Merged
kibanamachine merged 1 commit into from
Jan 24, 2026
Merged

[9.3] [Entity Analytics] Adding event based telemetry for entity highlights API usage (#250101) #250258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .../security/plugins/security_solution/common/entity_analytics/entity_analytics/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

// INTERNAL
const INTERNAL_URL = `/internal/entity_details` as const;
export const ENTITY_DETAILS_HIGHLIGH_INTERNAL_URL = `${INTERNAL_URL}/highlights` as const;
export const ENTITY_DETAILS_HIGHLIGHT_INTERNAL_URL = `${INTERNAL_URL}/highlights` as const;

// PUBLIC
export const PUBLIC_URL = `/api/entity_details` as const;
4 changes: 2 additions & 2 deletions x-pack/solutions/security/plugins/security_solution/public/entity_analytics/api/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import { useMemo } from 'react';
import type { AnonymizationFieldResponse } from '@kbn/elastic-assistant-common';
import type { EntityDetailsHighlightsResponse } from '../../../common/api/entity_analytics/entity_details/highlights.gen';
import { ENTITY_DETAILS_HIGHLIGH_INTERNAL_URL } from '../../../common/entity_analytics/entity_analytics/constants';
import { ENTITY_DETAILS_HIGHLIGHT_INTERNAL_URL } from '../../../common/entity_analytics/entity_analytics/constants';
import type {
AssetCriticalityRecord,
CreateEntitySourceResponse,
Expand Down Expand Up @@ -461,7 +461,7 @@ export const useEntityAnalyticsRoutes = () => {
},
signal?: AbortSignal
): Promise<EntityDetailsHighlightsResponse> =>
http.fetch(ENTITY_DETAILS_HIGHLIGH_INTERNAL_URL, {
http.fetch(ENTITY_DETAILS_HIGHLIGHT_INTERNAL_URL, {
version: API_VERSIONS.internal.v1,
method: 'POST',
body: JSON.stringify(params),
Expand Down
11 changes: 9 additions & 2 deletions ...ty_solution/server/lib/entity_analytics/entity_details/routes/entity_details_highlight.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,13 @@ import {
import { getPrompt } from '@kbn/elastic-assistant-plugin/server/lib/prompt/get_prompt';
import type { EntityDetailsHighlightsResponse } from '../../../../../common/api/entity_analytics/entity_details/highlights.gen';
import { EntityDetailsHighlightsRequestBody } from '../../../../../common/api/entity_analytics/entity_details/highlights.gen';
import { ENTITY_DETAILS_HIGHLIGH_INTERNAL_URL } from '../../../../../common/entity_analytics/entity_analytics/constants';
import { ENTITY_DETAILS_HIGHLIGHT_INTERNAL_URL } from '../../../../../common/entity_analytics/entity_analytics/constants';
import { EntityTypeToIdentifierField } from '../../../../../common/entity_analytics/types';
import { APP_ID, API_VERSIONS } from '../../../../../common/constants';
import type { EntityAnalyticsRoutesDeps } from '../../types';
import { entityDetailsHighlightsServiceFactory } from '../entity_details_highlights_service';
import { withLicense } from '../../../siem_migrations/common/api/util/with_license';
import { ENTITY_HIGHLIGHTS_USAGE_EVENT } from '../../../telemetry/event_based/events';

export const entityDetailsHighlightsRoute = (
router: EntityAnalyticsRoutesDeps['router'],
Expand All @@ -31,7 +32,7 @@ export const entityDetailsHighlightsRoute = (
router.versioned
.post({
access: 'internal',
path: ENTITY_DETAILS_HIGHLIGH_INTERNAL_URL,
path: ENTITY_DETAILS_HIGHLIGHT_INTERNAL_URL,
security: {
authz: {
requiredPrivileges: ['securitySolution', `${APP_ID}-entity-analytics`],
Expand Down Expand Up @@ -74,6 +75,12 @@ export const entityDetailsHighlightsRoute = (
const riskEngineClient = securitySolution.getRiskEngineDataClient();
const assetCriticalityClient = securitySolution.getAssetCriticalityDataClient();

const telemetry = securitySolution.getAnalytics();
telemetry.reportEvent(ENTITY_HIGHLIGHTS_USAGE_EVENT.eventType, {
entityType,
spaceId,
});

const {
getRiskScoreData,
getAssetCriticalityData,
Expand Down
22 changes: 22 additions & 0 deletions ...k/solutions/security/plugins/security_solution/server/lib/telemetry/event_based/events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,27 @@ export const ENTITY_ENGINE_DELETION_EVENT: EventTypeOpts<{
},
};

export const ENTITY_HIGHLIGHTS_USAGE_EVENT: EventTypeOpts<{
entityType: string;
spaceId: string;
}> = {
eventType: 'entity_highlights_usage',
schema: {
entityType: {
type: 'keyword',
_meta: {
description: 'Type of entity highlights have been request for (e.g. "host")',
},
},
spaceId: {
type: 'keyword',
_meta: {
description: 'Space where the highlight request originated (e.g. "default")',
},
},
},
};

export const ENTITY_STORE_USAGE_EVENT: EventTypeOpts<{
storeSize: number;
entityType: string;
Expand Down Expand Up @@ -1715,6 +1736,7 @@ export const events = [
ENTITY_ENGINE_INITIALIZATION_EVENT,
ENTITY_ENGINE_DELETION_EVENT,
ENTITY_STORE_USAGE_EVENT,
ENTITY_HIGHLIGHTS_USAGE_EVENT,
PRIVMON_ENGINE_INITIALIZATION_EVENT,
PRIVMON_ENGINE_RESOURCE_INIT_FAILURE_EVENT,
TELEMETRY_DATA_STREAM_EVENT,
Expand Down