Chore/update telemetry mapper

packages/cli/.npmrc

@@ -0,0 +1 @@
+@redocly:registry=http://3.236.85.158:8000/

packages/cli/package.json

@@ -38,6 +38,7 @@
     "Roman Hotsiy <roman@redocly.com> (https://redocly.com/)"
   ],
   "dependencies": {
+    "@redocly/cli-otel": "0.0.0-20260225145457",
     "@opentelemetry/exporter-trace-otlp-http": "0.202.0",
     "@opentelemetry/resources": "2.0.1",
     "@opentelemetry/sdk-trace-node": "2.0.1",
@@ -68,7 +69,6 @@
     "yargs": "17.0.1"
   },
   "devDependencies": {
-    "@redocly/cli-otel": "^0.0.4",
     "@types/cookie": "0.6.0",
     "@types/har-format": "^1.2.16",
     "@types/pluralize": "^0.0.29",

packages/cli/src/utils/__tests__/otel-attributes.test.ts

@@ -0,0 +1,46 @@
+import type { CloudEvents } from '@redocly/cli-otel';
+
+import { processCloudEventAttributes } from '../otel-attributes.js';
+
+const TEST_EVENT: CloudEvents.cloudEvents.CloudEventMapperResult = {
+  id: 'evt_001',
+  type: 'com.example.action',
+  specversion: '1.0',
+  datacontenttype: 'application/json',
+  source: 'com.example',
+  origin: 'example-service',
+  object: 'event',
+  osPlatform: 'linux',
+  time: '2024-01-01T00:00:00.000Z',
+  actor: { id: 'ann_001', object: 'user', uri: '' },
+  subjects: [{ id: 'sub_001', object: 'action.performed', uri: '' }],
+  data: {
+    object: 'action',
+    name: 'do-something',
+    exit_code: 0,
+    version: '1.0.0',
+  },
+};
+
+const TEST_TIME = new Date('2024-01-01T00:00:00.000Z');
+
+describe('processCloudEventAttributes', () => {
+  it('maps CloudEvent fields to OTEL attributes', () => {
+    const attrs = processCloudEventAttributes(TEST_EVENT, TEST_TIME);
+
+    expect(attrs).toMatchObject({
+      'cloudevents.event_id': 'evt_001',
+      'cloudevents.event_type': 'com.example.action',
+      'cloudevents.event_source': 'com.example',
+      'cloudevents.event_time': TEST_TIME.toISOString(),
+      'cloudevents.event_actor.id': 'ann_001',
+      'cloudevents.event_os_platform': 'linux',
+      'cloudevents.event_data.action.object': 'action',
+      'cloudevents.event_data.action.name': 'do-something',
+      'cloudevents.event_data.action.exit_code': 0,
+      'cloudevents.event_data.action.version': '1.0.0',
+      'cloudevents.subjects.action.performed.id': 'sub_001',
+      'cloudevents.subjects.action.performed.object': 'action.performed',
+    });
+  });
+});

packages/cli/src/utils/otel.ts

@@ -2,7 +2,7 @@ import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
 import { resourceFromAttributes } from '@opentelemetry/resources';
 import { NodeTracerProvider, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-node';
 import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-import type { CloudEvents } from '@redocly/cli-otel';
+import { CloudEvents } from '@redocly/cli-otel';
 import { ulid } from 'ulid';
 
 import { OTEL_TRACES_URL, DEFAULT_FETCH_TIMEOUT } from './constants.js';
@@ -30,40 +30,12 @@ export class OtelServerTelemetry {
     });
   }
 
-  send(cloudEvent: CloudEvents.Messages): void {
+  send(cloudEvent: CloudEvents.cloudEvents.CloudEventMapperResult): void {
     const time = cloudEvent.time ? new Date(cloudEvent.time) : new Date();
     const tracer = this.nodeTracerProvider.getTracer('CliTelemetry');
-    const spanName = `event.${cloudEvent.data.command}`;
 
-    const attributes: Record<string, string | number | boolean | undefined> = {
-      'cloudevents.event_id': cloudEvent.id,
-      'cloudevents.event_type': cloudEvent.type,
-      'cloudevents.event_source': cloudEvent.source,
-      'cloudevents.event_spec_version': cloudEvent.specversion,
-      'cloudevents.productType': cloudEvent.productType,
-      'cloudevents.event_data_content_type':
-        cloudEvent.datacontenttype || 'application/json; charset=utf-8',
-      'cloudevents.event_time': time.toISOString(),
-      'cloudevents.event_version': '1.0.0',
-      'cloudevents.origin': cloudEvent.origin,
-      'cloudevents.project.id': '',
-      'cloudevents.project.slug': '',
-      'cloudevents.organization.id': '',
-      'cloudevents.organization.slug': '',
-      'cloudevents.event_origin': cloudEvent.productType,
-      'cloudevents.event_source_details.id': cloudEvent.sourceDetails?.id ?? `ann_${ulid()}`,
-      'cloudevents.event_source_details.object': cloudEvent.sourceDetails?.object ?? 'anonymous',
-      'cloudevents.event_source_details.uri': cloudEvent.sourceDetails?.uri ?? '',
-      'cloudevents.event_data.os_platform': cloudEvent.os_platform,
-      'cloudevents.event_data.environment': cloudEvent.environment,
-    };
-
-    for (const [key, value] of Object.entries(cloudEvent.data)) {
-      const keySnakeCase = key.replace(/([A-Z])/g, '_$1').toLowerCase();
-      if (value !== undefined) {
-        attributes[`cloudevents.event_data.${keySnakeCase}`] = value;
-      }
-    }
+    const spanName = `event.${cloudEvent.type}`;
+    const attributes = CloudEvents.processCloudEventAttributes(cloudEvent, time);
 
     const span = tracer.startSpan(spanName, {
       attributes,

packages/cli/src/utils/telemetry.ts

@@ -1,6 +1,11 @@
-import type { CloudEvents, EventPayload, EventType } from '@redocly/cli-otel';
-import { isAbsoluteUrl, isPlainObject } from '@redocly/openapi-core';
-import type { ArazzoDefinition, Config, Exact } from '@redocly/openapi-core';
+import { CloudEvents, type EventPayload, type EventType } from '@redocly/cli-otel';
+import {
+  isAbsoluteUrl,
+  isPlainObject,
+  type ArazzoDefinition,
+  type Config,
+  type Exact,
+} from '@redocly/openapi-core';
 import { execSync } from 'node:child_process';
 import * as fs from 'node:fs';
 import { existsSync, writeFileSync, readFileSync } from 'node:fs';
@@ -64,55 +69,43 @@ export async function sendTelemetry({
       cacheAnonymousId(anonymous_id);
     }
 
-    const eventData: EventPayload<EventType> = {
-      id: 'cli-command-run',
-      object: 'command',
-      logged_in: logged_in ? 'yes' : 'no',
-      command: `${command}`,
-      ...cleanArgs(args, process.argv.slice(2)),
-      node_version: process.version,
-      npm_version: execSync('npm -v').toString().replace('\n', ''),
-      version,
-      exit_code,
-      execution_time,
-      metadata: process.env.REDOCLY_CLI_TELEMETRY_METADATA,
-      environment_ci: process.env.CI,
-      has_config: typeof config?.document?.parsed === 'undefined' ? 'no' : 'yes',
-      spec_version,
-      spec_keyword,
-      spec_full_version,
-      respect_x_security_auth_types:
-        spec_version === 'arazzo1' && respect_x_security_auth_types?.length
-          ? JSON.stringify(respect_x_security_auth_types)
-          : undefined,
-    };
+    const eventData: EventPayload<EventType> = [
+      {
+        id: 'cli-command-run',
+        object: 'command',
+        uri: 'urn:redocly:cli',
+        logged_in: logged_in ? 'yes' : 'no',
+        command: `${command}`,
+        ...cleanArgs(args, process.argv.slice(2)),
+        node_version: process.version,
+        npm_version: execSync('npm -v').toString().replace('\n', ''),
+        version,
+        exit_code,
+        execution_time,
+        metadata: process.env.REDOCLY_CLI_TELEMETRY_METADATA,
+        environment_ci: process.env.CI,
+        has_config: typeof config?.document?.parsed === 'undefined' ? 'no' : 'yes',
+        spec_version,
+        spec_keyword,
+        spec_full_version,
+        respect_x_security_auth_types:
+          spec_version === 'arazzo1' && respect_x_security_auth_types?.length
+            ? JSON.stringify(respect_x_security_auth_types)
+            : undefined,
+      },
+    ];
 
-    const cloudEvent: CloudEvents.CommandRanMessage = {
-      id: `evt_${ulid()}`,
-      time: new Date().toISOString(),
-      type: 'command.ran',
-      object: 'event',
-      specversion: '1.0',
-      datacontenttype: 'application/json',
-      source: 'com.redocly.cli',
-      origin: 'cli',
-      productType: 'redocly-cli',
-      os_platform: os.platform(),
-      subjects: [
-        {
-          id: ulid(),
-          object: 'command.ran',
-          uri: '',
-        },
-      ],
-      environment: process.env.REDOCLY_ENVIRONMENT,
-      sourceDetails: {
+    const cloudEvent = CloudEvents.cloudEvents.mapToCloudEvent({
+      type: 'com.redocly.command.ran',
+      data: eventData,
+      actor: {
         id: anonymous_id,
         object: 'user',
         uri: '',
       },
-      data: eventData,
-    };
+      // TODO: FIX
+      osPlatform: os.platform(),
+    });
 
     const { otelTelemetry } = await import('./otel.js');
     otelTelemetry.send(cloudEvent);