@netlify/opentelemetry-utils 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Netlify <team@netlify.com>
+
+MIT License
+
+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/README.md

@@ -0,0 +1,5 @@
+# Opentelemetry Utils
+
+This package extracts utility methods to interact with open telemetry across our JS packages. It's a thin wrapper around
+the OTEL API and is built strictly so that no other `@opentelemetry` dependency is **required besides
+`@opentelemetry/api`.**

package/lib/index.d.ts

@@ -0,0 +1,27 @@
+import { Context } from '@opentelemetry/api';
+/**
+ * Sets attributes to be propagated across child spans under the current active context
+ */
+export declare const setMultiSpanAttributes: (attributes: {
+    [key: string]: string;
+}) => Context;
+/**
+ * Add error information to the current active span (if any). Optionally sets the provided attributes on the span too.
+ */
+export declare const addErrorToActiveSpan: (error: Error, attributes?: {
+    [key: string]: string;
+} | undefined) => void;
+/**
+ * Creates a specific event to the current active span (if any)
+ */
+export declare const addEventToActiveSpan: (eventName: string, attributes?: {
+    [key: string]: string;
+} | undefined) => void;
+/**
+ * Sets global context to be used when initialising our root span
+ */
+export declare const setGlobalContext: (ctx: Context) => void;
+/**
+ * Gets the global context to be used when initialising our root span
+ */
+export declare const getGlobalContext: () => Context;

package/lib/index.js

@@ -0,0 +1,53 @@
+import { context, propagation, trace, SpanStatusCode } from '@opentelemetry/api';
+/**
+ * Sets attributes to be propagated across child spans under the current active context
+ */
+export const setMultiSpanAttributes = function (attributes) {
+    const currentBaggage = propagation.getBaggage(context.active());
+    // Create a baggage if there's none
+    let baggage = currentBaggage === undefined ? propagation.createBaggage() : currentBaggage;
+    Object.entries(attributes).forEach(([key, value]) => {
+        baggage = baggage.setEntry(key, { value });
+    });
+    return propagation.setBaggage(context.active(), baggage);
+};
+/**
+ * Add error information to the current active span (if any). Optionally sets the provided attributes on the span too.
+ */
+export const addErrorToActiveSpan = function (error, attributes) {
+    const span = trace.getActiveSpan();
+    if (!span)
+        return;
+    if (attributes !== undefined) {
+        span.setAttributes(attributes);
+    }
+    span.recordException(error);
+    span.setStatus({
+        code: SpanStatusCode.ERROR,
+        message: error.message,
+    });
+};
+/**
+ * Creates a specific event to the current active span (if any)
+ */
+export const addEventToActiveSpan = function (eventName, attributes) {
+    const span = trace.getActiveSpan();
+    if (!span)
+        return;
+    span.addEvent(eventName, attributes);
+};
+/**
+ * Sets global context to be used when initialising our root span
+ */
+export const setGlobalContext = function (ctx) {
+    global['NETLIFY_GLOBAL_CONTEXT'] = ctx;
+};
+/**
+ * Gets the global context to be used when initialising our root span
+ */
+export const getGlobalContext = function () {
+    if (global['NETLIFY_GLOBAL_CONTEXT'] === undefined) {
+        return context.active();
+    }
+    return global['NETLIFY_GLOBAL_CONTEXT'];
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@netlify/opentelemetry-utils",
+  "version": "1.0.0",
+  "description": "Opentelemetry utility methods",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:logos": "vite build",
+    "test": "vitest run",
+    "test:dev": "vitest --ui",
+    "test:ci": "vitest run --reporter=default"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/netlify/build.git",
+    "directory": "packages/opentelemetry-utils"
+  },
+  "bugs": {
+    "url": "https://github.com/netlify/build/issues"
+  },
+  "author": "Netlify Inc.",
+  "dependencies": {
+    "@opentelemetry/api": "~1.6.0"
+  },
+  "devDependencies": {
+    "@opentelemetry/sdk-trace-base": "^1.18.1",
+    "@opentelemetry/sdk-trace-node": "^1.18.1",
+    "@types/node": "^14.18.53",
+    "@vitest/coverage-c8": "^0.30.1",
+    "@vitest/ui": "^0.30.1",
+    "typescript": "^5.0.0",
+    "vite": "^4.0.4",
+    "vitest": "^0.30.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "gitHead": "8ebf95ca5a1590da72fdffb67e966e02efd4d379"
+}