Skip to content
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.

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

feat(investigation): Add eventTypes filter on the API #202829

Merged
merged 19 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
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
19 changes: 0 additions & 19 deletions packages/kbn-investigation-shared/src/rest_specs/event.ts

This file was deleted.

16 changes: 14 additions & 2 deletions packages/kbn-investigation-shared/src/rest_specs/get_events.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
*/

import { z } from '@kbn/zod';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this none self-explanatory z 🤔 😆 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did I add that? I don't recall importing from @kbn/zod but that's probably just a wrapper around zod itself

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know it before. Thanks!

import { eventResponseSchema } from './event';
import { eventTypeSchema, eventSchema } from '../schema';

const getEventsParamsSchema = z
.object({
Expand All @@ -17,12 +17,24 @@ const getEventsParamsSchema = z
rangeFrom: z.string(),
rangeTo: z.string(),
filter: z.string(),
eventTypes: z.string().transform((val, ctx) => {
const eventTypes = val.split(',');
const hasInvalidType = eventTypes.some((eventType) => !eventTypeSchema.parse(eventType));
if (hasInvalidType) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
message: 'Invalid event type',
});
return z.NEVER;
}
return eventTypes;
}),
})
.partial(),
})
.partial();

const getEventsResponseSchema = z.array(eventResponseSchema);
const getEventsResponseSchema = z.array(eventSchema);

type GetEventsParams = z.infer<typeof getEventsParamsSchema.shape.query>;
type GetEventsResponse = z.output<typeof getEventsResponseSchema>;
Expand Down
2 changes: 0 additions & 2 deletions packages/kbn-investigation-shared/src/rest_specs/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ export type * from './investigation_note';
export type * from './update';
export type * from './update_item';
export type * from './update_note';
export type * from './event';
export type * from './get_events';
export type * from './entity';
export type * from './get_entities';
Expand All @@ -48,7 +47,6 @@ export * from './investigation_note';
export * from './update';
export * from './update_item';
export * from './update_note';
export * from './event';
export * from './get_events';
export * from './entity';
export * from './get_entities';
33 changes: 19 additions & 14 deletions packages/kbn-investigation-shared/src/schema/event.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,15 @@ const eventTypeSchema = z.union([
z.literal('anomaly'),
]);

const sourceSchema = z.record(z.string(), z.any());

const annotationEventSchema = z.object({
eventType: z.literal('annotation'),
id: z.string(),
title: z.string(),
description: z.string(),
timestamp: z.number(),
source: sourceSchema.optional(),
annotationType: z.string().optional(),
});

Expand All @@ -31,21 +38,19 @@ const alertStatusSchema = z.union([

const alertEventSchema = z.object({
eventType: z.literal('alert'),
id: z.string(),
title: z.string(),
description: z.string(),
timestamp: z.number(),
source: sourceSchema.optional(),
alertStatus: alertStatusSchema,
});

const sourceSchema = z.record(z.string(), z.any());
const eventSchema = z.discriminatedUnion('eventType', [annotationEventSchema, alertEventSchema]);

type EventResponse = z.output<typeof eventSchema>;
type AlertEventResponse = z.output<typeof alertEventSchema>;
type AnnotationEventResponse = z.output<typeof annotationEventSchema>;

const eventSchema = z.intersection(
z.object({
id: z.string(),
title: z.string(),
description: z.string(),
timestamp: z.number(),
eventType: eventTypeSchema,
source: sourceSchema.optional(),
}),
z.discriminatedUnion('eventType', [annotationEventSchema, alertEventSchema])
);

export { eventSchema };
export type { EventResponse, AlertEventResponse, AnnotationEventResponse };
export { eventSchema, eventTypeSchema, alertEventSchema, annotationEventSchema };
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,12 @@ export const investigationKeys = {
userProfiles: (profileIds: Set<string>) =>
[...investigationKeys.all, 'userProfiles', ...profileIds] as const,
tags: () => [...investigationKeys.all, 'tags'] as const,
events: (rangeFrom?: string, rangeTo?: string, filter?: string) =>
[...investigationKeys.all, 'events', rangeFrom, rangeTo, filter] as const,
events: (params: {
rangeFrom?: string;
rangeTo?: string;
filter?: string;
eventTypes?: string[];
}) => [...investigationKeys.all, 'events', params] as const,
stats: () => [...investigationKeys.all, 'stats'] as const,
lists: () => [...investigationKeys.all, 'list'] as const,
list: (params: { page: number; perPage: number; search?: string; filter?: string }) =>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ import {
CreateInvestigationNoteParams,
CreateInvestigationNoteResponse,
} from '@kbn/investigation-shared';
import { useMutation } from '@tanstack/react-query';
import { useMutation, useQueryClient } from '@tanstack/react-query';
import { useKibana } from './use_kibana';
import { investigationKeys } from './query_key_factory';

type ServerError = IHttpFetchError<ResponseErrorBody>;

Expand All @@ -23,6 +24,7 @@ export function useAddInvestigationNote() {
notifications: { toasts },
},
} = useKibana();
const queryClient = useQueryClient();

return useMutation<
CreateInvestigationNoteResponse,
Expand All @@ -39,7 +41,12 @@ export function useAddInvestigationNote() {
);
},
{
onSuccess: (response, {}) => {
onSuccess: (_, { investigationId }) => {
queryClient.invalidateQueries({
queryKey: investigationKeys.detailNotes(investigationId),
exact: false,
});

toasts.addSuccess(
i18n.translate('xpack.investigateApp.addInvestigationNote.successMessage', {
defaultMessage: 'Note saved',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
*/

import { IHttpFetchError, ResponseErrorBody } from '@kbn/core/public';
import { useMutation } from '@tanstack/react-query';
import { useMutation, useQueryClient } from '@tanstack/react-query';
import { i18n } from '@kbn/i18n';
import { useKibana } from './use_kibana';
import { investigationKeys } from './query_key_factory';

type ServerError = IHttpFetchError<ResponseErrorBody>;

export function useDeleteInvestigationNote() {
const queryClient = useQueryClient();
const {
core: {
http,
Expand All @@ -34,7 +36,12 @@ export function useDeleteInvestigationNote() {
);
},
{
onSuccess: (response, {}) => {
onSuccess: (response, { investigationId }) => {
queryClient.invalidateQueries({
queryKey: investigationKeys.detailNotes(investigationId),
exact: false,
});

toasts.addSuccess(
i18n.translate('xpack.investigateApp.useDeleteInvestigationNote.successMessage', {
defaultMessage: 'Note deleted',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export function useFetchAlert({ investigation }: UseFetchAlertParams): UseFetchA
});
},
staleTime: 60 * 1000,
retry: false,
refetchOnWindowFocus: false,
onError: (error: Error) => {
toasts.addError(error, {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ export function useFetchAllInvestigationStats(): Response {
};
},
retry: false,
cacheTime: 600 * 1000, // 10 minutes
staleTime: 0,
staleTime: 15 * 1000,
onError: (error: Error) => {
toasts.addError(error, {
title: i18n.translate('xpack.investigateApp.useFetchAllInvestigationStats.errorTitle', {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ export function useFetchAllInvestigationTags(): Response {
signal,
});
},
cacheTime: 600 * 1000, // 10_minutes
staleTime: 0,
staleTime: 15 * 1000,
refetchOnWindowFocus: false,
retry: false,
onError: (error: Error) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,7 @@ export function useFetchEntities({
});
},
refetchOnWindowFocus: false,
onError: (error: Error) => {
// ignore error
},
retry: false,
enabled: Boolean(investigationId && (serviceName || hostName || containerId)),
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,14 @@
*/

import { i18n } from '@kbn/i18n';
import { useQuery } from '@tanstack/react-query';
import { GetEventsResponse } from '@kbn/investigation-shared';
import { useQuery } from '@tanstack/react-query';
import { isArray } from 'lodash';
import { investigationKeys } from './query_key_factory';
import { useKibana } from './use_kibana';

export interface Response {
isInitialLoading: boolean;
isLoading: boolean;
isRefetching: boolean;
isSuccess: boolean;
isError: boolean;
data?: GetEventsResponse;
}
Expand All @@ -24,10 +22,12 @@ export function useFetchEvents({
rangeFrom,
rangeTo,
filter,
eventTypes,
}: {
rangeFrom?: string;
rangeTo?: string;
filter?: string;
eventTypes?: string[];
}): Response {
const {
core: {
Expand All @@ -36,21 +36,20 @@ export function useFetchEvents({
},
} = useKibana();

const { isInitialLoading, isLoading, isError, isSuccess, isRefetching, data } = useQuery({
queryKey: investigationKeys.events(rangeFrom, rangeTo, filter),
const { isLoading, isError, data } = useQuery({
queryKey: investigationKeys.events({ rangeFrom, rangeTo, filter, eventTypes }),
queryFn: async ({ signal }) => {
return await http.get<GetEventsResponse>(`/api/observability/events`, {
return http.get<GetEventsResponse>(`/api/observability/events`, {
query: {
rangeFrom,
rangeTo,
filter,
...(isArray(eventTypes) && eventTypes.length > 0 && { eventTypes: eventTypes.join(',') }),
},
version: '2023-10-31',
signal,
});
},
cacheTime: 600 * 1000, // 10_minutes
staleTime: 0,
refetchOnWindowFocus: false,
retry: false,
onError: (error: Error) => {
Expand All @@ -64,10 +63,7 @@ export function useFetchEvents({

return {
data,
isInitialLoading,
isLoading,
isRefetching,
isSuccess,
isError,
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ export function useFetchInvestigationList({
retry: false,
refetchInterval: 60 * 1000,
refetchOnWindowFocus: false,
cacheTime: 600 * 1000, // 10 minutes
staleTime: 0,
onError: (error: Error) => {
toasts.addError(error, {
title: i18n.translate('xpack.investigateApp.useFetchInvestigationList.errorTitle', {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,16 @@ export function useUpdateInvestigationNote() {
},
{
onSuccess: (response, { investigationId }) => {
queryClient.invalidateQueries({
queryKey: investigationKeys.detailNotes(investigationId),
exact: false,
});

toasts.addSuccess(
i18n.translate('xpack.investigateApp.useUpdateInvestigationNote.successMessage', {
defaultMessage: 'Note updated',
})
);
queryClient.invalidateQueries({ queryKey: investigationKeys.detailNotes(investigationId) });
},
onError: (error, {}, context) => {
toasts.addError(
Expand Down
Loading