@multiplayer-app/session-recorder-node 1.2.1 → 1.2.3

package/examples/cli/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "cli-example",
+  "version": "1.0.0",
+  "description": "CLI demo",
+  "author": {
+    "name": "Multiplayer Software, Inc.",
+    "url": "https://www.multiplayer.app"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "engines": {
+    "node": ">=18",
+    "npm": ">=8"
+  },
+  "keywords": [
+    "multiplayer",
+    "debugger",
+    "platform",
+    "platform debugger",
+    "session recorder",
+    "otlp",
+    "fullstack session recorder"
+  ],
+  "scripts": {
+    "start": "node dist/index.js",
+    "dev": "ts-node src/index.ts",
+    "build": "npm run clean && npm run compile",
+    "clean": "rm -rf ./dist",
+    "compile": "tsc --build --force",
+    "lint": "eslint src/**/*.ts --config ../../.eslintrc"
+  },
+  "dependencies": {
+    "@multiplayer-app/session-recorder-common": "1.2.2",
+    "@opentelemetry/api": "1.9.0",
+    "@opentelemetry/api-logs": "0.203.0",
+    "@opentelemetry/auto-instrumentations-node": "0.62.1",
+    "@opentelemetry/core": "2.0.1",
+    "@opentelemetry/exporter-trace-otlp-http": "0.203.0",
+    "@opentelemetry/exporter-logs-otlp-http": "0.203.0",
+    "@opentelemetry/resources": "2.0.1",
+    "@opentelemetry/sdk-logs": "0.203.0",
+    "@opentelemetry/sdk-trace-base": "2.0.1",
+    "@opentelemetry/sdk-trace-node": "2.0.1",
+    "@opentelemetry/semantic-conventions": "1.36.0",
+    "axios": "^1.10.0",
+    "to-json-schema": "^0.2.5"
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.4",
+    "@types/node": "20.5.7",
+    "@types/restify-errors": "4.3.5",
+    "eslint": "8.48.0",
+    "ts-node": "10.9.1",
+    "typescript": "5.7.3"
+  }
+}

package/examples/cli/src/config.ts

@@ -0,0 +1,47 @@
+export const NODE_ENV = process.env.NODE_ENV || 'development'
+export const isProduction = NODE_ENV === 'production'
+
+export const LOG_LEVEL = process.env.LOG_LEVEL || (isProduction ? 'info' : 'debug')
+
+export const COMPONENT_NAME = process.env.npm_package_name?.split('/').pop() as string || process.env.SERVICE_NAME || 'timegate'
+export const COMPONENT_VERSION = process.env.npm_package_version || '0.0.1'
+export const ENVIRONMENT = process.env.ENVIRONMENT || 'staging'
+
+export const MULTIPLAYER_OTLP_KEY = process.env.MULTIPLAYER_OTLP_KEY as string
+
+if (!MULTIPLAYER_OTLP_KEY) {
+  throw new Error('MULTIPLAYER_OTLP_KEY is not set')
+}
+
+export const OTLP_TRACES_ENDPOINT = process.env.OTLP_TRACES_ENDPOINT || 'https://api.multiplayer.app/v1/traces'
+export const OTLP_LOGS_ENDPOINT = process.env.OTLP_LOGS_ENDPOINT || 'https://api.multiplayer.app/v1/logs'
+
+export const MULTIPLAYER_OTLP_SPAN_RATIO = process.env.MULTIPLAYER_OTLP_SPAN_RATIO
+  ? Number(process.env.MULTIPLAYER_OTLP_SPAN_RATIO)
+  : 0.01
+
+export let DIALOGUE_HUB_SERVICE_URL = ''
+export let EPOCH_ENGINE_SERVICE_URL = ''
+export let MINDS_OF_TIME_SERVICE_URL = ''
+export let VAULT_OF_TIME_SERVICE_URL = ''
+
+export const MULTIPLAYER_BACKEND_SOURCE = process.env.MULTIPLAYER_BACKEND_SOURCE || 'production'
+
+switch (process.env.MULTIPLAYER_BACKEND_SOURCE) {
+  case 'production':
+    DIALOGUE_HUB_SERVICE_URL = 'https://api.demo.multiplayer.app/v1/dialogue-hub'
+    EPOCH_ENGINE_SERVICE_URL = 'https://api.demo.multiplayer.app/v1/epoch-engine'
+    MINDS_OF_TIME_SERVICE_URL = 'https://api.demo.multiplayer.app/v1/minds-of-time'
+    VAULT_OF_TIME_SERVICE_URL = 'https://api.demo.multiplayer.app/v1/vault-of-time'
+    break
+  default:
+    DIALOGUE_HUB_SERVICE_URL = 'http://localhost:3000/v1/dialogue-hub'
+    EPOCH_ENGINE_SERVICE_URL = 'http://localhost:3000/v1/epoch-engine'
+    MINDS_OF_TIME_SERVICE_URL = 'http://localhost:3000/v1/minds-of-time'
+    VAULT_OF_TIME_SERVICE_URL = 'http://localhost:3000/v1/vault-of-time'
+}
+
+DIALOGUE_HUB_SERVICE_URL = process.env.DIALOGUE_HUB_SERVICE_URL || DIALOGUE_HUB_SERVICE_URL
+EPOCH_ENGINE_SERVICE_URL = process.env.EPOCH_ENGINE_SERVICE_URL || EPOCH_ENGINE_SERVICE_URL
+MINDS_OF_TIME_SERVICE_URL = process.env.MINDS_OF_TIME_SERVICE_URL || MINDS_OF_TIME_SERVICE_URL
+VAULT_OF_TIME_SERVICE_URL = process.env.VAULT_OF_TIME_SERVICE_URL || VAULT_OF_TIME_SERVICE_URL

package/examples/cli/src/index.ts

@@ -0,0 +1,43 @@
+import { idGenerator } from './opentelemetry'
+import {
+  sessionRecorder,
+  SessionType,
+} from '@multiplayer-app/session-recorder-node'
+import {
+  MULTIPLAYER_OTLP_KEY,
+  ENVIRONMENT,
+  COMPONENT_VERSION,
+  COMPONENT_NAME,
+} from './config'
+
+const main = async () => {
+  sessionRecorder.init({
+    apiKey: MULTIPLAYER_OTLP_KEY,
+    traceIdGenerator: idGenerator,
+    resourceAttributes: {
+      componentName: COMPONENT_NAME,
+      componentVersion: COMPONENT_VERSION,
+      environment: ENVIRONMENT,
+    },
+  })
+
+  await sessionRecorder.start(
+    SessionType.PLAIN,
+    {
+      name: 'Test nodejs cli app debug session',
+      resourceAttributes: {
+        version: 1,
+      },
+    },
+  )
+
+  // do something here
+
+  await sessionRecorder.stop()
+
+  setTimeout(() => {
+    process.exit(0)
+  }, 15000)
+}
+
+main()

package/examples/cli/src/opentelemetry.ts

@@ -0,0 +1,140 @@
+import { hostname } from 'os'
+import { node, NodeSDK } from '@opentelemetry/sdk-node'
+import {
+  BatchSpanProcessor,
+  ParentBasedSampler,
+} from '@opentelemetry/sdk-trace-base'
+import {
+  getNodeAutoInstrumentations,
+  getResourceDetectors,
+} from '@opentelemetry/auto-instrumentations-node'
+import {
+  resourceFromAttributes,
+  detectResources,
+} from '@opentelemetry/resources'
+import {
+  ATTR_SERVICE_NAME,
+  ATTR_SERVICE_VERSION,
+  SEMRESATTRS_HOST_NAME,
+  SEMRESATTRS_DEPLOYMENT_ENVIRONMENT,
+  SEMRESATTRS_PROCESS_RUNTIME_VERSION,
+  SEMRESATTRS_PROCESS_PID,
+} from '@opentelemetry/semantic-conventions'
+import api from '@opentelemetry/api'
+// import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http"
+import { W3CTraceContextPropagator } from '@opentelemetry/core'
+import {
+  SessionRecorderHttpInstrumentationHooksNode,
+  SessionRecorderTraceIdRatioBasedSampler,
+  SessionRecorderIdGenerator,
+  SessionRecorderHttpTraceExporter,
+  SessionRecorderHttpLogsExporter,
+} from '@multiplayer-app/session-recorder-node'
+import { LoggerProvider, BatchLogRecordProcessor } from '@opentelemetry/sdk-logs'
+import * as apiLogs from '@opentelemetry/api-logs'
+// import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http'
+
+import {
+  OTLP_TRACES_ENDPOINT,
+  OTLP_LOGS_ENDPOINT,
+  MULTIPLAYER_OTLP_KEY,
+  MULTIPLAYER_OTLP_SPAN_RATIO,
+  COMPONENT_NAME,
+  COMPONENT_VERSION,
+  ENVIRONMENT,
+} from './config'
+
+// NOTE: Update instrumentation configuration as needed
+// For more see: https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node
+const instrumentations = [
+  getNodeAutoInstrumentations({
+    '@opentelemetry/instrumentation-http': {
+      requestHook: SessionRecorderHttpInstrumentationHooksNode.requestHook({
+        maskHeadersList: ['X-Api-Key'],
+        maxPayloadSizeBytes: 5000,
+        schemifyDocSpanPayload: false,
+        isMaskBodyEnabled: false,
+      }),
+      responseHook: SessionRecorderHttpInstrumentationHooksNode.responseHook({
+        maskHeadersList: ['X-Api-Key'],
+        maxPayloadSizeBytes: 5000,
+        schemifyDocSpanPayload: false,
+        isMaskBodyEnabled: false,
+      }),
+    },
+  }),
+]
+
+const getResource = () => {
+  const resourceWithAttributes = resourceFromAttributes({
+    [ATTR_SERVICE_NAME]: COMPONENT_NAME,
+    [ATTR_SERVICE_VERSION]: COMPONENT_VERSION,
+    [SEMRESATTRS_HOST_NAME]: hostname(),
+    [SEMRESATTRS_DEPLOYMENT_ENVIRONMENT]: ENVIRONMENT,
+    [SEMRESATTRS_PROCESS_RUNTIME_VERSION]: process.version,
+    [SEMRESATTRS_PROCESS_PID]: process.pid,
+  })
+  const detectedResources = detectResources({ detectors: getResourceDetectors() })
+  const resource = resourceWithAttributes.merge(detectedResources)
+
+  return resource
+}
+
+export const idGenerator = new SessionRecorderIdGenerator()
+
+const opentelemetry = () => {
+  // const traceExporter = new OTLPTraceExporter({
+  //   url: OTLP_TRACES_ENDPOINT,
+  //   headers: {
+  //     Authorization: MULTIPLAYER_OTLP_KEY
+  //   },
+  // })
+  const traceExporter = new SessionRecorderHttpTraceExporter({
+    apiKey: MULTIPLAYER_OTLP_KEY,
+    url: OTLP_TRACES_ENDPOINT,
+  })
+
+  const resource = getResource()
+
+  const provider = new node.NodeTracerProvider({
+    resource,
+    spanProcessors: [
+      new BatchSpanProcessor(traceExporter),
+    ],
+    sampler: new ParentBasedSampler({
+      root: new SessionRecorderTraceIdRatioBasedSampler(MULTIPLAYER_OTLP_SPAN_RATIO),
+    }),
+    idGenerator,
+  })
+
+  // const logExporter = new OTLPLogExporter({
+  //   url: OTLP_LOGS_ENDPOINT,
+  //   headers: {
+  //     Authorization: MULTIPLAYER_OTLP_KEY
+  //   },
+  // })
+  const logExporter = new SessionRecorderHttpLogsExporter({
+    apiKey: MULTIPLAYER_OTLP_KEY,
+    url: OTLP_LOGS_ENDPOINT,
+  })
+  const logRecordProcessor = new BatchLogRecordProcessor(logExporter)
+
+  const loggerProvider = new LoggerProvider({
+    resource,
+    processors: [logRecordProcessor],
+  })
+
+  apiLogs.logs.setGlobalLoggerProvider(loggerProvider)
+
+  provider.register()
+  api.trace.setGlobalTracerProvider(provider)
+  api.propagation.setGlobalPropagator(new W3CTraceContextPropagator())
+
+  const sdk = new NodeSDK({
+    instrumentations,
+  })
+
+  sdk.start()
+}
+
+opentelemetry()

package/examples/cli/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "baseUrl": ".",
+    "module": "commonjs",
+    "noImplicitAny": false,
+    "noUnusedParameters": false,
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": false,
+    "preserveConstEnums": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "ES2018",
+    "downlevelIteration": true,
+    "strict": true,
+    "composite": true,
+    "outDir": "./dist/",
+    "rootDir": "./src/",
+    "preserveSymlinks": true
+  },
+  "exclude": ["dist", "coverage", "jest.config.js", "__tests__", "migration"],
+  "references": [],
+  "ts-node": {
+    "files": true
+  }
+}