@lazyapps/observability 0.1.0

package/config.js

@@ -0,0 +1,48 @@
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { MongoDBInstrumentation } from '@opentelemetry/instrumentation-mongodb';
+import { AmqplibInstrumentation } from '@opentelemetry/instrumentation-amqplib';
+import { SocketIoInstrumentation } from '@opentelemetry/instrumentation-socket.io';
+
+const defaults = {
+  serviceName: 'unknown-service',
+  serviceVersion: undefined,
+  environment: undefined,
+  otlp: {
+    endpoint: 'http://localhost:4317',
+    protocol: 'grpc',
+    insecure: true,
+  },
+  traces: true,
+  metrics: true,
+  logs: true,
+  sampler: {
+    type: 'always_on',
+    ratio: 1.0,
+  },
+  diagnosticLogLevel: 'WARN',
+};
+
+const createInstrumentations = () => [
+  new HttpInstrumentation(),
+  new ExpressInstrumentation(),
+  new MongoDBInstrumentation(),
+  new AmqplibInstrumentation(),
+  new SocketIoInstrumentation(),
+];
+
+export const createConfig = (userConfig = {}) => ({
+  ...defaults,
+  ...userConfig,
+  otlp: {
+    ...defaults.otlp,
+    ...(userConfig.otlp || {}),
+  },
+  sampler: {
+    ...defaults.sampler,
+    ...(userConfig.sampler || {}),
+  },
+  instrumentations: userConfig.instrumentations || createInstrumentations(),
+});
+
+export const __testing__ = { defaults, createInstrumentations };

package/exporters.js

@@ -0,0 +1,26 @@
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
+import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc';
+import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-grpc';
+import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
+
+const createOtlpConfig = (config) => ({
+  url: config.otlp.endpoint,
+  timeoutMillis: 5000,
+});
+
+export const createExporters = (config) => {
+  const otlpConfig = createOtlpConfig(config);
+
+  return {
+    trace: config.traces ? new OTLPTraceExporter(otlpConfig) : undefined,
+    metrics: config.metrics
+      ? new PeriodicExportingMetricReader({
+          exporter: new OTLPMetricExporter(otlpConfig),
+          exportIntervalMillis: 15000,
+        })
+      : undefined,
+    logs: config.logs ? new OTLPLogExporter(otlpConfig) : undefined,
+  };
+};
+
+export const __testing__ = { createOtlpConfig };

package/index.js

@@ -0,0 +1,39 @@
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { createConfig } from './config.js';
+import { createResource } from './resource.js';
+import { createExporters } from './exporters.js';
+
+export { createConfig } from './config.js';
+export { createResource } from './resource.js';
+export { createExporters } from './exporters.js';
+
+let initialized = false;
+
+export const isInitialized = () => initialized;
+
+export const __resetForTesting = () => {
+  initialized = false;
+};
+
+export const initialize = (userConfig) => {
+  if (initialized) {
+    return;
+  }
+  initialized = true;
+
+  const config = createConfig(userConfig);
+  const resource = createResource(config);
+  const exporters = createExporters(config);
+
+  const sdk = new NodeSDK({
+    resource,
+    traceExporter: exporters.trace,
+    metricReader: exporters.metrics,
+    logRecordExporter: exporters.logs,
+    instrumentations: config.instrumentations,
+  });
+
+  sdk.start();
+
+  return sdk;
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@lazyapps/observability",
+  "version": "0.1.0",
+  "description": "OpenTelemetry SDK initialization and configuration for the LazyApps framework",
+  "main": "index.js",
+  "files": [
+    "*.js"
+  ],
+  "scripts": {
+    "test": "vitest"
+  },
+  "keywords": [
+    "event-sourcing",
+    "cqrs",
+    "lazyapps",
+    "opentelemetry",
+    "observability",
+    "tracing",
+    "metrics"
+  ],
+  "author": "Oliver Sturm",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oliversturm/lazyapps-libs.git",
+    "directory": "packages/observability"
+  },
+  "bugs": {
+    "url": "https://github.com/oliversturm/lazyapps-libs/issues"
+  },
+  "homepage": "https://github.com/oliversturm/lazyapps-libs/tree/main/packages/observability#readme",
+  "engines": {
+    "node": ">=18.20.3 || >=20.18.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.46.0",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/sdk-node": "^0.211.0",
+    "@opentelemetry/sdk-metrics": "^2.5.0",
+    "@opentelemetry/sdk-logs": "^0.211.0",
+    "@opentelemetry/resources": "^2.5.0",
+    "@opentelemetry/semantic-conventions": "^1.39.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.211.0",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.211.0",
+    "@opentelemetry/exporter-logs-otlp-grpc": "^0.211.0",
+    "@opentelemetry/instrumentation-http": "^0.211.0",
+    "@opentelemetry/instrumentation-express": "^0.59.0",
+    "@opentelemetry/instrumentation-mongodb": "^0.64.0",
+    "@opentelemetry/instrumentation-amqplib": "^0.58.0",
+    "@opentelemetry/instrumentation-socket.io": "^0.57.0"
+  },
+  "type": "module"
+}

package/resource.js

@@ -0,0 +1,16 @@
+import { resourceFromAttributes } from '@opentelemetry/resources';
+import {
+  ATTR_SERVICE_NAME,
+  ATTR_SERVICE_VERSION,
+} from '@opentelemetry/semantic-conventions';
+
+export const createResource = (config) =>
+  resourceFromAttributes({
+    [ATTR_SERVICE_NAME]: config.serviceName,
+    ...(config.serviceVersion && {
+      [ATTR_SERVICE_VERSION]: config.serviceVersion,
+    }),
+    ...(config.environment && {
+      'deployment.environment.name': config.environment,
+    }),
+  });