@orpc/opentelemetry 2.0.0-beta.34 → 2.0.0-beta.36
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.
- package/README.md +30 -20
- package/dist/index.mjs +76 -6
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -46,29 +46,30 @@ You can read the documentation [here](https://orpc.dev).
|
|
|
46
46
|
|
|
47
47
|
**Built-in features**
|
|
48
48
|
|
|
49
|
-
| Package
|
|
50
|
-
|
|
|
51
|
-
| [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher)
|
|
52
|
-
| [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit)
|
|
53
|
-
| [@orpc/
|
|
54
|
-
| [@orpc/
|
|
49
|
+
| Package | Purpose | Docs |
|
|
50
|
+
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
51
|
+
| [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher) | Pub/Sub with memory, Redis, and Upstash adapters. | [Publisher](https://orpc.dev/docs/helpers/publisher) |
|
|
52
|
+
| [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit) | Rate limiting with memory, Redis, and Upstash adapters. | [Rate Limit](https://orpc.dev/docs/helpers/ratelimit) |
|
|
53
|
+
| [@orpc/experimental-lock](https://www.npmjs.com/package/@orpc/experimental-lock) | Locking with memory, Redis, and Upstash adapters. | [Lock](https://orpc.dev/docs/helpers/lock) |
|
|
54
|
+
| [@orpc/hibernation](https://www.npmjs.com/package/@orpc/hibernation) | Leverage Hibernation APIs like [Cloudflare's Hibernation WebSocket](https://developers.cloudflare.com/durable-objects/best-practices/websockets/#durable-objects-hibernation-websocket-api). | [Hibernation](https://orpc.dev/docs/integrations/hibernation) |
|
|
55
|
+
| [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema) | Smart coercion for OpenAPI requests. | [Smart Coercion](https://orpc.dev/docs/plugins/smart-coercion) |
|
|
55
56
|
|
|
56
57
|
**Framework & ecosystem integrations**
|
|
57
58
|
|
|
58
|
-
| Package | Purpose
|
|
59
|
-
| ------------------------------------------------------------------------------------ |
|
|
60
|
-
| [@orpc/next](https://www.npmjs.com/package/@orpc/next) | Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
61
|
-
| [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk) | Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
|
|
62
|
-
| [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query) | Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
63
|
-
| [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada) | Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
64
|
-
| [@orpc/swr](https://www.npmjs.com/package/@orpc/swr) | Integrate with [SWR](https://swr.vercel.app/).
|
|
65
|
-
| [@orpc/experimental-msw](https://www.npmjs.com/package/@orpc/experimental-msw) | Mock procedures with [Mock Service Worker](https://mswjs.io/).
|
|
66
|
-
| [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect) | Integrate with [Effect](https://effect.website/).
|
|
67
|
-
| [@orpc/nest](https://www.npmjs.com/package/@orpc/nest) | Implement your contract with [NestJS](https://nestjs.com/).
|
|
68
|
-
| [@orpc/node](https://www.npmjs.com/package/@orpc/node) | [Node.js](https://nodejs.org/) plugins for static file serving and large uploads.
|
|
69
|
-
| [@orpc/bun](https://www.npmjs.com/package/@orpc/bun) | Adapters for [Bun's Redis](https://bun.sh/).
|
|
70
|
-
| [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare) | Adapters for [Cloudflare
|
|
71
|
-
| [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc) | Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
|
|
59
|
+
| Package | Purpose | Docs |
|
|
60
|
+
| ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
61
|
+
| [@orpc/next](https://www.npmjs.com/package/@orpc/next) | Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data). | [Next.js](https://orpc.dev/docs/integrations/next) |
|
|
62
|
+
| [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk) | Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools. | [AI SDK](https://orpc.dev/docs/integrations/ai-sdk) |
|
|
63
|
+
| [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query) | Integrate with [TanStack Query](https://tanstack.com/query/latest). | [TanStack Query](https://orpc.dev/docs/integrations/tanstack-query) |
|
|
64
|
+
| [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada) | Integrate with [Pinia Colada](https://pinia-colada.esm.dev/). | [Pinia Colada](https://orpc.dev/docs/integrations/pinia-colada) |
|
|
65
|
+
| [@orpc/swr](https://www.npmjs.com/package/@orpc/swr) | Integrate with [SWR](https://swr.vercel.app/). | [SWR](https://orpc.dev/docs/integrations/swr) |
|
|
66
|
+
| [@orpc/experimental-msw](https://www.npmjs.com/package/@orpc/experimental-msw) | Mock procedures with [Mock Service Worker](https://mswjs.io/). | [MSW](https://orpc.dev/docs/integrations/msw) |
|
|
67
|
+
| [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect) | Integrate with [Effect](https://effect.website/). | [Effect](https://orpc.dev/docs/integrations/effect) |
|
|
68
|
+
| [@orpc/nest](https://www.npmjs.com/package/@orpc/nest) | Implement your contract with [NestJS](https://nestjs.com/). | [NestJS](https://orpc.dev/docs/integrations/nest) |
|
|
69
|
+
| [@orpc/node](https://www.npmjs.com/package/@orpc/node) | [Node.js](https://nodejs.org/) plugins for static file serving and large uploads. | [Static File](https://orpc.dev/docs/plugins/static-file), [Tmp File Upload](https://orpc.dev/docs/plugins/tmp-file-upload), [Batch Response Compression](https://orpc.dev/docs/plugins/batch-response-compression) |
|
|
70
|
+
| [@orpc/bun](https://www.npmjs.com/package/@orpc/bun) | Adapters for [Bun's Redis](https://bun.sh/). | [Publisher](https://orpc.dev/docs/helpers/publisher), [Rate Limit](https://orpc.dev/docs/helpers/ratelimit), [Lock](https://orpc.dev/docs/helpers/lock) |
|
|
71
|
+
| [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare) | Adapters for [Cloudflare Workers](https://developers.cloudflare.com/workers/). | [Publisher](https://orpc.dev/docs/helpers/publisher), [Rate Limit](https://orpc.dev/docs/helpers/ratelimit), [Lock](https://orpc.dev/docs/helpers/lock), [Traces](https://orpc.dev/docs/integrations/cloudflare-traces) |
|
|
72
|
+
| [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc) | Reuse existing [tRPC](https://trpc.io/) routers within oRPC. | [tRPC](https://orpc.dev/docs/integrations/trpc) |
|
|
72
73
|
|
|
73
74
|
**Observability**
|
|
74
75
|
|
|
@@ -94,6 +95,14 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
94
95
|
</tr>
|
|
95
96
|
</table>
|
|
96
97
|
|
|
98
|
+
### Special Sponsors
|
|
99
|
+
|
|
100
|
+
<table>
|
|
101
|
+
<tr>
|
|
102
|
+
<td align="center"><a href="http://twitter.com/rauchg?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Guillermo Rauch"><img src="https://avatars.githubusercontent.com/u/13041?u=1ee8d111657cdd02ff6d253df00978d17ee6d722&v=4" width="279" alt="Guillermo Rauch"/><br />Guillermo Rauch</a></td>
|
|
103
|
+
</tr>
|
|
104
|
+
</table>
|
|
105
|
+
|
|
97
106
|
### Organization Sponsors
|
|
98
107
|
|
|
99
108
|
<table>
|
|
@@ -127,6 +136,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
127
136
|
<td align="center"><a href="https://github.com/ellis-driscoll?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&v=4" width="139" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
|
|
128
137
|
<td align="center"><a href="https://github.com/hoangbn?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Hoang Nguyen"><img src="https://avatars.githubusercontent.com/u/38968280?u=c90084c6de65c56facabab7ba13a72a49ddbc3e4&v=4" width="139" alt="Hoang Nguyen"/><br />Hoang Nguyen</a></td>
|
|
129
138
|
<td align="center"><a href="https://opencollective.com/guest-ac41de3b?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Orestis Ioannou"><img src="https://images.opencollective.com/guest-ac41de3b/avatar/460.png" width="139" alt="Orestis Ioannou"/><br />Orestis Ioannou</a></td>
|
|
139
|
+
<td align="center"><a href="https://automatio.ai/?ref=middleapi&utm_source=middleapi&utm_medium=sponsor" target="_blank" rel="noopener sponsored" title="Stefan Smiljkovic"><img src="https://avatars.githubusercontent.com/u/1984909?u=b7bf5bc40ed49df3c22f69d2da7b8d78709c49ed&v=4" width="139" alt="Stefan Smiljkovic"/><br />Stefan Smiljkovic</a></td>
|
|
130
140
|
</tr>
|
|
131
141
|
</table>
|
|
132
142
|
|
package/dist/index.mjs
CHANGED
|
@@ -1,13 +1,83 @@
|
|
|
1
|
-
import { propagation, context, trace } from '@opentelemetry/api';
|
|
1
|
+
import { SpanStatusCode, propagation, context, trace } from '@opentelemetry/api';
|
|
2
2
|
import { InstrumentationBase } from '@opentelemetry/instrumentation';
|
|
3
|
-
import {
|
|
3
|
+
import { setTracer } from '@orpc/shared';
|
|
4
4
|
|
|
5
5
|
const name = "@orpc/opentelemetry";
|
|
6
|
-
const version = "2.0.0-beta.
|
|
6
|
+
const version = "2.0.0-beta.36";
|
|
7
7
|
const pkg = {
|
|
8
8
|
name: name,
|
|
9
9
|
version: version};
|
|
10
10
|
|
|
11
|
+
class OpenTelemetrySpan {
|
|
12
|
+
constructor(span) {
|
|
13
|
+
this.span = span;
|
|
14
|
+
}
|
|
15
|
+
setAttribute(key, value) {
|
|
16
|
+
this.span.setAttribute(key, value);
|
|
17
|
+
}
|
|
18
|
+
updateName(name) {
|
|
19
|
+
this.span.updateName(name);
|
|
20
|
+
}
|
|
21
|
+
addEvent(name) {
|
|
22
|
+
this.span.addEvent(name);
|
|
23
|
+
}
|
|
24
|
+
recordException(level, exception) {
|
|
25
|
+
this.span.recordException(exception);
|
|
26
|
+
if (level === "error") {
|
|
27
|
+
this.span.setStatus({
|
|
28
|
+
code: SpanStatusCode.ERROR,
|
|
29
|
+
message: exception.message
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
end() {
|
|
34
|
+
this.span.end();
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
class OpenTelemetryTracer {
|
|
38
|
+
tracer;
|
|
39
|
+
trace;
|
|
40
|
+
context;
|
|
41
|
+
inject;
|
|
42
|
+
extract;
|
|
43
|
+
constructor(options) {
|
|
44
|
+
this.tracer = options.tracer;
|
|
45
|
+
this.trace = options.trace;
|
|
46
|
+
this.context = options.context;
|
|
47
|
+
const propagation = options.propagation;
|
|
48
|
+
if (propagation !== void 0) {
|
|
49
|
+
this.inject = (span, headers) => {
|
|
50
|
+
propagation.inject(this.contextOf(span), headers);
|
|
51
|
+
};
|
|
52
|
+
this.extract = (headers) => {
|
|
53
|
+
const span = this.trace.getSpan(propagation.extract(this.context.active(), headers));
|
|
54
|
+
return span === void 0 ? void 0 : new OpenTelemetrySpan(span);
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
startSpan(name, parent) {
|
|
59
|
+
const span = parent === void 0 ? this.tracer.startSpan(name) : this.tracer.startSpan(name, void 0, this.contextOf(parent));
|
|
60
|
+
return new OpenTelemetrySpan(span);
|
|
61
|
+
}
|
|
62
|
+
startActiveSpan(name, parent, fn) {
|
|
63
|
+
const callback = (span) => fn(new OpenTelemetrySpan(span));
|
|
64
|
+
if (parent === void 0) {
|
|
65
|
+
return this.tracer.startActiveSpan(name, callback);
|
|
66
|
+
}
|
|
67
|
+
return this.tracer.startActiveSpan(name, {}, this.contextOf(parent), callback);
|
|
68
|
+
}
|
|
69
|
+
getActiveSpan() {
|
|
70
|
+
const span = this.trace.getActiveSpan();
|
|
71
|
+
return span === void 0 ? void 0 : new OpenTelemetrySpan(span);
|
|
72
|
+
}
|
|
73
|
+
withActiveSpan(span, fn) {
|
|
74
|
+
return this.context.with(this.contextOf(span), fn);
|
|
75
|
+
}
|
|
76
|
+
contextOf(parent) {
|
|
77
|
+
return this.trace.setSpan(this.context.active(), parent.span);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
|
|
11
81
|
class ORPCInstrumentation extends InstrumentationBase {
|
|
12
82
|
constructor(config = {}) {
|
|
13
83
|
super(pkg.name, pkg.version, config);
|
|
@@ -15,15 +85,15 @@ class ORPCInstrumentation extends InstrumentationBase {
|
|
|
15
85
|
init() {
|
|
16
86
|
}
|
|
17
87
|
enable() {
|
|
18
|
-
|
|
88
|
+
setTracer(new OpenTelemetryTracer({
|
|
19
89
|
tracer: trace.getTracer(pkg.name, pkg.version),
|
|
20
90
|
trace,
|
|
21
91
|
context,
|
|
22
92
|
propagation: this._config.propagationEnabled ?? true ? propagation : void 0
|
|
23
|
-
});
|
|
93
|
+
}));
|
|
24
94
|
}
|
|
25
95
|
disable() {
|
|
26
|
-
|
|
96
|
+
setTracer(void 0);
|
|
27
97
|
}
|
|
28
98
|
}
|
|
29
99
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/opentelemetry",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.0.0-beta.
|
|
4
|
+
"version": "2.0.0-beta.36",
|
|
5
5
|
"description": "OpenTelemetry integration for oRPC: distributed tracing for typesafe APIs",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"funding": [
|
|
@@ -39,11 +39,12 @@
|
|
|
39
39
|
"@opentelemetry/instrumentation": ">=0.203.0"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@orpc/shared": "2.0.0-beta.
|
|
42
|
+
"@orpc/shared": "2.0.0-beta.36"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"@opentelemetry/api": "^1.9.1",
|
|
46
|
-
"@opentelemetry/instrumentation": "^0.221.0"
|
|
46
|
+
"@opentelemetry/instrumentation": "^0.221.0",
|
|
47
|
+
"@opentelemetry/sdk-trace-node": "^2.10.0"
|
|
47
48
|
},
|
|
48
49
|
"scripts": {
|
|
49
50
|
"type:check": "tsc -b"
|