Skip to content

[8.19] Track toast errors using apm-rum (#217948) #218531

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
maryam-saeidi merged 1 commit into from
Apr 17, 2025
Merged

[8.19] Track toast errors using apm-rum (#217948) #218531

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
28 changes: 26 additions & 2 deletions src/core/packages/notifications/browser-internal/src/toasts/toasts_api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,19 @@ import { firstValueFrom } from 'rxjs';

import { ToastsApi } from './toasts_api';

import { apm } from '@elastic/apm-rum';
import { uiSettingsServiceMock } from '@kbn/core-ui-settings-browser-mocks';
import { analyticsServiceMock } from '@kbn/core-analytics-browser-mocks';
import { i18nServiceMock } from '@kbn/core-i18n-browser-mocks';
import { themeServiceMock } from '@kbn/core-theme-browser-mocks';
import { userProfileServiceMock } from '@kbn/core-user-profile-browser-mocks';

jest.mock('@elastic/apm-rum', () => ({
apm: {
captureError: jest.fn(),
},
}));

async function getCurrentToasts(toasts: ToastsApi) {
return await firstValueFrom(toasts.get$());
}
Expand Down Expand Up @@ -213,36 +220,53 @@ describe('#addDanger()', () => {
it('adds a danger toast', async () => {
const toasts = new ToastsApi(toastDeps());
expect(toasts.addDanger({})).toHaveProperty('color', 'danger');
expect(apm.captureError).toBeCalledWith('No title or text is provided.', {
labels: { errorType: 'ToastDanger' },
});
});

it('returns the created toast', async () => {
const toasts = new ToastsApi(toastDeps());
const toast = toasts.addDanger({});
const currentToasts = await getCurrentToasts(toasts);
expect(currentToasts[0]).toBe(toast);
expect(apm.captureError).toBeCalledWith('No title or text is provided.', {
labels: { errorType: 'ToastDanger' },
});
});

it('fallbacks to default values for undefined properties', async () => {
const toasts = new ToastsApi(toastDeps());
const toast = toasts.addDanger({ title: 'foo', toastLifeTimeMs: undefined });
expect(toast.toastLifeTimeMs).toEqual(10000);
expect(apm.captureError).toBeCalledWith('foo', {
labels: { errorType: 'ToastDanger' },
});
});
});

describe('#addError', () => {
it('adds an error toast', async () => {
const toasts = new ToastsApi(toastDeps());
toasts.start(startDeps());
const toast = toasts.addError(new Error('unexpected error'), { title: 'Something went wrong' });
const error = new Error('unexpected error');
const toast = toasts.addError(error, { title: 'Something went wrong' });
expect(toast).toHaveProperty('color', 'danger');
expect(toast).toHaveProperty('title', 'Something went wrong');
expect(apm.captureError).toBeCalledWith(error, {
labels: { errorType: 'ToastError' },
});
});

it('returns the created toast', async () => {
const toasts = new ToastsApi(toastDeps());
toasts.start(startDeps());
const toast = toasts.addError(new Error('unexpected error'), { title: 'Something went wrong' });
const error = new Error('unexpected error');
const toast = toasts.addError(error, { title: 'Something went wrong' });
const currentToasts = await getCurrentToasts(toasts);
expect(currentToasts[0]).toBe(toast);
expect(apm.captureError).toBeCalledWith(error, {
labels: { errorType: 'ToastError' },
});
});
});
26 changes: 26 additions & 0 deletions src/core/packages/notifications/browser-internal/src/toasts/toasts_api.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import React from 'react';
import * as Rx from 'rxjs';
import { omitBy, isUndefined } from 'lodash';

import { apm } from '@elastic/apm-rum';
import type { AnalyticsServiceStart } from '@kbn/core-analytics-browser';
import type { I18nStart } from '@kbn/core-i18n-browser';
import type { IUiSettingsClient } from '@kbn/core-ui-settings-browser';
Expand All @@ -37,6 +38,24 @@ const normalizeToast = (toastOrTitle: ToastInput): ToastInputFields => {
return omitBy(toastOrTitle, isUndefined);
};

const getToastTitleOrText = (toastOrTitle: ToastInput): string => {
if (typeof toastOrTitle === 'string') {
return toastOrTitle;
} else if (typeof toastOrTitle.title === 'string') {
return toastOrTitle.title;
} else if (typeof toastOrTitle.text === 'string') {
return toastOrTitle.text;
}

return 'No title or text is provided.';
};

const getApmLabels = (errorType: 'ToastError' | 'ToastDanger') => {
return {
errorType,
};
};

interface StartDeps {
analytics: AnalyticsServiceStart;
overlays: OverlayStart;
Expand Down Expand Up @@ -158,6 +177,10 @@ export class ToastsApi implements IToasts {
* @returns a {@link Toast}
*/
public addDanger(toastOrTitle: ToastInput, options?: ToastOptions) {
const toastTitle = getToastTitleOrText(toastOrTitle);
apm.captureError(toastTitle, {
labels: getApmLabels('ToastDanger'),
});
return this.add({
color: 'danger',
iconType: 'error',
Expand All @@ -175,6 +198,9 @@ export class ToastsApi implements IToasts {
* @returns a {@link Toast}
*/
public addError(error: Error, options: ErrorToastOptions) {
apm.captureError(error, {
labels: getApmLabels('ToastError'),
});
const message = options.toastMessage || error.message;
return this.add({
color: 'danger',
Expand Down