Fixes #19860: Added Diagnostic tab to display diagnostic information || Added Sync offset button #19980

dhruvjsx · 2025-02-26T06:18:15Z

Fixes #19860

I worked on adding a Diagnostics tab in the alert details page to help users troubleshoot delayed alerts. This includes:

A Sync Offset button to prioritize alert events by syncing their offsets.
API: PUT /api/v1/events/subscriptions/name/{name}/syncOffset

Displaying diagnostic information to show the current and total offsets of alerts.
API: GET /api/v1/events/subscriptions/name/{name}/diagnosticInfo

These changes ensure that users receive alerts in real time even when offsets fall behind in the queue.

BEFORE

AFTER

Screen.Recording.2025-02-27.at.1.37.46.PM.mov

Type of change:

Bug fix

Checklist:

I have read the CONTRIBUTING document.
My PR title is Fixes <issue-number>: <short explanation>
I have commented on my code, particularly in hard-to-understand areas.

github-actions · 2025-02-26T06:18:40Z

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

github-actions · 2025-02-26T06:32:51Z

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

aniketkatkar97 · 2025-02-26T06:26:45Z

openmetadata-ui/src/main/resources/ui/playwright/e2e/Flow/ObservabilityAlerts.spec.ts

+test('Alert Diagnostic Info', async ({ page }) => {
+  const ALERT_NAME = generateAlertName();
+
+  await test.step('Create alert', async () => {
+    await visitObservabilityAlertPage(page);
+    data.alertDetails = await createAlert({
+      page,
+      alertName: ALERT_NAME,
+      sourceName: SOURCE_NAME_1,
+      sourceDisplayName: SOURCE_DISPLAY_NAME_1,
+      user: user1,
+      createButtonId: 'create-observability',
+      selectId: 'Owner Name',
+      addTrigger: true,
+    });
+  });
+
+  await test.step('Verify diagnostic info tab', async () => {
+    await visitObservabilityAlertPage(page);
+    await visitAlertDetailsPage(page, data.alertDetails);
+
+    const diagnosticTab = page.getByRole('tab', { name: /diagnostic info/i });
+    const diagnosticInfoResponse = page.waitForResponse(
+      `/api/v1/events/subscriptions/**/diagnosticInfo`
+    );
+    await diagnosticTab.click();
+    await diagnosticInfoResponse;
+  });
+
+  await test.step('Delete alert', async () => {
+    await deleteAlert(page, data.alertDetails, false);


We don't need to create a separate alert just for the diagnostics info check. Can we add a test for a created alert somewhere above?

aniketkatkar97 · 2025-02-26T06:30:20Z

openmetadata-ui/src/main/resources/ui/src/pages/UserListPage/UserListPageV1.tsx

@@ -223,12 +222,13 @@ const UserListPageV1 = () => {

  const handleShowDeletedUserChange = (value: boolean) => {
    handlePageChange(INITIAL_PAGING_VALUE);
+    handlePageSizeChange(PAGE_SIZE_MEDIUM);


Let's not mix up 2 separate fixes in a single PR. Can you please create a separate PR for the User list?

...i/src/components/Alerts/AlertDetails/AlertDiagnosticInfo/AlertDiagnosticInfoTab.interface.ts

...sources/ui/src/components/Alerts/AlertDetails/AlertDiagnosticInfo/AlertDiagnosticInfoTab.tsx

openmetadata-ui/src/main/resources/ui/src/pages/AlertDetailsPage/AlertDetailsPage.tsx

...sources/ui/src/components/Alerts/AlertDetails/AlertDiagnosticInfo/AlertDiagnosticInfoTab.tsx

...ces/ui/src/components/Alerts/AlertDetails/AlertDiagnosticInfo/alert-diagnostic-info-tab.less

aniketkatkar97 · 2025-02-26T06:44:23Z

openmetadata-ui/src/main/resources/ui/src/locale/languages/en-us.json

@@ -61,6 +61,7 @@
    "alert-lowercase": "alert",
    "alert-lowercase-plural": "alerts",
    "alert-plural": "Alerts",
+    "alert-synced-successfully": "Alert synced successfully",


Let's add these changes to other language files as well, with the respective translations.

github-actions · 2025-02-26T06:53:44Z

Jest test Coverage

UI tests summary

Lines	Statements	Branches	Functions
	63.41% (41523/65483)	39.09% (16576/42410)	43% (5024/11684)

...sources/ui/src/components/Alerts/AlertDetails/AlertDiagnosticInfo/AlertDiagnosticInfoTab.tsx

...ces/ui/src/components/Alerts/AlertDetails/AlertDiagnosticInfo/alert-diagnostic-info-tab.less

aniketkatkar97 · 2025-02-26T13:15:45Z

...ces/ui/src/components/Alerts/AlertDetails/AlertDiagnosticInfo/alert-diagnostic-info-tab.less

+  .text-grey-muted {
+    display: inline;
+  }


The styles do not match the class name we are giving. Use a completely different class with all the stylings if there are many, or just use the pre-defined classes for the specific style. Ex. in this case inline already exists with the display:inline style.

openmetadata-ui/src/main/resources/ui/src/locale/languages/pt-pt.json

openmetadata-ui/src/main/resources/ui/src/locale/languages/de-de.json

openmetadata-ui/src/main/resources/ui/src/pages/AlertDetailsPage/AlertDetailsPage.tsx

aniketkatkar97 · 2025-02-26T13:21:00Z

openmetadata-ui/src/main/resources/ui/src/pages/AlertDetailsPage/AlertDetailsPage.tsx

+                        title={t('label.sync-entity', {
+                          entity: t('label.alert'),
+                        })}>


Ideally this should be Sync Alert Offset

sonarqubecloud · 2025-02-26T13:24:25Z

Quality Gate passed for 'open-metadata-ui'

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Dhruv parmar added 5 commits February 20, 2025 17:48

fixed: pagination for deleted users

e74d8b2

fixed test cases

e472034

fixed comments

bf9283b

used admin token to authenticate

1303172

feature: added Diagnostic info tab

9d74ecb

dhruvjsx requested a review from a team as a code owner February 26, 2025 06:18

dhruvjsx had a problem deploying to test February 26, 2025 06:18 — with GitHub Actions Failure

Merge branch 'main' into dhruv

f64b8ac

karanh37 had a problem deploying to test February 26, 2025 06:32 — with GitHub Actions Error

karanh37 added the safe to test Add this label to run secure Github workflows on PRs label Feb 26, 2025

karanh37 had a problem deploying to test February 26, 2025 06:33 — with GitHub Actions Failure

aniketkatkar97 reviewed Feb 26, 2025

View reviewed changes

Dhruv parmar added 2 commits February 26, 2025 17:38

fixed comments

8c09959

Merge remote-tracking branch 'origin/dhruv' into dhruv

f537ae7

dhruvjsx had a problem deploying to test February 26, 2025 13:01 — with GitHub Actions Failure

aniketkatkar97 reviewed Feb 26, 2025

View reviewed changes

fixed github comments

1614997

dhruvjsx had a problem deploying to test February 27, 2025 06:00 — with GitHub Actions Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #19860: Added Diagnostic tab to display diagnostic information || Added Sync offset button #19980

Fixes #19860: Added Diagnostic tab to display diagnostic information || Added Sync offset button #19980

dhruvjsx commented Feb 26, 2025 •

edited

Loading

github-actions bot commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

aniketkatkar97 Feb 26, 2025

aniketkatkar97 Feb 26, 2025

aniketkatkar97 Feb 26, 2025

github-actions bot commented Feb 26, 2025 •

edited

Loading

aniketkatkar97 Feb 26, 2025

aniketkatkar97 Feb 26, 2025

sonarqubecloud bot commented Feb 26, 2025

Fixes #19860: Added Diagnostic tab to display diagnostic information || Added Sync offset button #19980

Are you sure you want to change the base?

Fixes #19860: Added Diagnostic tab to display diagnostic information || Added Sync offset button #19980

Conversation

dhruvjsx commented Feb 26, 2025 • edited Loading

Type of change:

Checklist:

github-actions bot commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

aniketkatkar97 Feb 26, 2025

Choose a reason for hiding this comment

aniketkatkar97 Feb 26, 2025

Choose a reason for hiding this comment

aniketkatkar97 Feb 26, 2025

Choose a reason for hiding this comment

github-actions bot commented Feb 26, 2025 • edited Loading

Jest test Coverage

UI tests summary

aniketkatkar97 Feb 26, 2025

Choose a reason for hiding this comment

aniketkatkar97 Feb 26, 2025

Choose a reason for hiding this comment

sonarqubecloud bot commented Feb 26, 2025

Quality Gate passed for 'open-metadata-ui'

dhruvjsx commented Feb 26, 2025 •

edited

Loading

github-actions bot commented Feb 26, 2025 •

edited

Loading