@moreapp/common-nodejs 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./tracer";
+export * from "./logger";
+export * from "./utils";

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./tracer"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./utils"), exports);

package/dist/logger.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("winston").Logger;

package/dist/logger.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const winston_1 = require("winston");
+const entry_1 = require("@google-cloud/logging/build/src/entry");
+const stackdriverTracingFormat = (0, winston_1.format)((info) => {
+    if (info["trace_id"] && info["span_id"]) {
+        info[entry_1.TRACE_KEY] = info["trace_id"];
+        info[entry_1.SPAN_ID_KEY] = info["span_id"];
+        info[entry_1.TRACE_SAMPLED_KEY] = true;
+    }
+    return info;
+});
+exports.logger = (0, winston_1.createLogger)({
+    level: "info",
+    transports: [new winston_1.transports.Console()],
+    format: winston_1.format.combine(stackdriverTracingFormat(), winston_1.format.json()),
+});

package/dist/tracer.d.ts

@@ -0,0 +1,2 @@
+import * as types from "@opentelemetry/instrumentation/build/src/types";
+export declare const tracer: (serviceName: string, instrumentations: types.Instrumentation[]) => void;

package/dist/tracer.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tracer = void 0;
+const opentelemetry_cloud_trace_exporter_1 = require("@google-cloud/opentelemetry-cloud-trace-exporter");
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const instrumentation_dns_1 = require("@opentelemetry/instrumentation-dns");
+const instrumentation_http_1 = require("@opentelemetry/instrumentation-http");
+const instrumentation_express_1 = require("@opentelemetry/instrumentation-express");
+const instrumentation_winston_1 = require("@opentelemetry/instrumentation-winston");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const resources_1 = require("@opentelemetry/resources");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const propagator_b3_1 = require("@opentelemetry/propagator-b3");
+const utils_1 = require("./utils");
+const tracer = (serviceName, instrumentations) => {
+    const provider = new sdk_trace_node_1.NodeTracerProvider({
+        resource: new resources_1.Resource({
+            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName,
+            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_INSTANCE_ID]: (0, utils_1.environmentVariable)("HOSTNAME", "local"),
+        }),
+    });
+    provider.register({
+        propagator: new propagator_b3_1.B3Propagator({
+            injectEncoding: propagator_b3_1.B3InjectEncoding.MULTI_HEADER,
+        }),
+    });
+    (0, instrumentation_1.registerInstrumentations)({
+        instrumentations: [
+            new instrumentation_dns_1.DnsInstrumentation(),
+            new instrumentation_http_1.HttpInstrumentation({
+                ignoreIncomingRequestHook: (_req) => {
+                    // Disable instrumentation for incoming requests, handled by ExpressInstrumentation below
+                    return true;
+                },
+            }),
+            new instrumentation_express_1.ExpressInstrumentation(),
+            new instrumentation_winston_1.WinstonInstrumentation(),
+            ...instrumentations,
+        ],
+    });
+    if (process.env["STACKDRIVER_TRACING_ENABLED"] === "true") {
+        const exporter = new opentelemetry_cloud_trace_exporter_1.TraceExporter({
+            resourceFilter: /^service\./,
+        });
+        provider.addSpanProcessor(new sdk_trace_base_1.BatchSpanProcessor(exporter));
+    }
+};
+exports.tracer = tracer;

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function environmentVariable(key: string, fallback?: string | number): string;
+export declare function currentTraceId(): string | undefined;

package/dist/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.currentTraceId = exports.environmentVariable = void 0;
+const context_utils_1 = require("@opentelemetry/api/build/src/trace/context-utils");
+const api_1 = require("@opentelemetry/api");
+function environmentVariable(key, fallback) {
+    const value = process.env[key] || fallback;
+    if (value) {
+        return value.toString();
+    }
+    throw new Error(`Missing environment variable '${key}'`);
+}
+exports.environmentVariable = environmentVariable;
+function currentTraceId() {
+    return (0, context_utils_1.getSpanContext)(api_1.context.active())?.traceId;
+}
+exports.currentTraceId = currentTraceId;

package/dist/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils.test.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+describe("environmentVariable", () => {
+    test("Should throw when environment variable does not exist", async () => {
+        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "SOME_VALUE";
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING")).toBe("SOME_VALUE");
+    });
+    test("Use fallback value when environment variable does not exist", async () => {
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING", "DEFAULT_VALUE")).toBe("DEFAULT_VALUE");
+    });
+    test("Should throw when environment variable does not exist", async () => {
+        expect(() => (0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING")).toThrow("Missing environment variable 'COMMONS_NODEJS_TEST_NON_EXISTING'");
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",