@vercel/otel 0.3.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,13 @@
1
+ import type { ReadableSpan } from "@opentelemetry/sdk-trace-base";
2
+ import type { OTLPExporterConfigBase } from "@opentelemetry/otlp-exporter-base";
3
+ import type { IExportTraceServiceRequest } from "@opentelemetry/otlp-transformer";
4
+ import { OTLPExporterEdgeBase } from "./otlp-exporter-base";
5
+ export declare class OTLPHttpJsonTraceExporter extends OTLPExporterEdgeBase<ReadableSpan, IExportTraceServiceRequest> {
6
+ convert(spans: ReadableSpan[]): IExportTraceServiceRequest;
7
+ toMessage(serviceRequest: IExportTraceServiceRequest): {
8
+ body: string | Uint8Array | Blob;
9
+ contentType: string;
10
+ headers?: Record<string, string> | undefined;
11
+ };
12
+ getDefaultUrl(config: OTLPExporterConfigBase): string;
13
+ }
@@ -0,0 +1,13 @@
1
+ import type { ReadableSpan } from "@opentelemetry/sdk-trace-base";
2
+ import type { OTLPExporterConfigBase } from "@opentelemetry/otlp-exporter-base";
3
+ import type { IExportTraceServiceRequest } from "@opentelemetry/otlp-transformer";
4
+ import { OTLPExporterEdgeBase } from "./otlp-exporter-base";
5
+ export declare class OTLPHttpProtoTraceExporter extends OTLPExporterEdgeBase<ReadableSpan, IExportTraceServiceRequest> {
6
+ convert(spans: ReadableSpan[]): IExportTraceServiceRequest;
7
+ toMessage(serviceRequest: IExportTraceServiceRequest): {
8
+ body: string | Uint8Array | Blob;
9
+ contentType: string;
10
+ headers?: Record<string, string> | undefined;
11
+ };
12
+ getDefaultUrl(config: OTLPExporterConfigBase): string;
13
+ }
@@ -0,0 +1,14 @@
1
+ import type { OTLPExporterConfigBase, OTLPExporterError } from "@opentelemetry/otlp-exporter-base";
2
+ import { OTLPExporterBase } from "@opentelemetry/otlp-exporter-base/build/src/OTLPExporterBase";
3
+ export declare abstract class OTLPExporterEdgeBase<ExportItem, ServiceRequest> extends OTLPExporterBase<OTLPExporterConfigBase, ExportItem, ServiceRequest> {
4
+ constructor(config?: OTLPExporterConfigBase);
5
+ onShutdown(): void;
6
+ onInit(): void;
7
+ send(items: ExportItem[], onSuccess: () => void, onError: (error: OTLPExporterError) => void): void;
8
+ getDefaultUrl(_config: OTLPExporterConfigBase): string;
9
+ abstract toMessage(serviceRequest: ServiceRequest): {
10
+ body: string | Uint8Array | Blob;
11
+ contentType: string;
12
+ headers?: Record<string, string>;
13
+ };
14
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,6 @@
1
+ import type { Configuration } from "./types";
2
+ export type * from "./types";
3
+ export { OTLPHttpJsonTraceExporter } from "./exporters/exporter-trace-otlp-http-fetch";
4
+ export { OTLPHttpProtoTraceExporter } from "./exporters/exporter-trace-otlp-proto-fetch";
5
+ export { type FetchInstrumentationConfig, FetchInstrumentation, } from "./instrumentations/fetch";
6
+ export declare function registerOTel(optionsOrServiceName?: Configuration | string): void;
@@ -0,0 +1,18 @@
1
+ import type { TracerProvider } from "@opentelemetry/api";
2
+ import type { Instrumentation, InstrumentationConfig } from "@opentelemetry/instrumentation";
3
+ export interface FetchInstrumentationConfig extends InstrumentationConfig {
4
+ ignoreUrls?: (string | RegExp)[];
5
+ propagateContextUrls?: (string | RegExp)[];
6
+ dontPropagateContextUrls?: (string | RegExp)[];
7
+ }
8
+ export declare class FetchInstrumentation implements Instrumentation {
9
+ instrumentationName: string;
10
+ instrumentationVersion: string;
11
+ constructor(config?: FetchInstrumentationConfig);
12
+ getConfig(): FetchInstrumentationConfig;
13
+ setConfig(): void;
14
+ setTracerProvider(tracerProvider: TracerProvider): void;
15
+ setMeterProvider(): void;
16
+ enable(): void;
17
+ disable(): void;
18
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,12 @@
1
+ import type { Configuration } from "./types";
2
+ export declare class Sdk {
3
+ private configuration;
4
+ private contextManager;
5
+ private tracerProvider;
6
+ private loggerProvider;
7
+ private meterProvider;
8
+ private disableInstumentations;
9
+ constructor(configuration?: Configuration);
10
+ start(): void;
11
+ shutdown(): Promise<void>;
12
+ }
@@ -0,0 +1,33 @@
1
+ import type { TextMapPropagator, ContextManager } from "@opentelemetry/api";
2
+ import type { InstrumentationOption } from "@opentelemetry/instrumentation";
3
+ import type { DetectorSync, ResourceAttributes } from "@opentelemetry/resources";
4
+ import type { LogRecordProcessor } from "@opentelemetry/sdk-logs";
5
+ import type { IdGenerator, Sampler, SpanExporter, SpanLimits, SpanProcessor } from "@opentelemetry/sdk-trace-base";
6
+ import type { MetricReader, View } from "@opentelemetry/sdk-metrics";
7
+ import type { FetchInstrumentationConfig } from "./instrumentations/fetch";
8
+ export type PropagatorOrName = TextMapPropagator | "auto" | "none" | "tracecontext" | "baggage";
9
+ export type SampleOrName = Sampler | "auto" | "always_off" | "always_on" | "parentbased_always_off" | "parentbased_always_on" | "parentbased_traceidratio" | "traceidratio";
10
+ export type SpanProcessorOrName = SpanProcessor | "auto";
11
+ export type SpanExporterOrName = SpanExporter | "auto";
12
+ export type InstrumentationOptionOrName = InstrumentationOption | "fetch" | "auto";
13
+ export interface InstrumentationConfiguration {
14
+ fetch?: FetchInstrumentationConfig;
15
+ }
16
+ export interface Configuration {
17
+ serviceName?: string;
18
+ attributes?: ResourceAttributes;
19
+ resourceDetectors?: DetectorSync[];
20
+ autoDetectResources?: boolean;
21
+ instrumentations?: InstrumentationOptionOrName[];
22
+ instrumentationConfig?: InstrumentationConfiguration;
23
+ contextManager?: ContextManager;
24
+ idGenerator?: IdGenerator;
25
+ propagators?: PropagatorOrName[];
26
+ traceSampler?: SampleOrName;
27
+ spanProcessors?: SpanProcessorOrName[];
28
+ traceExporter?: SpanExporterOrName;
29
+ spanLimits?: SpanLimits;
30
+ logRecordProcessor?: LogRecordProcessor;
31
+ metricReader?: MetricReader;
32
+ views?: View[];
33
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ /**
2
+ * TODO: Placeholder for the `@vercel/request-context-storage` package.
3
+ * Replace with the real package once it's published.
4
+ */
5
+ export {};
@@ -0,0 +1 @@
1
+ export {};
package/package.json CHANGED
@@ -1,67 +1,91 @@
1
1
  {
2
2
  "name": "@vercel/otel",
3
- "version": "0.3.0",
3
+ "version": "1.0.0",
4
+ "private": false,
5
+ "publishConfig": {
6
+ "access": "public"
7
+ },
4
8
  "description": "Vercel wrapper around OpenTelemetry APIs",
9
+ "author": "Vercel Inc",
10
+ "license": "MIT",
11
+ "sideEffects": false,
5
12
  "type": "module",
6
- "files": [
7
- "dist"
8
- ],
9
- "types": "./dist/index.node.d.ts",
10
13
  "exports": {
11
14
  ".": {
12
15
  "edge": {
13
- "types": "./dist/index.edge.d.ts",
14
- "default": "./dist/index.edge.js"
16
+ "types": "./dist/types/index.d.ts",
17
+ "default": "./dist/edge/index.js"
15
18
  },
16
19
  "edge-light": {
17
- "types": "./dist/index.edge.d.ts",
18
- "default": "./dist/index.edge.js"
19
- },
20
- "browser": {
21
- "types": "./dist/index.edge.d.ts",
22
- "default": "./dist/index.edge.js"
20
+ "types": "./dist/types/index.d.ts",
21
+ "default": "./dist/edge/index.js"
23
22
  },
24
23
  "worker": {
25
- "types": "./dist/index.edge.d.ts",
26
- "default": "./dist/index.edge.js"
24
+ "types": "./dist/types/index.d.ts",
25
+ "default": "./dist/edge/index.js"
27
26
  },
28
27
  "workerd": {
29
- "types": "./dist/index.edge.d.ts",
30
- "default": "./dist/index.edge.js"
28
+ "types": "./dist/types/index.d.ts",
29
+ "default": "./dist/edge/index.js"
31
30
  },
32
31
  "import": {
33
- "types": "./dist/index.node.d.ts",
34
- "default": "./dist/index.node.js"
32
+ "types": "./dist/types/index.d.ts",
33
+ "default": "./dist/node/index.js"
35
34
  },
36
35
  "node": {
37
- "types": "./dist/index.node.d.ts",
38
- "default": "./dist/index.node.js"
36
+ "types": "./dist/types/index.d.ts",
37
+ "default": "./dist/node/index.js"
39
38
  },
40
- "default": "./dist/index.node.js"
39
+ "types": "./dist/types/index.d.ts",
40
+ "default": "./dist/edge/index.js"
41
41
  }
42
42
  },
43
- "repository": {
44
- "type": "git",
45
- "url": "https://github.com/vercel/otel.git"
46
- },
47
- "license": "MIT",
48
- "devDependencies": {
49
- "@types/node": "18.16.1",
50
- "typescript": "^5.0.4"
43
+ "types": "./dist/types/index.d.ts",
44
+ "files": [
45
+ "dist"
46
+ ],
47
+ "engines": {
48
+ "node": ">=18"
51
49
  },
52
50
  "dependencies": {
53
- "@opentelemetry/api": "^1.4.1",
54
- "@opentelemetry/exporter-trace-otlp-grpc": "^0.38.0",
55
- "@opentelemetry/resources": "^1.12.0",
56
- "@opentelemetry/sdk-node": "^0.38.0",
57
- "@opentelemetry/sdk-trace-node": "^1.12.0",
58
- "@opentelemetry/semantic-conventions": "^1.12.0"
51
+ "@opentelemetry/context-async-hooks": "^1.19.0",
52
+ "@opentelemetry/core": "^1.19.0",
53
+ "@opentelemetry/exporter-trace-otlp-http": "^0.46.0",
54
+ "@opentelemetry/instrumentation": "^0.46.0",
55
+ "@opentelemetry/otlp-exporter-base": "^0.46.0",
56
+ "@opentelemetry/otlp-proto-exporter-base": "^0.46.0",
57
+ "@opentelemetry/otlp-transformer": "^0.46.0",
58
+ "@opentelemetry/resources": "^1.19.0",
59
+ "@opentelemetry/sdk-logs": "^0.46.0",
60
+ "@opentelemetry/sdk-metrics": "^1.19.0",
61
+ "@opentelemetry/sdk-node": "^0.46.0",
62
+ "@opentelemetry/sdk-trace-base": "^1.19.0",
63
+ "@opentelemetry/semantic-conventions": "^1.19.0"
59
64
  },
60
- "packageManager": "pnpm@7.24.0",
61
- "engines": {
62
- "node": ">=16"
65
+ "devDependencies": {
66
+ "@opentelemetry/api": "^1.7.0",
67
+ "@opentelemetry/api-logs": "^0.46.0",
68
+ "@types/node": "18.15.11",
69
+ "esbuild": "^0.19.4",
70
+ "rimraf": "3.0.2",
71
+ "tsx": "^4.6.2",
72
+ "typescript": "^5",
73
+ "vitest": "0.33.0",
74
+ "eslint-config": "1.0.0",
75
+ "typescript-config": "1.0.0"
76
+ },
77
+ "peerDependencies": {
78
+ "@opentelemetry/api": "^1.7.0",
79
+ "@opentelemetry/api-logs": "^0.46.0"
63
80
  },
64
81
  "scripts": {
65
- "build": "tsc"
82
+ "build": "pnpm clean && pnpm tsx build.ts && pnpm build-types",
83
+ "build-types": "tsc --noEmit false --declaration --emitDeclarationOnly --stripInternal --declarationDir dist/types src/index.ts",
84
+ "clean": "rimraf dist",
85
+ "eslint": "eslint-runner",
86
+ "eslint-fix": "eslint-runner --fix",
87
+ "type-check": "tsc --noEmit",
88
+ "unit-test": "vitest --run",
89
+ "unit-test-watch": "vitest"
66
90
  }
67
91
  }
@@ -1 +0,0 @@
1
- export declare const registerOTel: (serviceName: string) => void;
@@ -1,5 +0,0 @@
1
- export const registerOTel = (serviceName) => {
2
- // We don't support OTel on edge yet
3
- void serviceName;
4
- };
5
- //# sourceMappingURL=index.edge.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.edge.js","sourceRoot":"","sources":["../src/index.edge.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAE,EAAE;IAClD,oCAAoC;IACpC,KAAK,WAAW,CAAC;AACnB,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- export declare const registerOTel: (serviceName: string) => void;
@@ -1,15 +0,0 @@
1
- import { NodeSDK } from "@opentelemetry/sdk-node";
2
- import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
3
- import { Resource } from "@opentelemetry/resources";
4
- import { SemanticResourceAttributes } from "@opentelemetry/semantic-conventions";
5
- import { SimpleSpanProcessor } from "@opentelemetry/sdk-trace-node";
6
- export const registerOTel = (serviceName) => {
7
- const sdk = new NodeSDK({
8
- resource: new Resource({
9
- [SemanticResourceAttributes.SERVICE_NAME]: serviceName,
10
- }),
11
- spanProcessor: new SimpleSpanProcessor(new OTLPTraceExporter()),
12
- });
13
- sdk.start();
14
- };
15
- //# sourceMappingURL=index.node.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.node.js","sourceRoot":"","sources":["../src/index.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAEpE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAE,EAAE;IAClD,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC;QACtB,QAAQ,EAAE,IAAI,QAAQ,CAAC;YACrB,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE,WAAW;SACvD,CAAC;QACF,aAAa,EAAE,IAAI,mBAAmB,CAAC,IAAI,iBAAiB,EAAE,CAAC;KAChE,CAAC,CAAC;IACH,GAAG,CAAC,KAAK,EAAE,CAAC;AACd,CAAC,CAAC"}