apm-api-shared

Author: cauemarcondes

package.json

@@ -238,6 +238,7 @@
     "@kbn/anonymization-common": "link:x-pack/platform/packages/shared/ai-infra/anonymization-common",
     "@kbn/anonymization-plugin": "link:x-pack/platform/plugins/shared/anonymization",
     "@kbn/anonymization-ui": "link:x-pack/platform/packages/shared/ai-infra/anonymization-ui",
+    "@kbn/apm-api-shared": "link:src/platform/packages/shared/kbn-apm-api-shared",
     "@kbn/apm-common": "link:src/platform/packages/shared/kbn-apm-common",
     "@kbn/apm-config-loader": "link:src/platform/packages/private/kbn-apm-config-loader",
     "@kbn/apm-data-access-plugin": "link:x-pack/solutions/observability/plugins/apm_data_access",

src/platform/packages/shared/kbn-apm-api-shared/index.ts

@@ -0,0 +1,69 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export {
+  createCallApmApiV2,
+  type APMClientV2,
+  type AutoAbortedAPMClientV2,
+  type APIReturnType,
+} from './src/create_call_apm_api';
+export { routeDefinitions } from './src/routes';
+export type { SharedAPMRouteRepository } from './src/routes';
+export type * from './src/routes/historical_data';
+export type * from './src/routes/suggestions';
+export type * from './src/routes/agent_keys';
+export type * from './src/routes/traces';
+export type * from './src/routes/span_links';
+export type * from './src/routes/observability_overview';
+export type * from './src/routes/agent_explorer';
+export type * from './src/routes/alerts';
+export type * from './src/routes/assistant_functions';
+export type * from './src/routes/correlations';
+export type * from './src/routes/custom_dashboards';
+export type * from './src/routes/dependencies';
+export type * from './src/routes/transactions';
+export type * from './src/routes/services';
+export type * from './src/routes/service_map';
+export type * from './src/routes/errors';
+export type * from './src/routes/infrastructure';
+export type * from './src/routes/environments';
+export type * from './src/routes/event_metadata';
+export type * from './src/routes/fallback_to_transactions';
+export type * from './src/routes/latency_distribution';
+export type * from './src/routes/metrics';
+export type * from './src/routes/profiling';
+export type * from './src/routes/service_groups';
+export type * from './src/routes/time_range_metadata';
+export type * from './src/routes/custom_links';
+export type * from './src/routes/anomaly_detection';
+export type * from './src/routes/mobile';
+export type * from './src/routes/mobile_errors';
+export type * from './src/routes/mobile_crashes';
+export type * from './src/routes/data_view';
+export type * from './src/routes/diagnostics';
+export type * from './src/routes/fleet';
+export type * from './src/routes/debug_telemetry';
+export type * from './src/routes/storage_explorer';
+export type * from './src/routes/source_maps';
+export type * from './src/routes/agent_configuration';
+export { sourceMapRt } from './src/routes/source_maps';
+export { filterOptionsRt, payloadRt } from './src/routes/custom_links';
+export {
+  rangeRt,
+  kueryRt,
+  probabilityRt,
+  offsetRt,
+  serviceTransactionDataSourceRt,
+  transactionDataSourceRt,
+  filtersRt,
+} from './src/default_api_types';
+export {
+  OBSERVABILITY_APM_CPS_ENABLED_DEFAULT,
+  OBSERVABILITY_APM_CPS_ENABLED_FEATURE_FLAG,
+} from './src/cps_feature_flag';

src/platform/packages/shared/kbn-apm-api-shared/kibana.jsonc

@@ -0,0 +1,10 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/apm-api-shared",
+  "owner": [
+    "@elastic/obs-presentation-team",
+    "@elastic/obs-exploration-team"
+  ],
+  "group": "platform",
+  "visibility": "shared"
+}

src/platform/packages/shared/kbn-apm-api-shared/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@kbn/apm-api-shared",
+  "private": true,
+  "version": "1.0.0",
+  "license": "Elastic License 2.0 OR AGPL-3.0-only OR SSPL-1.0"
+}

src/platform/packages/shared/kbn-apm-api-shared/src/call_api.ts

@@ -0,0 +1,92 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import type { CoreSetup, CoreStart } from '@kbn/core/public';
+import { isString, startsWith } from 'lodash';
+import { LRUCache as LRU } from 'lru-cache';
+import hash from 'object-hash';
+import type { FetchOptions } from './create_call_apm_api';
+
+function fetchOptionsWithDebug(fetchOptions: FetchOptions, inspectableEsQueriesEnabled: boolean) {
+  const debugEnabled =
+    inspectableEsQueriesEnabled && startsWith(fetchOptions.pathname, '/internal/apm');
+
+  const { body, ...rest } = fetchOptions;
+
+  return {
+    ...rest,
+    ...(body !== undefined ? { body: JSON.stringify(body) } : {}),
+    query: {
+      ...fetchOptions.query,
+      ...(debugEnabled ? { _inspect: true } : {}),
+    },
+  };
+}
+
+const cache = new LRU<string, any>({ max: 100, ttl: 1000 * 60 * 60 });
+
+export function clearCache() {
+  cache.clear();
+}
+
+export type CallApi = typeof callApi;
+
+export async function callApi<T = void>(
+  { http, uiSettings }: CoreStart | CoreSetup,
+  fetchOptions: FetchOptions
+): Promise<T> {
+  const inspectableEsQueriesEnabled: boolean =
+    // For now this needs to be hardcoded as we cannot import the key, as it lives inside the observability plugin,
+    // and refactoring it is outside the scope of this PR, but ideally this should be imported from the same place as the key is defined
+    uiSettings?.get('observability:enableInspectEsQueries') ?? false;
+  const cacheKey = getCacheKey(fetchOptions);
+  const cacheResponse = cache.get(cacheKey);
+  if (cacheResponse) {
+    return cacheResponse;
+  }
+
+  const {
+    pathname,
+    method = 'get',
+    ...options
+  } = fetchOptionsWithDebug(fetchOptions, inspectableEsQueriesEnabled);
+
+  const lowercaseMethod = method.toLowerCase() as 'get' | 'post' | 'put' | 'delete' | 'patch';
+
+  const res = await http[lowercaseMethod]<T>(pathname, options);
+
+  if (isCachable(fetchOptions)) {
+    cache.set(cacheKey, res);
+  }
+
+  return res;
+}
+
+// only cache items that has a time range with `start` and `end` params,
+// and where `end` is not a timestamp in the future
+function isCachable(fetchOptions: FetchOptions) {
+  if (fetchOptions.isCachable !== undefined) {
+    return fetchOptions.isCachable;
+  }
+
+  if (!(fetchOptions.query && fetchOptions.query.start && fetchOptions.query.end)) {
+    return false;
+  }
+
+  return (
+    isString(fetchOptions.query.end) && new Date(fetchOptions.query.end).getTime() < Date.now()
+  );
+}
+
+// order the options object to make sure that two objects with the same arguments, produce produce the
+// same cache key regardless of the order of properties
+function getCacheKey(options: FetchOptions) {
+  const { pathname, method, body, query, headers } = options;
+  return hash({ pathname, method, body, query, headers });
+}

src/platform/packages/shared/kbn-apm-api-shared/src/cps_feature_flag.ts

@@ -0,0 +1,17 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+/** Use with `feature_flags.overrides` in kibana.yml to toggle CPS integration for APM. */
+export const OBSERVABILITY_APM_CPS_ENABLED_FEATURE_FLAG = 'observability.apm.cpsEnabled' as const;
+
+/**
+ * Fallback when the flag is unset and no override exists (same default as the removed
+ * `xpack.apm.featureFlags.apmCPSEnabled` setting).
+ */
+export const OBSERVABILITY_APM_CPS_ENABLED_DEFAULT = true;

src/platform/packages/shared/kbn-apm-api-shared/src/create_call_apm_api.ts

@@ -0,0 +1,84 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import type { CoreStart } from '@kbn/core/public';
+import type { EndpointOf, ReturnOf } from '@kbn/server-route-repository-utils';
+import { formatRequest } from '@kbn/server-route-repository-utils';
+import { type RouteRepositoryClient } from '@kbn/server-route-repository';
+import type { HttpFetchOptions } from '@kbn/core/public';
+import type { ICPSManager } from '@kbn/cps-utils';
+import type { SharedAPMRouteRepository } from './routes';
+import type { CallApi } from './call_api';
+import { callApi } from './call_api';
+import {
+  OBSERVABILITY_APM_CPS_ENABLED_DEFAULT,
+  OBSERVABILITY_APM_CPS_ENABLED_FEATURE_FLAG,
+} from './cps_feature_flag';
+
+export type FetchOptions = Omit<HttpFetchOptions, 'body'> & {
+  pathname: string;
+  isCachable?: boolean;
+  method?: string;
+  body?: any;
+};
+
+type APMClientOptions = Omit<FetchOptions, 'query' | 'body' | 'pathname' | 'signal'> & {
+  signal: AbortSignal | null;
+};
+
+export type APMClientV2 = RouteRepositoryClient<
+  SharedAPMRouteRepository,
+  APMClientOptions
+>['fetch'];
+
+export type AutoAbortedAPMClientV2 = RouteRepositoryClient<
+  SharedAPMRouteRepository,
+  Omit<APMClientOptions, 'signal'>
+>['fetch'];
+
+type APIEndpoint = EndpointOf<SharedAPMRouteRepository>;
+
+export type APIReturnType<TEndpoint extends APIEndpoint> = ReturnOf<
+  SharedAPMRouteRepository,
+  TEndpoint
+>;
+
+interface Dependencies {
+  cpsManager?: ICPSManager;
+}
+
+export function createCallApmApiV2(
+  core: CoreStart,
+  { cpsManager }: Dependencies = {}
+): APMClientV2 {
+  return ((endpoint, options) => {
+    const { params } = options as unknown as {
+      params?: Partial<Record<string, any>>;
+    };
+
+    const { method, pathname, version } = formatRequest(endpoint, params?.path);
+    const isCpsEnabled = core.featureFlags.getBooleanValue(
+      OBSERVABILITY_APM_CPS_ENABLED_FEATURE_FLAG,
+      OBSERVABILITY_APM_CPS_ENABLED_DEFAULT
+    );
+    const projectRouting = isCpsEnabled ? cpsManager?.getProjectRouting() : undefined;
+
+    return callApi(core, {
+      ...options,
+      method,
+      pathname,
+      body: params?.body,
+      query: params?.query,
+      version,
+      headers: {
+        ...(options as any)?.headers,
+        ...(projectRouting ? { 'x-project-routing': projectRouting } : {}),
+      },
+    } as unknown as Parameters<CallApi>[1]);
+  }) as APMClientV2;
+}

src/platform/packages/shared/kbn-apm-api-shared/src/default_api_types.ts

@@ -0,0 +1,83 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import * as t from 'io-ts';
+import { either } from 'fp-ts/Either';
+import { isoToEpochRt, toNumberRt } from '@kbn/io-ts-utils';
+import type { BoolQuery } from '@kbn/es-query';
+import { ApmDocumentType, RollupInterval } from '@kbn/apm-types';
+
+export const rangeRt = t.type({
+  start: isoToEpochRt,
+  end: isoToEpochRt,
+});
+
+export const kueryRt = t.type({ kuery: t.string });
+
+export const probabilityRt = t.type({
+  probability: toNumberRt,
+});
+
+export const offsetRt = t.partial({
+  offset: t.string,
+});
+
+export const serviceTransactionDataSourceRt = t.type({
+  documentType: t.union([
+    t.literal(ApmDocumentType.ServiceTransactionMetric),
+    t.literal(ApmDocumentType.TransactionMetric),
+    t.literal(ApmDocumentType.TransactionEvent),
+  ]),
+  rollupInterval: t.union([
+    t.literal(RollupInterval.OneMinute),
+    t.literal(RollupInterval.TenMinutes),
+    t.literal(RollupInterval.SixtyMinutes),
+    t.literal(RollupInterval.None),
+  ]),
+});
+
+export const transactionDataSourceRt = t.type({
+  documentType: t.union([
+    t.literal(ApmDocumentType.TransactionMetric),
+    t.literal(ApmDocumentType.TransactionEvent),
+  ]),
+  rollupInterval: t.union([
+    t.literal(RollupInterval.OneMinute),
+    t.literal(RollupInterval.TenMinutes),
+    t.literal(RollupInterval.SixtyMinutes),
+    t.literal(RollupInterval.None),
+  ]),
+});
+
+const BoolQueryRt = t.type({
+  should: t.array(t.record(t.string, t.unknown)),
+  must: t.array(t.record(t.string, t.unknown)),
+  must_not: t.array(t.record(t.string, t.unknown)),
+  filter: t.array(t.record(t.string, t.unknown)),
+});
+
+export const filtersRt = new t.Type<BoolQuery, string, unknown>(
+  'BoolQuery',
+  BoolQueryRt.is,
+  (input: unknown, context: t.Context) =>
+    either.chain(t.string.validate(input, context), (value: string) => {
+      try {
+        const filters = JSON.parse(value);
+        const decoded = {
+          should: [],
+          must: [],
+          must_not: filters.must_not ? [...filters.must_not] : [],
+          filter: filters.filter ? [...filters.filter] : [],
+        };
+        return t.success(decoded);
+      } catch (err) {
+        return t.failure(input, context, err.message);
+      }
+    }),
+  (filters: BoolQuery): string => JSON.stringify(filters)
+);

src/platform/packages/shared/kbn-apm-api-shared/src/mock_create_call_apm_api.ts

@@ -0,0 +1,18 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import type { CoreStart } from '@kbn/core/public';
+import { createCallApmApiV2 } from './create_call_apm_api';
+
+const coreMock = {
+  featureFlags: { getBooleanValue: () => false },
+} as unknown as CoreStart;
+
+export function mockCreateCallApmApiV2(core: CoreStart = {} as CoreStart) {
+  return createCallApmApiV2({ ...coreMock, ...core });
+}