[Alert details page] Update alertDetailsUrl context variable URL (#19…

…3674) Closes #180889 ## Summary Update the alertDetailsUrl context variable for the following rules: - Inventory rule - Metric threshold rule - Error count threshold rule - Failed transaction rate threshold rule - APM Anomaly rule - Synthetics TLS rule - Synthetics monitor status rule
elastic · Sep 24, 2024 · 09082f2 · 09082f2
1 parent 101fcfe
commit 09082f2
Show file tree

Hide file tree

Showing 18 changed files with 70 additions and 218 deletions.
diff --git a/...y_solution/apm/server/routes/alerts/rule_types/anomaly/register_anomaly_rule_type.test.ts b/...y_solution/apm/server/routes/alerts/rule_types/anomaly/register_anomaly_rule_type.test.ts
@@ -217,7 +217,7 @@ describe('Transaction duration anomaly alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'development',
  reason:
  'critical latency anomaly with a score of 80, was detected in the last 5 mins for foo.',

diff --git a/...bility_solution/apm/server/routes/alerts/rule_types/anomaly/register_anomaly_rule_type.ts b/...bility_solution/apm/server/routes/alerts/rule_types/anomaly/register_anomaly_rule_type.ts
@@ -18,7 +18,11 @@ import {
 import { KibanaRequest, DEFAULT_APP_CATEGORIES } from '@kbn/core/server';
 import datemath from '@kbn/datemath';
 import type { ESSearchResponse } from '@kbn/es-types';
-import { getAlertUrl, observabilityPaths, ProcessorEvent } from '@kbn/observability-plugin/common';
+import {
+ getAlertDetailsUrl,
+ observabilityPaths,
+ ProcessorEvent,
+} from '@kbn/observability-plugin/common';
 import { termQuery, termsQuery } from '@kbn/observability-plugin/server';
 import {
  ALERT_EVALUATION_THRESHOLD,
@@ -128,7 +132,7 @@ export function registerAnomalyRuleType({
  return { state: {} };
  }
 
- const { params, services, spaceId, startedAt, getTimeRange } = options;
+ const { params, services, spaceId, getTimeRange } = options;
  const { alertsClient, savedObjectsClient, scopedClusterClient, uiSettingsClient } = services;
  if (!alertsClient) {
  throw new AlertsClientError();
@@ -303,11 +307,10 @@ export function registerAnomalyRuleType({
 
  const alertId = bucketKey.join('_');
 
- const { uuid, start } = alertsClient.report({
+ const { uuid } = alertsClient.report({
  id: alertId,
  actionGroup: ruleTypeConfig.defaultActionGroupId,
  });
- const indexedStartedAt = start ?? startedAt.toISOString();
 
  const relativeViewInAppUrl = getAlertUrlTransaction(
  serviceName,
@@ -319,13 +322,7 @@ export function registerAnomalyRuleType({
  spaceId,
  relativeViewInAppUrl
  );
- const alertDetailsUrl = await getAlertUrl(
- uuid,
- spaceId,
- indexedStartedAt,
- alertsLocator,
- basePath.publicBaseUrl
- );
+ const alertDetailsUrl = await getAlertDetailsUrl(basePath, spaceId, uuid);
 
  const payload = {
  [SERVICE_NAME]: serviceName,

diff --git a/...on/apm/server/routes/alerts/rule_types/error_count/register_error_count_rule_type.test.ts b/...on/apm/server/routes/alerts/rule_types/error_count/register_error_count_rule_type.test.ts
@@ -142,7 +142,7 @@ describe('Error count alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -167,7 +167,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo-2',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -192,7 +192,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-bar',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -283,7 +283,7 @@ describe('Error count alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -310,7 +310,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo-2',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -337,7 +337,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-bar',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -433,7 +433,7 @@ describe('Error count alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  errorGroupingKey: 'error-key-foo',
  interval: '5 mins',
@@ -458,7 +458,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo-2',
  errorGroupingKey: 'error-key-foo-2',
  interval: '5 mins',
@@ -483,7 +483,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-bar',
  errorGroupingKey: 'error-key-bar',
  interval: '5 mins',
@@ -573,7 +573,7 @@ describe('Error count alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -598,7 +598,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo-2',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -623,7 +623,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-bar',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -714,7 +714,7 @@ describe('Error count alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'Not defined',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -740,7 +740,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'Not defined',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -766,7 +766,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-bar',
  errorGroupingKey: undefined,
  interval: '5 mins',
@@ -860,7 +860,7 @@ describe('Error count alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  errorGroupingKey: 'error-key-foo',
  errorGroupingName: 'error-name-foo',
@@ -887,7 +887,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo-2',
  errorGroupingKey: 'error-key-foo-2',
  errorGroupingName: 'error-name-foo2',
@@ -914,7 +914,7 @@ describe('Error count alert', () => {
  });
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-bar',
  errorGroupingKey: 'error-key-bar',
  errorGroupingName: 'error-name-bar',
@@ -1001,7 +1001,7 @@ describe('Error count alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  errorGroupingKey: undefined,
  interval: '5 mins',

diff --git a/...olution/apm/server/routes/alerts/rule_types/error_count/register_error_count_rule_type.ts b/...olution/apm/server/routes/alerts/rule_types/error_count/register_error_count_rule_type.ts
@@ -17,7 +17,7 @@ import {
 } from '@kbn/alerting-plugin/server';
 import {
  formatDurationFromTimeUnitChar,
- getAlertUrl,
+ getAlertDetailsUrl,
  observabilityPaths,
  ProcessorEvent,
  TimeUnitChar,
@@ -127,7 +127,7 @@ export function registerErrorCountRuleType({
  ErrorCountAlert
  >
  ) => {
- const { params: ruleParams, services, spaceId, startedAt, getTimeRange } = options;
+ const { params: ruleParams, services, spaceId, getTimeRange } = options;
  const { alertsClient, savedObjectsClient, scopedClusterClient, uiSettingsClient } = services;
  if (!alertsClient) {
  throw new AlertsClientError();
@@ -221,11 +221,10 @@ export function registerErrorCountRuleType({
  groupByFields,
  });
 
- const { uuid, start } = alertsClient.report({
+ const { uuid } = alertsClient.report({
  id: alertId,
  actionGroup: ruleTypeConfig.defaultActionGroupId,
  });
- const indexedStartedAt = start ?? startedAt.toISOString();
 
  const relativeViewInAppUrl = getAlertUrlErrorCount(
  groupByFields[SERVICE_NAME],
@@ -236,13 +235,7 @@ export function registerErrorCountRuleType({
  spaceId,
  relativeViewInAppUrl
  );
- const alertDetailsUrl = await getAlertUrl(
- uuid,
- spaceId,
- indexedStartedAt,
- alertsLocator,
- basePath.publicBaseUrl
- );
+ const alertDetailsUrl = await getAlertDetailsUrl(basePath, spaceId, uuid);
  const groupByActionVariables = getGroupByActionVariables(groupByFields);
 
  const payload = {

diff --git a/...lerts/rule_types/transaction_error_rate/register_transaction_error_rate_rule_type.test.ts b/...lerts/rule_types/transaction_error_rate/register_transaction_error_rate_rule_type.test.ts
@@ -129,7 +129,7 @@ describe('Transaction error rate alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  interval: '5 mins',
  reason:
@@ -242,7 +242,7 @@ describe('Transaction error rate alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  interval: '5 mins',
  reason:
@@ -355,7 +355,7 @@ describe('Transaction error rate alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-foo',
  interval: '5 mins',
  reason:
@@ -468,7 +468,7 @@ describe('Transaction error rate alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'Not defined',
  interval: '5 mins',
  reason:
@@ -569,7 +569,7 @@ describe('Transaction error rate alert', () => {
 
  expect(services.alertsClient.setAlertData).toHaveBeenCalledWith({
  context: {
- alertDetailsUrl: 'mockedAlertsLocator > getLocation',
+ alertDetailsUrl: 'http://localhost:5601/eyr/app/observability/alerts/test-uuid',
  environment: 'env-bar',
  interval: '5 mins',
  reason:

diff --git a/...tes/alerts/rule_types/transaction_error_rate/register_transaction_error_rate_rule_type.ts b/...tes/alerts/rule_types/transaction_error_rate/register_transaction_error_rate_rule_type.ts
@@ -17,7 +17,7 @@ import {
 } from '@kbn/alerting-plugin/server';
 import {
  formatDurationFromTimeUnitChar,
- getAlertUrl,
+ getAlertDetailsUrl,
  observabilityPaths,
  ProcessorEvent,
  TimeUnitChar,
@@ -137,7 +137,7 @@ export function registerTransactionErrorRateRuleType({
  TransactionErrorRateAlert
  >
  ) => {
- const { services, spaceId, params: ruleParams, startedAt, getTimeRange } = options;
+ const { services, spaceId, params: ruleParams, getTimeRange } = options;
  const { alertsClient, savedObjectsClient, scopedClusterClient, uiSettingsClient } = services;
  if (!alertsClient) {
  throw new AlertsClientError();
@@ -273,11 +273,10 @@ export function registerTransactionErrorRateRuleType({
  groupByFields,
  });
 
- const { uuid, start } = alertsClient.report({
+ const { uuid } = alertsClient.report({
  id: alertId,
  actionGroup: ruleTypeConfig.defaultActionGroupId,
  });
- const indexedStartedAt = start ?? startedAt.toISOString();
 
  const relativeViewInAppUrl = getAlertUrlTransaction(
  groupByFields[SERVICE_NAME],
@@ -289,13 +288,7 @@ export function registerTransactionErrorRateRuleType({
  spaceId,
  relativeViewInAppUrl
  );
- const alertDetailsUrl = await getAlertUrl(
- uuid,
- spaceId,
- indexedStartedAt,
- alertsLocator,
- basePath.publicBaseUrl
- );
+ const alertDetailsUrl = await getAlertDetailsUrl(basePath, spaceId, uuid);
  const groupByActionVariables = getGroupByActionVariables(groupByFields);
 
  const payload = {

diff --git a/x-pack/plugins/observability_solution/apm/server/routes/alerts/test_utils/index.ts b/x-pack/plugins/observability_solution/apm/server/routes/alerts/test_utils/index.ts
@@ -7,8 +7,6 @@
 
 import { IBasePath, Logger } from '@kbn/core/server';
 import { elasticsearchServiceMock } from '@kbn/core/server/mocks';
-import type { AlertsLocatorParams } from '@kbn/observability-plugin/common';
-import { LocatorPublic } from '@kbn/share-plugin/common';
 import { IRuleDataClient } from '@kbn/rule-registry-plugin/server';
 import { ruleRegistryMocks } from '@kbn/rule-registry-plugin/server/mocks';
 import { PluginSetupContract as AlertingPluginSetupContract } from '@kbn/alerting-plugin/server';
@@ -80,11 +78,6 @@ export const createRuleTypeMocks = () => {
  ruleDataClient: ruleRegistryMocks.createRuleDataClient(
  '.alerts-observability.apm.alerts'
  ) as IRuleDataClient,
- alertsLocator: {
- getLocation: jest.fn().mockImplementation(() => ({
- path: 'mockedAlertsLocator > getLocation',
- })),
- } as any as LocatorPublic<AlertsLocatorParams>,
  } as unknown as RegisterRuleDependencies;
 
  return {