@evenicanpm/common-core 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@evenicanpm/common-core",
-	"version": "1.2.0",
+	"version": "1.3.0",
 	"description": "Common module for Headless Storefront and Admin panel",
 	"author": "Evenica",
 	"type": "module",
@@ -10,10 +10,21 @@
 	},
 	"dependencies": {
 		"@azure/identity": "^4.10.1",
-		"@azure/keyvault-secrets": "^4.10.0"
+		"@azure/keyvault-secrets": "^4.10.0",
+		"@azure/monitor-opentelemetry-exporter": "^1.0.0-beta.32",
+		"@opentelemetry/api": "^1.9.0",
+		"@opentelemetry/api-logs": "^0.206.0",
+		"@opentelemetry/exporter-trace-otlp-http": "^0.206.0",
+		"@opentelemetry/host-metrics": "^0.36.2",
+		"@opentelemetry/sdk-logs": "^0.206.0",
+		"@opentelemetry/sdk-metrics": "^2.1.0",
+		"@opentelemetry/sdk-trace-node": "^2.1.0",
+		"@strapi/client": "^1.5.0",
+		"@vercel/otel": "^2.0.1",
+		"strapi-sdk-js": "^3.0.0"
 	},
 	"devDependencies": {
 		"@types/node": "^24.0.13"
 	},
-	"gitHead": "6a95e9f84f48a7e1e96bfdf4ee1a766a7d8808b6"
+	"gitHead": "074f33378006dfc21ceb49456806a18dbb6e91ad"
 }

package/src/lib/index.ts

@@ -0,0 +1 @@
+export * from "./keyvault";

package/{keyvault.ts → src/lib/keyvault.ts}

@@ -7,7 +7,7 @@ const vaultEndpoint = process.env.KEYVAULT_ENDPOINT;
 const url = `https://${vaultName}.${vaultEndpoint}`;
 
 // Initialize local secrets cache object
-let secrets = new Map();
+const secrets = new Map();
 
 // A Key and Secret class to Cache Secrets
 class Secret {
@@ -27,11 +27,11 @@ class Secret {
  * set all secrets in the "secrets" map binding which is exported from this module.
  */
 const initializeKeyVaultCache = async () => {
-	if (process.env.NODE_ENV == "production") {
+	if (process.env.NODE_ENV === "production") {
 		const credential = new DefaultAzureCredential();
 		const client = new SecretClient(url, credential);
 
-		for await (let secretProperties of client.listPropertiesOfSecrets()) {
+		for await (const secretProperties of client.listPropertiesOfSecrets()) {
 			const result = await client.getSecret(secretProperties.name);
 			secrets.set(
 				secretProperties.name,
@@ -48,7 +48,7 @@ const initializeKeyVaultCache = async () => {
  * @returns Returns the secret string.
  */
 const getSecret = (key: string): string | undefined => {
-	if (process.env.NODE_ENV != "production") {
+	if (process.env.NODE_ENV !== "production") {
 		const fixedName = key.replace(/-/g, "_");
 		return process.env[fixedName];
 	} else {

package/src/otel/README.md

@@ -0,0 +1,44 @@
+# Using Opentelemetry in e4
+
+- `setup.ts` has two main paths:
+  1. Azure Not Enabled - Will setup OLTP and @vercel/otel Registration for auto instrumentation with nextjs
+  2. Azure Enabled - Does the above AND Azure monitoring for metrics, logs, and traces
+
+## Using a Tracer Example
+
+From https://opentelemetry.io/docs/languages/js/instrumentation/
+
+```ts
+import opentelemetry from "@opentelemetry/api";
+//...
+
+const tracer = opentelemetry.trace.getTracer(
+  "instrumentation-scope-name",
+  "instrumentation-scope-version",
+);
+
+// You can now use a 'tracer' to do tracing!
+```
+
+## Starting a Span
+
+```ts
+return tracer.startActiveSpan("rollTheDice", (span: Span) => {
+  const result: number[] = [];
+  for (let i = 0; i < rolls; i++) {
+    result.push(rollOnce(min, max));
+  }
+  // Be sure to end the span!
+  span.end();
+  return result;
+});
+```
+
+## Using the Logger
+
+```ts
+import log from "@evenicanpm/common-core/src/otel/logger";
+
+const logger = log();
+logger.info("This is some e4 info!");
+```

package/src/otel/logger.ts

@@ -0,0 +1,54 @@
+import { logs, SeverityNumber } from "@opentelemetry/api-logs";
+
+type LogAttriutes = Record<string, string | number | boolean | undefined>;
+
+/**
+ *
+ * Centralized logging using opentelemetry log emitter function.
+ *
+ */
+function logger() {
+	// Global logger is set in ./setup.ts
+	const log = logs.getLogger("storefront");
+	return {
+		info: (message: string, attributes?: LogAttriutes) => {
+			log.emit({
+				severityNumber: SeverityNumber.INFO,
+				body: message,
+				attributes,
+			});
+		},
+		debug: (message: string) => {
+			log.emit({
+				severityNumber: SeverityNumber.DEBUG,
+				body: message,
+			});
+		},
+		error: (message: string, error?: unknown, attributes?: LogAttriutes) => {
+			const err =
+				error instanceof Error
+					? {
+							name: error.name,
+							message: error.message,
+							stack: error.stack,
+						}
+					: undefined;
+			log.emit({
+				severityNumber: SeverityNumber.ERROR,
+				body: message,
+				attributes: {
+					...attributes,
+					...(err && { error: err }),
+				},
+			});
+		},
+		warn: (message: string) => {
+			log.emit({
+				severityNumber: SeverityNumber.WARN,
+				body: message,
+			});
+		},
+	};
+}
+
+export default logger;

package/src/otel/setup.ts

@@ -0,0 +1,99 @@
+import { metrics } from "@opentelemetry/api";
+import { logs } from "@opentelemetry/api-logs";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import {
+	BatchLogRecordProcessor,
+	LoggerProvider,
+} from "@opentelemetry/sdk-logs";
+import {
+	MeterProvider,
+	PeriodicExportingMetricReader,
+} from "@opentelemetry/sdk-metrics";
+import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-node";
+import { registerOTel } from "@vercel/otel";
+
+/**
+ * The configuration object passed to setupOtel function.
+ */
+interface otelConfig {
+	serviceName: string;
+	AzureEnabled?: boolean;
+	AzureMonitorKey?: string;
+}
+
+/**
+ * The core setup for Azure Insights and opentelemetry for
+ * admin and storefront. Config can be extended to support multiple
+ * opentelemetry exports.
+ */
+async function setupOtel(otelConfig?: otelConfig) {
+	if (!process.env.OTELCOL_URL) {
+		throw new Error("Missing OTELCOL_URL environment variable.");
+	}
+
+	const { serviceName, AzureEnabled, AzureMonitorKey } = otelConfig ?? {};
+
+	if (!AzureEnabled) {
+		return registerOTel({
+			serviceName: otelConfig?.serviceName,
+			spanProcessors: [
+				new BatchSpanProcessor(
+					new OTLPTraceExporter({ url: process.env.OTELCOL_URL }),
+				),
+			],
+		});
+	}
+
+	/** Azure Enabled */
+	if (!AzureMonitorKey)
+		throw new Error("No Azure Monitor Connection String Provided.");
+
+	const connectionString = AzureMonitorKey;
+	const config = { connectionString };
+
+	// Azure - Imports
+	const {
+		AzureMonitorMetricExporter,
+		AzureMonitorTraceExporter,
+		AzureMonitorLogExporter,
+	} = await import("@azure/monitor-opentelemetry-exporter");
+	const { HostMetrics } = await import("@opentelemetry/host-metrics");
+
+	// Azure - Monitor Exporters
+	const metricsExporter = new AzureMonitorMetricExporter(config);
+	const logExporter = new AzureMonitorLogExporter(config);
+	const traceExporter = new AzureMonitorTraceExporter(config);
+
+	// Azure - Logging
+	const logProcessor = new BatchLogRecordProcessor(logExporter, {
+		maxExportBatchSize: 100,
+	});
+	const loggerProvider = new LoggerProvider({ processors: [logProcessor] });
+	logs.setGlobalLoggerProvider(loggerProvider);
+
+	// Azure - Metrics
+	const metricReaderOptions = {
+		exporter: metricsExporter,
+	};
+	const metricReader = new PeriodicExportingMetricReader(metricReaderOptions);
+	const meterProvider = new MeterProvider({
+		readers: [metricReader],
+	});
+	metrics.setGlobalMeterProvider(meterProvider);
+	// OS level Metrics
+	const hostMetrics = new HostMetrics({ meterProvider });
+	hostMetrics.start();
+
+	/** NextJS Otel Registration */
+	registerOTel({
+		serviceName: serviceName,
+		spanProcessors: [
+			new BatchSpanProcessor(traceExporter),
+			new BatchSpanProcessor(
+				new OTLPTraceExporter({ url: process.env.OTELCOL_URL }),
+			),
+		],
+	});
+}
+
+export { setupOtel };

package/tsconfig.json

@@ -10,10 +10,11 @@
 		"moduleResolution": "node",
 		"resolveJsonModule": true,
 		"outDir": "./dist",
-		"baseUrl": "../../../../storefront/",
+		"baseUrl": "./",
 		"jsx": "preserve",
+		"typeRoots": ["../../../../storefront/node_modules/@types"],
 		"paths": {
-			"*": ["../../../../storefront/node_modules/"]
+			"*": ["../../../../storefront/node_modules/*"]
 		}
 	},
 	"include": ["./"]