@farm.js/otel 0.1.0-beta.25

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Farm.js Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import type { Attributes } from "@opentelemetry/api";
+import { type InstrumentationConfigMap } from "@opentelemetry/auto-instrumentations-node";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import type { Instrumentation } from "@opentelemetry/instrumentation";
+import { type Resource } from "@opentelemetry/resources";
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import { type Sampler, type SpanExporter, type SpanProcessor } from "@opentelemetry/sdk-trace-base";
+export interface FarmOTelOptions {
+    serviceName?: string;
+    serviceVersion?: string;
+    resource?: Resource;
+    resourceAttributes?: Attributes;
+    traceExporter?: SpanExporter;
+    exporter?: ConstructorParameters<typeof OTLPTraceExporter>[0];
+    spanProcessors?: SpanProcessor[];
+    sampler?: Sampler;
+    autoInstrumentations?: boolean;
+    instrumentationConfig?: InstrumentationConfigMap;
+    instrumentations?: Array<Instrumentation | Instrumentation[]>;
+}
+export interface FarmOTelController {
+    sdk: NodeSDK;
+    forceFlush(): Promise<void>;
+    shutdown(): Promise<void>;
+}
+export declare function registerOTel(options?: FarmOTelOptions): Promise<FarmOTelController>;
+export declare function forceFlushOTel(): Promise<void>;
+export declare function shutdownOTel(): Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAEL,KAAK,wBAAwB,EAC9B,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAA0B,KAAK,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAEL,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,aAAa,EACnB,MAAM,+BAA+B,CAAC;AAGvC,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,kBAAkB,CAAC,EAAE,UAAU,CAAC;IAChC,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,QAAQ,CAAC,EAAE,qBAAqB,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,qBAAqB,CAAC,EAAE,wBAAwB,CAAC;IACjD,gBAAgB,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,eAAe,EAAE,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,OAAO,CAAC;IACb,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAgBD,wBAAsB,YAAY,CAAC,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAsD7F;AAED,wBAAsB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAIpD;AAED,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAIlD"}

package/dist/index.js

@@ -0,0 +1,74 @@
+import { getNodeAutoInstrumentations, } from "@opentelemetry/auto-instrumentations-node";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import { resourceFromAttributes } from "@opentelemetry/resources";
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import { BatchSpanProcessor, } from "@opentelemetry/sdk-trace-base";
+import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from "@opentelemetry/semantic-conventions";
+const FARM_OTEL_STATE = Symbol.for("@farm.js/otel/state");
+function getGlobalState() {
+    const target = globalThis;
+    return (target[FARM_OTEL_STATE] ??= {});
+}
+export async function registerOTel(options = {}) {
+    const state = getGlobalState();
+    if (state.controller)
+        return state.controller;
+    if (state.initializing)
+        return state.initializing;
+    state.initializing = Promise.resolve()
+        .then(() => {
+        const defaultResource = resourceFromAttributes({
+            [ATTR_SERVICE_NAME]: options.serviceName ?? process.env.OTEL_SERVICE_NAME ?? "farm-app",
+            ...(options.serviceVersion ? { [ATTR_SERVICE_VERSION]: options.serviceVersion } : {}),
+            ...options.resourceAttributes,
+        });
+        const resource = options.resource ? defaultResource.merge(options.resource) : defaultResource;
+        const spanProcessors = options.spanProcessors ?? [
+            new BatchSpanProcessor(options.traceExporter ?? new OTLPTraceExporter(options.exporter)),
+        ];
+        const instrumentations = options.instrumentations ??
+            (options.autoInstrumentations === false
+                ? []
+                : [getNodeAutoInstrumentations(options.instrumentationConfig)]);
+        const sdk = new NodeSDK({
+            resource,
+            sampler: options.sampler,
+            spanProcessors,
+            instrumentations,
+        });
+        sdk.start();
+        let shutdownPromise;
+        const controller = {
+            sdk,
+            async forceFlush() {
+                await Promise.all(spanProcessors.map((processor) => processor.forceFlush()));
+            },
+            shutdown() {
+                if (!shutdownPromise) {
+                    shutdownPromise = sdk.shutdown().finally(() => {
+                        state.controller = undefined;
+                        state.initializing = undefined;
+                    });
+                }
+                return shutdownPromise;
+            },
+        };
+        state.controller = controller;
+        return controller;
+    })
+        .catch((error) => {
+        state.initializing = undefined;
+        throw error;
+    });
+    return state.initializing;
+}
+export async function forceFlushOTel() {
+    const state = getGlobalState();
+    const controller = state.controller ?? (await state.initializing);
+    await controller?.forceFlush();
+}
+export async function shutdownOTel() {
+    const state = getGlobalState();
+    const controller = state.controller ?? (await state.initializing);
+    await controller?.shutdown();
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@farm.js/otel",
+  "version": "0.1.0-beta.25",
+  "description": "OpenTelemetry SDK setup for Farm.js applications",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/farming-labs/farm.js",
+    "directory": "packages/farm-otel"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "1.9.1",
+    "@opentelemetry/auto-instrumentations-node": "0.79.0",
+    "@opentelemetry/exporter-trace-otlp-http": "0.221.0",
+    "@opentelemetry/instrumentation": "0.221.0",
+    "@opentelemetry/resources": "2.10.0",
+    "@opentelemetry/sdk-node": "0.221.0",
+    "@opentelemetry/sdk-trace-base": "2.10.0",
+    "@opentelemetry/semantic-conventions": "1.43.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.5",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && tsc",
+    "dev": "tsc --watch",
+    "type-check": "tsc --noEmit",
+    "test": "pnpm run build && node --test test/*.test.mjs"
+  }
+}