[Infra] Move apm common types to a package (elastic#189649)

part of [elastic#188752](elastic#188752)

## Summary

Move some types to `kbn-apm-types`. These types will be used later in
the `apm-data-access` plugin
elastic#189654.

---------

Co-authored-by: kibanamachine <[email protected]>

.github/CODEOWNERS

@@ -46,6 +46,7 @@ x-pack/plugins/observability_solution/apm/ftr_e2e @elastic/obs-ux-infra_services
 x-pack/plugins/observability_solution/apm @elastic/obs-ux-infra_services-team
 packages/kbn-apm-synthtrace @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team
 packages/kbn-apm-synthtrace-client @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team
+packages/kbn-apm-types @elastic/obs-ux-infra_services-team
 packages/kbn-apm-utils @elastic/obs-ux-infra_services-team
 test/plugin_functional/plugins/app_link_test @elastic/kibana-core
 x-pack/test/usage_collection/plugins/application_usage_test @elastic/kibana-core

package.json

@@ -181,6 +181,7 @@
     "@kbn/apm-data-access-plugin": "link:x-pack/plugins/observability_solution/apm_data_access",
     "@kbn/apm-data-view": "link:packages/kbn-apm-data-view",
     "@kbn/apm-plugin": "link:x-pack/plugins/observability_solution/apm",
+    "@kbn/apm-types": "link:packages/kbn-apm-types",
     "@kbn/apm-utils": "link:packages/kbn-apm-utils",
     "@kbn/app-link-test-plugin": "link:test/plugin_functional/plugins/app_link_test",
     "@kbn/application-usage-test-plugin": "link:x-pack/test/usage_collection/plugins/application_usage_test",

packages/kbn-apm-types/es_fields.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './src/es_fields/apm';

packages/kbn-apm-types/es_schemas_raw.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+export * from './src/es_schemas/raw';
+export * from './src/es_schemas/raw/fields';

packages/kbn-apm-types/es_schemas_ui.ts

@@ -0,0 +1,10 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './src/es_schemas/ui';
+export * from './src/es_schemas/ui/fields';

packages/kbn-apm-types/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './es_fields';
+export * from './es_schemas_raw';
+export * from './es_schemas_ui';

packages/kbn-apm-types/kibana.jsonc

@@ -0,0 +1,5 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/apm-types",
+  "owner": "@elastic/obs-ux-infra_services-team"
+}

packages/kbn-apm-types/package.json

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

packages/kbn-apm-types/src/es_fields/apm.ts

@@ -0,0 +1,197 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+export const TIMESTAMP = 'timestamp.us';
+export const AGENT = 'agent';
+export const AGENT_NAME = 'agent.name';
+export const AGENT_VERSION = 'agent.version';
+export const AGENT_ACTIVATION_METHOD = 'agent.activation_method';
+
+export const DESTINATION_ADDRESS = 'destination.address';
+
+export const CLOUD = 'cloud';
+export const CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone';
+export const CLOUD_PROVIDER = 'cloud.provider';
+export const CLOUD_REGION = 'cloud.region';
+export const CLOUD_MACHINE_TYPE = 'cloud.machine.type';
+export const CLOUD_ACCOUNT_ID = 'cloud.account.id';
+export const CLOUD_INSTANCE_ID = 'cloud.instance.id';
+export const CLOUD_INSTANCE_NAME = 'cloud.instance.name';
+export const CLOUD_SERVICE_NAME = 'cloud.service.name';
+
+export const EVENT_SUCCESS_COUNT = 'event.success_count';
+
+export const SERVICE = 'service';
+export const SERVICE_NAME = 'service.name';
+export const SERVICE_ENVIRONMENT = 'service.environment';
+export const SERVICE_FRAMEWORK_NAME = 'service.framework.name';
+export const SERVICE_FRAMEWORK_VERSION = 'service.framework.version';
+export const SERVICE_LANGUAGE_NAME = 'service.language.name';
+export const SERVICE_LANGUAGE_VERSION = 'service.language.version';
+export const SERVICE_RUNTIME_NAME = 'service.runtime.name';
+export const SERVICE_RUNTIME_VERSION = 'service.runtime.version';
+export const SERVICE_NODE_NAME = 'service.node.name';
+export const SERVICE_VERSION = 'service.version';
+export const SERVICE_TARGET_TYPE = 'service.target.type';
+export const SERVICE_OVERFLOW_COUNT = 'service_transaction.aggregation.overflow_count';
+
+export const URL_FULL = 'url.full';
+export const HTTP_REQUEST_METHOD = 'http.request.method';
+export const HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code';
+export const USER_ID = 'user.id';
+export const USER_AGENT_ORIGINAL = 'user_agent.original';
+export const USER_AGENT_NAME = 'user_agent.name';
+
+export const OBSERVER_HOSTNAME = 'observer.hostname';
+export const OBSERVER_LISTENING = 'observer.listening';
+export const PROCESSOR_EVENT = 'processor.event';
+
+export const TRANSACTION_DURATION = 'transaction.duration.us';
+export const TRANSACTION_DURATION_HISTOGRAM = 'transaction.duration.histogram';
+export const TRANSACTION_DURATION_SUMMARY = 'transaction.duration.summary';
+export const TRANSACTION_TYPE = 'transaction.type';
+export const TRANSACTION_RESULT = 'transaction.result';
+export const TRANSACTION_NAME = 'transaction.name';
+export const TRANSACTION_ID = 'transaction.id';
+export const TRANSACTION_SAMPLED = 'transaction.sampled';
+export const TRANSACTION_PAGE_URL = 'transaction.page.url';
+export const TRANSACTION_FAILURE_COUNT = 'transaction.failure_count';
+export const TRANSACTION_SUCCESS_COUNT = 'transaction.success_count';
+export const TRANSACTION_OVERFLOW_COUNT = 'transaction.aggregation.overflow_count';
+// for transaction metrics
+export const TRANSACTION_ROOT = 'transaction.root';
+export const TRANSACTION_PROFILER_STACK_TRACE_IDS = 'transaction.profiler_stack_trace_ids';
+
+export const EVENT_OUTCOME = 'event.outcome';
+
+export const TRACE_ID = 'trace.id';
+
+export const SPAN_DURATION = 'span.duration.us';
+export const SPAN_TYPE = 'span.type';
+export const SPAN_SUBTYPE = 'span.subtype';
+export const SPAN_SELF_TIME_SUM = 'span.self_time.sum.us';
+export const SPAN_ACTION = 'span.action';
+export const SPAN_NAME = 'span.name';
+export const SPAN_ID = 'span.id';
+export const SPAN_DESTINATION_SERVICE_RESOURCE = 'span.destination.service.resource';
+export const SPAN_DESTINATION_SERVICE_RESPONSE_TIME_COUNT =
+  'span.destination.service.response_time.count';
+
+export const SPAN_DESTINATION_SERVICE_RESPONSE_TIME_SUM =
+  'span.destination.service.response_time.sum.us';
+
+export const SPAN_LINKS = 'span.links';
+export const SPAN_LINKS_TRACE_ID = 'span.links.trace.id';
+export const SPAN_LINKS_SPAN_ID = 'span.links.span.id';
+
+export const SPAN_COMPOSITE_COUNT = 'span.composite.count';
+export const SPAN_COMPOSITE_SUM = 'span.composite.sum.us';
+export const SPAN_COMPOSITE_COMPRESSION_STRATEGY = 'span.composite.compression_strategy';
+
+export const SPAN_SYNC = 'span.sync';
+
+// Parent ID for a transaction or span
+export const PARENT_ID = 'parent.id';
+
+export const ERROR_ID = 'error.id';
+export const ERROR_GROUP_ID = 'error.grouping_key';
+export const ERROR_GROUP_NAME = 'error.grouping_name';
+export const ERROR_CULPRIT = 'error.culprit';
+export const ERROR_LOG_LEVEL = 'error.log.level';
+export const ERROR_LOG_MESSAGE = 'error.log.message';
+export const ERROR_EXCEPTION = 'error.exception';
+export const ERROR_EXC_MESSAGE = 'error.exception.message'; // only to be used in es queries, since error.exception is now an array
+export const ERROR_EXC_HANDLED = 'error.exception.handled'; // only to be used in es queries, since error.exception is now an array
+export const ERROR_EXC_TYPE = 'error.exception.type';
+export const ERROR_PAGE_URL = 'error.page.url';
+export const ERROR_TYPE = 'error.type';
+
+// METRICS
+export const METRIC_SYSTEM_FREE_MEMORY = 'system.memory.actual.free';
+export const METRIC_SYSTEM_TOTAL_MEMORY = 'system.memory.total';
+export const METRIC_SYSTEM_CPU_PERCENT = 'system.cpu.total.norm.pct';
+export const METRIC_PROCESS_CPU_PERCENT = 'system.process.cpu.total.norm.pct';
+export const METRIC_CGROUP_MEMORY_LIMIT_BYTES = 'system.process.cgroup.memory.mem.limit.bytes';
+export const METRIC_CGROUP_MEMORY_USAGE_BYTES = 'system.process.cgroup.memory.mem.usage.bytes';
+
+export const METRIC_JAVA_HEAP_MEMORY_MAX = 'jvm.memory.heap.max';
+export const METRIC_JAVA_HEAP_MEMORY_COMMITTED = 'jvm.memory.heap.committed';
+export const METRIC_JAVA_HEAP_MEMORY_USED = 'jvm.memory.heap.used';
+export const METRIC_JAVA_NON_HEAP_MEMORY_MAX = 'jvm.memory.non_heap.max';
+export const METRIC_JAVA_NON_HEAP_MEMORY_COMMITTED = 'jvm.memory.non_heap.committed';
+export const METRIC_JAVA_NON_HEAP_MEMORY_USED = 'jvm.memory.non_heap.used';
+export const METRIC_JAVA_THREAD_COUNT = 'jvm.thread.count';
+export const METRIC_JAVA_GC_COUNT = 'jvm.gc.count';
+export const METRIC_JAVA_GC_TIME = 'jvm.gc.time';
+
+export const METRICSET_NAME = 'metricset.name';
+export const METRICSET_INTERVAL = 'metricset.interval';
+
+export const LABEL_NAME = 'labels.name';
+export const LABEL_GC = 'labels.gc';
+export const LABEL_TYPE = 'labels.type';
+export const LABEL_TELEMETRY_AUTO_VERSION = 'labels.telemetry_auto_version';
+export const LABEL_LIFECYCLE_STATE = 'labels.lifecycle_state';
+
+export const HOST = 'host';
+export const HOST_HOSTNAME = 'host.hostname'; // Do not use. Please use `HOST_NAME` instead.
+export const HOST_NAME = 'host.name';
+export const HOST_OS_PLATFORM = 'host.os.platform';
+export const HOST_ARCHITECTURE = 'host.architecture';
+export const HOST_OS_VERSION = 'host.os.version';
+
+export const CONTAINER_ID = 'container.id';
+export const CONTAINER = 'container';
+export const CONTAINER_IMAGE = 'container.image.name';
+
+export const KUBERNETES = 'kubernetes';
+export const KUBERNETES_POD_NAME = 'kubernetes.pod.name';
+export const KUBERNETES_POD_UID = 'kubernetes.pod.uid';
+
+export const FAAS_ID = 'faas.id';
+export const FAAS_NAME = 'faas.name';
+export const FAAS_COLDSTART = 'faas.coldstart';
+export const FAAS_TRIGGER_TYPE = 'faas.trigger.type';
+export const FAAS_DURATION = 'faas.duration';
+export const FAAS_COLDSTART_DURATION = 'faas.coldstart_duration';
+export const FAAS_BILLED_DURATION = 'faas.billed_duration';
+
+// OpenTelemetry Metrics
+export const METRIC_OTEL_SYSTEM_CPU_UTILIZATION = 'system.cpu.utilization';
+export const METRIC_OTEL_SYSTEM_MEMORY_UTILIZATION = 'system.memory.utilization';
+
+export const METRIC_OTEL_JVM_PROCESS_CPU_PERCENT = 'process.runtime.jvm.cpu.utilization';
+export const METRIC_OTEL_JVM_PROCESS_MEMORY_USAGE = 'process.runtime.jvm.memory.usage';
+export const METRIC_OTEL_JVM_PROCESS_MEMORY_COMMITTED = 'process.runtime.jvm.memory.committed';
+export const METRIC_OTEL_JVM_PROCESS_MEMORY_LIMIT = 'process.runtime.jvm.memory.limit';
+export const METRIC_OTEL_JVM_PROCESS_THREADS_COUNT = 'process.runtime.jvm.threads.count';
+export const METRIC_OTEL_JVM_SYSTEM_CPU_PERCENT = 'process.runtime.jvm.system.cpu.utilization';
+export const METRIC_OTEL_JVM_GC_DURATION = 'process.runtime.jvm.gc.duration';
+export const VALUE_OTEL_JVM_PROCESS_MEMORY_HEAP = 'heap';
+export const VALUE_OTEL_JVM_PROCESS_MEMORY_NON_HEAP = 'non_heap';
+
+// Metadata
+export const TIER = '_tier';
+export const INDEX = '_index';
+export const DATA_STEAM_TYPE = 'data_stream.type';
+
+// Mobile
+export const NETWORK_CONNECTION_TYPE = 'network.connection.type';
+export const DEVICE_MODEL_IDENTIFIER = 'device.model.identifier';
+export const SESSION_ID = 'session.id';
+export const APP_LAUNCH_TIME = 'application.launch.time';
+export const EVENT_NAME = 'event.name';
+
+// Location
+export const CLIENT_GEO_COUNTRY_ISO_CODE = 'client.geo.country_iso_code';
+export const CLIENT_GEO_REGION_ISO_CODE = 'client.geo.region_iso_code';
+export const CLIENT_GEO_COUNTRY_NAME = 'client.geo.country_name';
+export const CLIENT_GEO_CITY_NAME = 'client.geo.city_name';
+export const CLIENT_GEO_REGION_NAME = 'client.geo.region_name';
+
+export const CHILD_ID = 'child.id';

packages/kbn-apm-types/src/es_schemas/raw/apm_base_doc.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import { Observer } from './fields/observer';
+
+// all documents types extend APMBaseDoc and inherit all properties
+export interface APMBaseDoc {
+  '@timestamp': string;
+  agent: {
+    name: string;
+    version: string;
+  };
+  parent?: { id: string }; // parent ID is not available on root transactions
+  trace?: { id: string };
+  labels?: {
+    [key: string]: string | number | boolean;
+  };
+  observer?: Observer;
+}

packages/kbn-apm-types/src/es_schemas/raw/error_raw.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import { APMBaseDoc } from './apm_base_doc';
+import {
+  Container,
+  Host,
+  Http,
+  Kubernetes,
+  Page,
+  Process,
+  Service,
+  Stackframe,
+  TimestampUs,
+  Url,
+  User,
+} from './fields';
+
+export interface Processor {
+  name: 'error';
+  event: 'error';
+}
+
+export interface Exception {
+  attributes?: {
+    response?: string;
+  };
+  code?: string;
+  message?: string; // either message or type are given
+  type?: string;
+  module?: string;
+  handled?: boolean;
+  stacktrace?: Stackframe[];
+}
+
+export interface Log {
+  message: string;
+  stacktrace?: Stackframe[];
+}
+
+export interface ErrorRaw extends APMBaseDoc {
+  processor: Processor;
+  timestamp: TimestampUs;
+  transaction?: {
+    id: string;
+    sampled?: boolean;
+    type: string;
+  };
+  error: {
+    id: string;
+    culprit?: string;
+    grouping_key: string;
+    // either exception or log are given
+    exception?: Exception[];
+    page?: Page; // special property for RUM: shared by error and transaction
+    log?: Log;
+    stack_trace?: string;
+    custom?: Record<string, unknown>;
+  };
+
+  // Shared by errors and transactions
+  container?: Container;
+  host?: Host;
+  http?: Http;
+  kubernetes?: Kubernetes;
+  process?: Process;
+  service: Service;
+  url?: Url;
+  user?: User;
+}

packages/kbn-apm-types/src/es_schemas/raw/event_raw.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 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 or the Server
+ * Side Public License, v 1.
+ */
+
+import { APMBaseDoc } from './apm_base_doc';
+import { TimestampUs } from './fields/timestamp_us';
+
+export interface EventRaw extends APMBaseDoc {
+  timestamp: TimestampUs;
+  transaction?: {
+    id: string;
+    sampled?: boolean;
+    type: string;
+  };
+  log: {
+    message?: string;
+  };
+  event: {
+    action: string;
+    category: string;
+  };
+}