@sophonz/node-sdk 0.0.1

package/build/src/otel-logger/index.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const api_1 = require("@opentelemetry/api");
+const api_logs_1 = require("@opentelemetry/api-logs");
+const core_1 = require("@opentelemetry/core");
+const exporter_logs_otlp_http_1 = require("@opentelemetry/exporter-logs-otlp-http");
+const resources_1 = require("@opentelemetry/resources");
+const sdk_logs_1 = require("@opentelemetry/sdk-logs");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+class NoopLogRecordProcessor {
+    onEmit() {
+    }
+    forceFlush() {
+        return Promise.resolve();
+    }
+    shutdown() {
+        return Promise.resolve();
+    }
+}
+const package_json_1 = require("../../package.json");
+const constants_1 = require("../constants");
+const LOG_PREFIX = `⚠️  [LOGGER]`;
+class Logger {
+    constructor({ baseUrl, bufferSize, detectResource = true, headers, queueSize, resourceAttributes, sendIntervalMs, service, timeout, }) {
+        const _serviceName = (0, constants_1.DEFAULT_SERVICE_NAME)();
+        if (!service) {
+            api_1.diag.warn(`${LOG_PREFIX} Service name not found. Use "${_serviceName}"`);
+        }
+        const maxExportBatchSize = bufferSize !== null && bufferSize !== void 0 ? bufferSize : constants_1.DEFAULT_EXPORTER_BATCH_SIZE;
+        let maxQueueSize = queueSize !== null && queueSize !== void 0 ? queueSize : constants_1.DEFAULT_MAX_QUEUE_SIZE;
+        if (maxExportBatchSize > maxQueueSize) {
+            api_1.diag.error(`${LOG_PREFIX} bufferSize must be smaller or equal to queueSize. Setting queueSize to ${maxExportBatchSize}`);
+            maxQueueSize = maxExportBatchSize;
+        }
+        const detectedResource = (0, resources_1.detectResources)({
+            detectors: detectResource
+                ? [resources_1.envDetector, resources_1.hostDetector, resources_1.osDetector, resources_1.processDetector]
+                : [],
+        });
+        this._url = baseUrl !== null && baseUrl !== void 0 ? baseUrl : constants_1.DEFAULT_OTEL_LOGS_EXPORTER_URL;
+        api_1.diag.warn(`${LOG_PREFIX} Sending logs to ${this._url}`);
+        const exporter = new exporter_logs_otlp_http_1.OTLPLogExporter({
+            url: this._url,
+            ...(headers && { headers }),
+        });
+        this.processor = this.isDisabled()
+            ? new NoopLogRecordProcessor()
+            : new sdk_logs_1.BatchLogRecordProcessor(exporter, {
+                maxExportBatchSize,
+                scheduledDelayMillis: sendIntervalMs !== null && sendIntervalMs !== void 0 ? sendIntervalMs : constants_1.DEFAULT_SEND_INTERVAL_MS,
+                exportTimeoutMillis: timeout !== null && timeout !== void 0 ? timeout : constants_1.DEFAULT_EXPORTER_TIMEOUT_MS,
+                maxQueueSize,
+            });
+        this.provider = new sdk_logs_1.LoggerProvider({
+            resource: detectedResource.merge((0, resources_1.resourceFromAttributes)({
+                'sophonz.distro.version': package_json_1.version,
+                [semantic_conventions_1.SEMRESATTRS_SERVICE_NAME]: service !== null && service !== void 0 ? service : _serviceName,
+                ...resourceAttributes,
+            })),
+        });
+        this.logger = this.provider.getLogger('node-logger');
+    }
+    parseTimestamp(meta) {
+        if (Number.isInteger(meta.time)) {
+            return new Date(meta.time);
+        }
+        return new Date();
+    }
+    isDisabled() {
+        return (0, core_1.getStringFromEnv)('OTEL_LOGS_EXPORTER') === 'none';
+    }
+    setGlobalLoggerProvider() {
+        api_1.diag.debug('Setting global logger provider...');
+        api_logs_1.logs.setGlobalLoggerProvider(this.provider);
+    }
+    getExporterUrl() {
+        return this._url;
+    }
+    getProvider() {
+        return this.provider;
+    }
+    getProcessor() {
+        return this.processor;
+    }
+    shutdown() {
+        api_1.diag.debug('Shutting down Sophonz node logger...');
+        return this.processor.shutdown();
+    }
+    forceFlush() {
+        api_1.diag.debug('Forcing flush of Sophonz node logger...');
+        return this.processor.forceFlush();
+    }
+    postMessage(level, body, attributes = {}) {
+        this.logger.emit({
+            severityNumber: 0,
+            severityText: level,
+            body,
+            attributes,
+            timestamp: this.parseTimestamp(attributes),
+        });
+    }
+}
+exports.Logger = Logger;

package/build/src/otel-logger/pino.d.ts

@@ -0,0 +1,37 @@
+import { Attributes } from '@opentelemetry/api';
+import build from 'pino-abstract-transport';
+import type { LoggerOptions } from './';
+export type PinoLogLine = {
+    level: number;
+    time: number;
+    pid: number;
+    hostname: string;
+    msg: string;
+} & Attributes;
+export declare const parsePinoLog: (log: PinoLogLine) => {
+    level: number;
+    message: string;
+    meta: {
+        [attributeKey: string]: import("@opentelemetry/api").AttributeValue;
+        time: number;
+        pid: number;
+        hostname: string;
+    };
+};
+export type SophonzPinoOptions = LoggerOptions & {
+    apiKey?: string;
+    getCustomMeta?: () => Attributes;
+};
+declare const DEFAULT_LOG_KEYS: {
+    traceId: string;
+    spanId: string;
+    traceFlags: string;
+};
+export declare const getMixinFunction: () => {
+    [DEFAULT_LOG_KEYS.traceId]: string;
+    [DEFAULT_LOG_KEYS.spanId]: string;
+    [DEFAULT_LOG_KEYS.traceFlags]: string;
+};
+declare const _default: ({ apiKey, getCustomMeta, ...options }: SophonzPinoOptions) => Promise<import("node:stream").Transform & build.OnUnknown>;
+export default _default;
+//# sourceMappingURL=pino.d.ts.map

package/build/src/otel-logger/pino.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pino.d.ts","sourceRoot":"","sources":["../../../src/otel-logger/pino.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKX,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,MAAM,yBAAyB,CAAC;AAG5C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AAGxC,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb,GAAG,UAAU,CAAC;AAEf,eAAO,MAAM,YAAY,GAAI,KAAK,WAAW;;;;;cANrC,MAAM;aACP,MAAM;kBACD,MAAM;;CAoBjB,CAAC;AAYF,MAAM,MAAM,kBAAkB,GAAG,aAAa,GAAG;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,UAAU,CAAC;CAClC,CAAC;AAGF,QAAA,MAAM,gBAAgB;;;;CAIrB,CAAC;AACF,eAAO,MAAM,gBAAgB;IAYzB,CAAC,gBAAgB,CAAC,OAAO,CAAC,SAAqB;IAC/C,CAAC,gBAAgB,CAAC,MAAM,CAAC,SAAoB;IAC7C,CAAC,gBAAgB,CAAC,UAAU,CAAC,SAA2C;CAE3E,CAAC;yBAEoB,uCAInB,kBAAkB;AAJrB,wBAwCE"}

package/build/src/otel-logger/pino.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMixinFunction = exports.parsePinoLog = void 0;
+const tslib_1 = require("tslib");
+const api_1 = require("@opentelemetry/api");
+const lodash_isstring_1 = tslib_1.__importDefault(require("lodash.isstring"));
+const pino_abstract_transport_1 = tslib_1.__importDefault(require("pino-abstract-transport"));
+const utils_1 = require("../utils");
+const _1 = require("./");
+const parsePinoLog = (log) => {
+    const { level, msg, message, ...meta } = log;
+    const targetMessage = msg || message;
+    let bodyMsg = '';
+    if (targetMessage) {
+        bodyMsg = (0, lodash_isstring_1.default)(targetMessage)
+            ? targetMessage
+            : (0, utils_1.jsonToString)(targetMessage);
+    }
+    else {
+        bodyMsg = (0, utils_1.jsonToString)(log);
+    }
+    return {
+        level,
+        message: bodyMsg,
+        meta,
+    };
+};
+exports.parsePinoLog = parsePinoLog;
+const PINO_LEVELS = {
+    10: 'trace',
+    20: 'debug',
+    30: 'info',
+    40: 'warn',
+    50: 'error',
+    60: 'fatal',
+};
+const DEFAULT_LOG_KEYS = {
+    traceId: 'trace_id',
+    spanId: 'span_id',
+    traceFlags: 'trace_flags',
+};
+const getMixinFunction = () => {
+    const span = api_1.trace.getSpan(api_1.context.active());
+    if (!span) {
+        return {};
+    }
+    const spanContext = span.spanContext();
+    if (!(0, api_1.isSpanContextValid)(spanContext)) {
+        return {};
+    }
+    return {
+        [DEFAULT_LOG_KEYS.traceId]: spanContext.traceId,
+        [DEFAULT_LOG_KEYS.spanId]: spanContext.spanId,
+        [DEFAULT_LOG_KEYS.traceFlags]: `0${spanContext.traceFlags.toString(16)}`,
+    };
+};
+exports.getMixinFunction = getMixinFunction;
+exports.default = async ({ apiKey, getCustomMeta, ...options }) => {
+    try {
+        api_1.diag.debug('Initializing Sophonz pino transport...');
+        const logger = new _1.Logger({
+            ...(apiKey && {
+                headers: {
+                    Authorization: apiKey,
+                },
+            }),
+            ...options,
+        });
+        api_1.diag.debug(`Sophonz pino transport initialized!`);
+        return (0, pino_abstract_transport_1.default)(async function (source) {
+            for await (const obj of source) {
+                const { level, message, meta } = (0, exports.parsePinoLog)(obj);
+                api_1.diag.debug('Sending log to Sophonz');
+                logger.postMessage(PINO_LEVELS[level], message, {
+                    ...getCustomMeta === null || getCustomMeta === void 0 ? void 0 : getCustomMeta(),
+                    ...meta,
+                });
+                api_1.diag.debug('Log sent to Sophonz');
+            }
+        }, {
+            async close(err) {
+                api_1.diag.debug('Sending and closing Sophonz pino transport...');
+                await logger.shutdown();
+                api_1.diag.debug('Sophonz pino transport closed!');
+            },
+        });
+    }
+    catch (err) {
+        api_1.diag.error('createTransport error', err);
+    }
+};

package/build/src/otel-logger/winston.d.ts

@@ -0,0 +1,29 @@
+import { Attributes } from '@opentelemetry/api';
+import Transport from 'winston-transport';
+import type { LoggerOptions } from './';
+export declare const parseWinstonLog: (log: {
+    message: string | Attributes;
+    level: string;
+} & Attributes) => {
+    level: string;
+    message: string;
+    meta: {
+        [attributeKey: string]: import("@opentelemetry/api").AttributeValue;
+    };
+};
+export type SophonzWinstonOptions = LoggerOptions & {
+    apiKey?: string;
+    maxLevel?: string;
+    getCustomMeta?: () => Attributes;
+};
+export default class SophonzWinston extends Transport {
+    private readonly logger;
+    private readonly getCustomMeta;
+    constructor({ maxLevel, getCustomMeta, apiKey, ...options }: SophonzWinstonOptions);
+    log(info: {
+        message: string | Attributes;
+        level: string;
+    } & Attributes, callback: () => void): void;
+    close(): void;
+}
+//# sourceMappingURL=winston.d.ts.map

package/build/src/otel-logger/winston.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"winston.d.ts","sourceRoot":"","sources":["../../../src/otel-logger/winston.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAQ,MAAM,oBAAoB,CAAC;AAGtD,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAG1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AAGxC,eAAO,MAAM,eAAe,GAC1B,KAAK;IACH,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf,GAAG,UAAU;;;;;;CAoBf,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,UAAU,CAAC;CAClC,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAAS;IACnD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiC;gBAEnD,EACV,QAAQ,EACR,aAAa,EACb,MAAM,EACN,GAAG,OAAO,EACX,EAAE,qBAAqB;IAexB,GAAG,CACD,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,UAAU,EAClE,QAAQ,EAAE,MAAM,IAAI;IAmBtB,KAAK;CAaN"}

package/build/src/otel-logger/winston.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseWinstonLog = void 0;
+const tslib_1 = require("tslib");
+const api_1 = require("@opentelemetry/api");
+const lodash_isplainobject_1 = tslib_1.__importDefault(require("lodash.isplainobject"));
+const lodash_isstring_1 = tslib_1.__importDefault(require("lodash.isstring"));
+const winston_transport_1 = tslib_1.__importDefault(require("winston-transport"));
+const utils_1 = require("../utils");
+const _1 = require("./");
+const parseWinstonLog = (log) => {
+    const { level, message, ...attributes } = log;
+    const bodyMsg = (0, lodash_isstring_1.default)(message) ? message : (0, utils_1.jsonToString)(message);
+    let meta = attributes;
+    if ((0, lodash_isplainobject_1.default)(message)) {
+        meta = {
+            ...attributes,
+            ...message,
+        };
+    }
+    return {
+        level,
+        message: bodyMsg,
+        meta,
+    };
+};
+exports.parseWinstonLog = parseWinstonLog;
+class SophonzWinston extends winston_transport_1.default {
+    constructor({ maxLevel, getCustomMeta, apiKey, ...options }) {
+        api_1.diag.debug('Initializing Sophonz winston transport...');
+        super({ level: maxLevel !== null && maxLevel !== void 0 ? maxLevel : 'info' });
+        this.getCustomMeta = getCustomMeta;
+        this.logger = new _1.Logger({
+            ...(apiKey && {
+                headers: {
+                    Authorization: apiKey,
+                },
+            }),
+            ...options,
+        });
+        api_1.diag.debug(`Sophonz winston transport initialized!`);
+    }
+    log(info, callback) {
+        var _a;
+        setImmediate(() => {
+            this.emit('logged', info);
+        });
+        api_1.diag.debug('Received log from winston');
+        const { level, message, meta } = (0, exports.parseWinstonLog)(info);
+        api_1.diag.debug('Sending log to Sophonz');
+        this.logger.postMessage(level, message, {
+            ...(_a = this.getCustomMeta) === null || _a === void 0 ? void 0 : _a.call(this),
+            ...meta,
+        });
+        api_1.diag.debug('Log sent to Sophonz');
+        callback();
+    }
+    close() {
+        api_1.diag.debug('Closing Sophonz winston transport...');
+        this.logger
+            .shutdown()
+            .then(() => {
+            api_1.diag.debug('Sophonz winston transport closed!');
+            this.emit('finish');
+            this.emit('close');
+        })
+            .catch((err) => {
+            api_1.diag.error('Error closing Sophonz winston transport:', err);
+        });
+    }
+}
+exports.default = SophonzWinston;

package/build/src/otel.d.ts

@@ -0,0 +1,29 @@
+import { Attributes } from '@opentelemetry/api';
+import { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';
+import { InstrumentationBase } from '@opentelemetry/instrumentation';
+import { MetricReader } from '@opentelemetry/sdk-metrics';
+export type SDKConfig = {
+    additionalInstrumentations?: InstrumentationBase[];
+    advancedNetworkCapture?: boolean;
+    apiKey?: string;
+    betaMode?: boolean;
+    consoleCapture?: boolean;
+    detectResources?: boolean;
+    disableLogs?: boolean;
+    disableMetrics?: boolean;
+    disableStartupLogs?: boolean;
+    disableTracing?: boolean;
+    enableInternalProfiling?: boolean;
+    experimentalExceptionCapture?: boolean;
+    instrumentations?: InstrumentationConfigMap;
+    metricReader?: MetricReader;
+    programmaticImports?: boolean;
+    sentryIntegrationEnabled?: boolean;
+    service?: string;
+    stopOnTerminationSignals?: boolean;
+};
+export declare const initSDK: (config: SDKConfig) => void;
+export declare const init: (config?: Omit<SDKConfig, "programmaticImports">) => void;
+export declare const shutdown: () => Promise<void>;
+export declare const setTraceAttributes: (attributes: Attributes) => void;
+//# sourceMappingURL=otel.d.ts.map

package/build/src/otel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel.d.ts","sourceRoot":"","sources":["../../src/otel.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAsB,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAEL,wBAAwB,EACzB,MAAM,2CAA2C,CAAC;AAEnD,OAAO,EACL,mBAAmB,EAEpB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AA4C1D,MAAM,MAAM,SAAS,GAAG;IACtB,0BAA0B,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnD,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAC5C,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC,CAAC;AAgGF,eAAO,MAAM,OAAO,GAAI,QAAQ,SAAS,SAmexC,CAAC;AAEF,eAAO,MAAM,IAAI,GAAI,SAAS,IAAI,CAAC,SAAS,EAAE,qBAAqB,CAAC,SAOhE,CAAC;AAmBL,eAAO,MAAM,QAAQ,qBAGpB,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,YAAY,UAAU,SAexD,CAAC"}