[Proof of Concept] Add otel metrics to alerting plugin

package.json

@@ -121,6 +121,7 @@
     "@emotion/css": "^11.9.0",
     "@emotion/react": "^11.9.0",
     "@emotion/serialize": "^1.0.3",
+    "@grpc/grpc-js": "^1.5.9",
     "@hapi/accept": "^5.0.2",
     "@hapi/boom": "^9.1.4",
     "@hapi/cookie": "^11.0.2",
@@ -237,6 +238,12 @@
     "@mapbox/mapbox-gl-draw": "1.3.0",
     "@mapbox/mapbox-gl-rtl-text": "0.2.3",
     "@mapbox/vector-tile": "1.3.1",
+    "@opentelemetry/api-metrics": "0.29.2",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.29.2",
+    "@opentelemetry/exporter-prometheus": "^0.29.2",
+    "@opentelemetry/resources": "^1.3.1",
+    "@opentelemetry/sdk-metrics-base": "^0.29.2",
+    "@opentelemetry/semantic-conventions": "^1.3.1",
     "@reduxjs/toolkit": "^1.6.1",
     "@slack/webhook": "^5.0.4",
     "@turf/along": "6.0.1",

x-pack/plugins/alerting/server/monitoring/index.ts

@@ -8,3 +8,4 @@ export { registerNodeCollector } from './register_node_collector';
 export { registerClusterCollector } from './register_cluster_collector';
 export * from './types';
 export * from './in_memory_metrics';
+export * from './metrics';

x-pack/plugins/alerting/server/monitoring/metrics.mock.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { metrics } from '@opentelemetry/api-metrics';
+import { Metrics } from './metrics';
+
+export const metricsMock = {
+  create: () => new Metrics(metrics.getMeter('kibana.alerting.metrics.mock')),
+};

x-pack/plugins/alerting/server/monitoring/metrics.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { Counter, Histogram, Meter } from '@opentelemetry/api-metrics';
+
+export class Metrics {
+  ruleExecutionsTotal: Counter;
+  ruleExecutions: Counter;
+  ruleFailures: Counter;
+  ruleDuration: Histogram;
+
+  constructor(meter: Meter) {
+    this.ruleExecutionsTotal = meter.createCounter('ruleExecutionsTotal');
+    this.ruleExecutions = meter.createCounter('ruleExecutions');
+    this.ruleFailures = meter.createCounter('ruleFailures');
+    this.ruleDuration = meter.createHistogram('ruleDuration');
+  }
+}

x-pack/plugins/alerting/server/plugin.ts

@@ -49,6 +49,7 @@ import {
 import { PluginStartContract as FeaturesPluginStart } from '@kbn/features-plugin/server';
 import { PluginStart as DataPluginStart } from '@kbn/data-plugin/server';
 import { MonitoringCollectionSetup } from '@kbn/monitoring-collection-plugin/server';
+import { metrics } from '@opentelemetry/api-metrics';
 import { RuleTypeRegistry } from './rule_type_registry';
 import { TaskRunnerFactory } from './task_runner';
 import { RulesClientFactory } from './rules_client_factory';
@@ -77,7 +78,12 @@ import { getHealth } from './health/get_health';
 import { AlertingAuthorizationClientFactory } from './alerting_authorization_client_factory';
 import { AlertingAuthorization } from './authorization';
 import { getSecurityHealth, SecurityHealth } from './lib/get_security_health';
-import { registerNodeCollector, registerClusterCollector, InMemoryMetrics } from './monitoring';
+import {
+  registerNodeCollector,
+  registerClusterCollector,
+  InMemoryMetrics,
+  Metrics,
+} from './monitoring';
 import { getRuleTaskTimeout } from './lib/get_rule_task_timeout';
 import { getActionsConfigMap } from './lib/get_actions_config_map';
 
@@ -173,6 +179,7 @@ export class AlertingPlugin {
   private kibanaBaseUrl: string | undefined;
   private usageCounter: UsageCounter | undefined;
   private inMemoryMetrics: InMemoryMetrics;
+  private metrics: Metrics;
 
   constructor(initializerContext: PluginInitializerContext) {
     this.config = initializerContext.config.get();
@@ -183,6 +190,7 @@ export class AlertingPlugin {
     this.telemetryLogger = initializerContext.logger.get('usage');
     this.kibanaVersion = initializerContext.env.packageInfo.version;
     this.inMemoryMetrics = new InMemoryMetrics(initializerContext.logger.get('in_memory_metrics'));
+    this.metrics = new Metrics(metrics.getMeter('kibana.alerting'));
   }
 
   public setup(
@@ -227,6 +235,7 @@ export class AlertingPlugin {
       licensing: plugins.licensing,
       minimumScheduleInterval: this.config.rules.minimumScheduleInterval,
       inMemoryMetrics: this.inMemoryMetrics,
+      metrics: this.metrics,
     });
     this.ruleTypeRegistry = ruleTypeRegistry;
 

x-pack/plugins/alerting/server/rule_type_registry.test.ts

@@ -14,13 +14,15 @@ import { licenseStateMock } from './lib/license_state.mock';
 import { licensingMock } from '@kbn/licensing-plugin/server/mocks';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
 import { inMemoryMetricsMock } from './monitoring/in_memory_metrics.mock';
+import { metricsMock } from './monitoring/metrics.mock';
 
 const logger = loggingSystemMock.create().get();
 let mockedLicenseState: jest.Mocked<ILicenseState>;
 let ruleTypeRegistryParams: ConstructorOptions;
 
 const taskManager = taskManagerMock.createSetup();
 const inMemoryMetrics = inMemoryMetricsMock.create();
+const metrics = metricsMock.create();
 
 beforeEach(() => {
   jest.resetAllMocks();
@@ -33,6 +35,7 @@ beforeEach(() => {
     licensing: licensingMock.createSetup(),
     minimumScheduleInterval: { value: '1m', enforce: false },
     inMemoryMetrics,
+    metrics,
   };
 });
 

x-pack/plugins/alerting/server/rule_type_registry.ts

@@ -31,7 +31,7 @@ import {
 } from '../common';
 import { ILicenseState } from './lib/license_state';
 import { getRuleTypeFeatureUsageName } from './lib/get_rule_type_feature_usage_name';
-import { InMemoryMetrics } from './monitoring';
+import { InMemoryMetrics, Metrics } from './monitoring';
 import { AlertingRulesConfig } from '.';
 
 export interface ConstructorOptions {
@@ -42,6 +42,7 @@ export interface ConstructorOptions {
   licensing: LicensingPluginSetup;
   minimumScheduleInterval: AlertingRulesConfig['minimumScheduleInterval'];
   inMemoryMetrics: InMemoryMetrics;
+  metrics: Metrics;
 }
 
 export interface RegistryRuleType
@@ -139,6 +140,7 @@ export class RuleTypeRegistry {
   private readonly minimumScheduleInterval: AlertingRulesConfig['minimumScheduleInterval'];
   private readonly licensing: LicensingPluginSetup;
   private readonly inMemoryMetrics: InMemoryMetrics;
+  private readonly metrics: Metrics;
 
   constructor({
     logger,
@@ -148,6 +150,7 @@ export class RuleTypeRegistry {
     licensing,
     minimumScheduleInterval,
     inMemoryMetrics,
+    metrics,
   }: ConstructorOptions) {
     this.logger = logger;
     this.taskManager = taskManager;
@@ -156,6 +159,7 @@ export class RuleTypeRegistry {
     this.licensing = licensing;
     this.minimumScheduleInterval = minimumScheduleInterval;
     this.inMemoryMetrics = inMemoryMetrics;
+    this.metrics = metrics;
   }
 
   public has(id: string) {
@@ -274,7 +278,7 @@ export class RuleTypeRegistry {
             InstanceContext,
             ActionGroupIds,
             RecoveryActionGroupId | RecoveredActionGroupId
-          >(normalizedRuleType, context, this.inMemoryMetrics),
+          >(normalizedRuleType, context, this.inMemoryMetrics, this.metrics),
       },
     });
     // No need to notify usage on basic alert types

x-pack/plugins/alerting/server/saved_objects/is_rule_exportable.test.ts

@@ -15,12 +15,14 @@ import { licensingMock } from '@kbn/licensing-plugin/server/mocks';
 import { isRuleExportable } from './is_rule_exportable';
 import { inMemoryMetricsMock } from '../monitoring/in_memory_metrics.mock';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
+import { metricsMock } from '../monitoring/metrics.mock';
 
 let ruleTypeRegistryParams: ConstructorOptions;
 let logger: MockedLogger;
 let mockedLicenseState: jest.Mocked<ILicenseState>;
 const taskManager = taskManagerMock.createSetup();
 const inMemoryMetrics = inMemoryMetricsMock.create();
+const metrics = metricsMock.create();
 
 beforeEach(() => {
   jest.resetAllMocks();
@@ -34,6 +36,7 @@ beforeEach(() => {
     licensing: licensingMock.createSetup(),
     minimumScheduleInterval: { value: '1m', enforce: false },
     inMemoryMetrics,
+    metrics,
   };
 });