@zerolith/otel 0.1.0-alpha.1 → 0.1.0-alpha.3
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 +5 -5
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +7 -7
- package/src/index.ts +2 -2
package/README.md
CHANGED
|
@@ -7,18 +7,18 @@ import { trace } from "@opentelemetry/api";
|
|
|
7
7
|
import { navigationObserver, tracedHydrate, tracedTransport } from "@zerolith/otel";
|
|
8
8
|
|
|
9
9
|
const tracer = trace.getTracer("my-app");
|
|
10
|
-
const router = createRouter(
|
|
11
|
-
const api = createClient<Api>(
|
|
12
|
-
tracedHydrate(App(router),
|
|
10
|
+
const router = createRouter(appRoutes, { observe: navigationObserver(tracer) });
|
|
11
|
+
const api = createClient<Api>(apiRoutes, { transport: tracedTransport(undefined, tracer) });
|
|
12
|
+
tracedHydrate(App(router), "#app", tracer);
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
- `navigationObserver` opens a span when a navigation starts and ends it on commit or failure, with the route name, the path, and the mode as attributes.
|
|
16
16
|
- `tracedHydrate` wraps `hydrate` in a span and records the number of mismatches.
|
|
17
17
|
- `tracedTransport` wraps a client transport in a client span per request, with the method, URL, and status, and injects a `traceparent` header from the active span so the server's trace continues the browser's.
|
|
18
18
|
|
|
19
|
-
The guide is
|
|
19
|
+
The guide is on the [docs site](https://molexxxx.github.io/zerolith/guide/observability/).
|
|
20
20
|
|
|
21
|
-
Status:
|
|
21
|
+
Status: alpha. Install with `npm install @zerolith/otel@alpha`; the API may change before 1.0.
|
|
22
22
|
|
|
23
23
|
## License
|
|
24
24
|
|
package/dist/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* makes every call free until one is configured.
|
|
7
7
|
*/
|
|
8
8
|
import { type Context, type Tracer } from "@opentelemetry/api";
|
|
9
|
-
import { type HydrateResult } from "zerolith";
|
|
9
|
+
import { type HydrateResult, type MountTarget } from "zerolith";
|
|
10
10
|
import type { Transport } from "@zerolith/client";
|
|
11
11
|
import type { NavigationEvent } from "@zerolith/router";
|
|
12
12
|
/**
|
|
@@ -17,7 +17,7 @@ import type { NavigationEvent } from "@zerolith/router";
|
|
|
17
17
|
*/
|
|
18
18
|
export declare function navigationObserver(tracer?: Tracer): (event: NavigationEvent) => void;
|
|
19
19
|
/** `hydrate` inside a span named `hydrate`, with the number of mismatches as `zerolith.hydration.mismatches`. */
|
|
20
|
-
export declare function tracedHydrate(view: unknown, container:
|
|
20
|
+
export declare function tracedHydrate(view: unknown, container: MountTarget, tracer?: Tracer): HydrateResult;
|
|
21
21
|
/** The W3C `traceparent` header for a context, or undefined when no span is active in it. */
|
|
22
22
|
export declare function traceparent(active?: Context): string | undefined;
|
|
23
23
|
/**
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,KAAK,OAAO,EAAuC,KAAK,MAAM,EAAkB,MAAM,oBAAoB,CAAC;AACpH,OAAO,EAAE,KAAK,aAAa,EAAW,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,KAAK,OAAO,EAAuC,KAAK,MAAM,EAAkB,MAAM,oBAAoB,CAAC;AACpH,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAW,MAAM,UAAU,CAAC;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAQxD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,GAAE,MAAwB,GAAG,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAiCrG;AAED,iHAAiH;AACjH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,GAAE,MAAwB,GAAG,aAAa,CAsBpH;AAED,6FAA6F;AAC7F,wBAAgB,WAAW,CAAC,MAAM,GAAE,OAA0B,GAAG,MAAM,GAAG,SAAS,CAQlF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,MAAM,GAAE,MAAwB,GAAG,SAAS,CA6B7G"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAA2B,QAAQ,EAAE,cAAc,EAAe,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACpH,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAA2B,QAAQ,EAAE,cAAc,EAAe,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACpH,OAAO,EAAwC,OAAO,EAAE,MAAM,UAAU,CAAC;AAIzE,wHAAwH;AACxH,SAAS,aAAa;IAElB,OAAO,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAM,GAAW,aAAa,EAAE;IAE/D,MAAM,IAAI,GAAG,IAAI,GAAG,EAAgB,CAAC;IACrC,OAAO,CAAC,KAAK,EAAE,EAAE;QAEb,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAC1B,CAAC;YACG,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE;gBACtC,IAAI,EAAE,QAAQ,CAAC,QAAQ;gBACvB,UAAU,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,0BAA0B,EAAE,KAAK,CAAC,IAAI,EAAE;aACxH,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACzB,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAChC,IAAI,IAAI,KAAK,SAAS,EACtB,CAAC;YACG,OAAO;QACX,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACtB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAC3B,CAAC;YACG,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACtD,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;QAChD,CAAC;aAED,CAAC;YACG,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC1B,IAAI,CAAC,eAAe,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACpH,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACf,CAAC,CAAC;AACN,CAAC;AAED,iHAAiH;AACjH,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,SAAsB,EAAE,MAAM,GAAW,aAAa,EAAE;IAEjG,OAAO,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;QAE9C,IACA,CAAC;YACG,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACxC,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC7E,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5C,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,OAAO,KAAK,EACZ,CAAC;YACG,IAAI,CAAC,eAAe,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;YAC/C,MAAM,KAAK,CAAC;QAChB,CAAC;gBAED,CAAC;YACG,IAAI,CAAC,GAAG,EAAE,CAAC;QACf,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,WAAW,CAAC,MAAM,GAAY,OAAO,CAAC,MAAM,EAAE;IAE1D,MAAM,IAAI,GAAG,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,EACzD,CAAC;QACG,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAChG,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,SAAgC,EAAE,MAAM,GAAW,aAAa,EAAE;IAE9F,MAAM,IAAI,GAAc,SAAS,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,OAAO,CAAC,OAAO,EAAE,EAAE;QAEf,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,MAAM,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,qBAAqB,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAEzL,IACA,CAAC;gBACG,MAAM,MAAM,GAAG,WAAW,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;gBACtI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,CAAC,2BAA2B,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAChE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC/H,OAAO,QAAQ,CAAC;YACpB,CAAC;YACD,OAAO,KAAK,EACZ,CAAC;gBACG,IAAI,CAAC,eAAe,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChF,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAChH,MAAM,KAAK,CAAC;YAChB,CAAC;oBAED,CAAC;gBACG,IAAI,CAAC,GAAG,EAAE,CAAC;YACf,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED,SAAS,UAAU,CAAC,OAAgB,EAAE,IAAY,EAAE,KAAa;IAE7D,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtB,OAAO,IAAI,CAAC;AAChB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zerolith/otel",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.3",
|
|
4
4
|
"description": "OpenTelemetry spans for zerolith applications through @opentelemetry/api: a span per navigation, per hydration, and per request of the typed client with traceparent propagation",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "molexxxx",
|
|
@@ -41,17 +41,17 @@
|
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|
|
43
43
|
"@opentelemetry/api": ">=1.9.0 <2.0.0",
|
|
44
|
-
"@zerolith/client": "^0.1.0-alpha.
|
|
45
|
-
"@zerolith/router": "^0.1.0-alpha.
|
|
46
|
-
"zerolith": "^0.1.0-alpha.
|
|
44
|
+
"@zerolith/client": "^0.1.0-alpha.3",
|
|
45
|
+
"@zerolith/router": "^0.1.0-alpha.3",
|
|
46
|
+
"zerolith": "^0.1.0-alpha.3"
|
|
47
47
|
},
|
|
48
48
|
"peerDependenciesMeta": {
|
|
49
49
|
"@zerolith/client": { "optional": true },
|
|
50
50
|
"@zerolith/router": { "optional": true }
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@zerolith/client": "^0.1.0-alpha.
|
|
54
|
-
"@zerolith/router": "^0.1.0-alpha.
|
|
55
|
-
"zerolith": "^0.1.0-alpha.
|
|
53
|
+
"@zerolith/client": "^0.1.0-alpha.3",
|
|
54
|
+
"@zerolith/router": "^0.1.0-alpha.3",
|
|
55
|
+
"zerolith": "^0.1.0-alpha.3"
|
|
56
56
|
}
|
|
57
57
|
}
|
package/src/index.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* makes every call free until one is configured.
|
|
7
7
|
*/
|
|
8
8
|
import { type Context, type Span, SpanKind, SpanStatusCode, type Tracer, context, trace } from "@opentelemetry/api";
|
|
9
|
-
import { type HydrateResult, hydrate } from "zerolith";
|
|
9
|
+
import { type HydrateResult, type MountTarget, hydrate } from "zerolith";
|
|
10
10
|
import type { Transport } from "@zerolith/client";
|
|
11
11
|
import type { NavigationEvent } from "@zerolith/router";
|
|
12
12
|
|
|
@@ -58,7 +58,7 @@ export function navigationObserver(tracer: Tracer = defaultTracer()): (event: Na
|
|
|
58
58
|
}
|
|
59
59
|
|
|
60
60
|
/** `hydrate` inside a span named `hydrate`, with the number of mismatches as `zerolith.hydration.mismatches`. */
|
|
61
|
-
export function tracedHydrate(view: unknown, container:
|
|
61
|
+
export function tracedHydrate(view: unknown, container: MountTarget, tracer: Tracer = defaultTracer()): HydrateResult
|
|
62
62
|
{
|
|
63
63
|
return tracer.startActiveSpan("hydrate", (span) =>
|
|
64
64
|
{
|