rian 0.0.2-alpha.13 → 0.0.2-alpha.14

package/exporter.otel.http.js

@@ -57,17 +57,15 @@ const map_kind = (kind) => {
 const exporter = (config) => (spans, context) => {
     const otel_spans = [];
     for (let span of spans) {
-        const kind = span.context.kind;
-        delete span.context.kind;
+        const { kind, error, ...span_ctx } = span.context;
         let status;
-        if ('error' in span.context) {
+        if (error) {
             status = {
                 code: SpanStatusCode_ERROR,
             };
-            if ('message' in span.context.error) {
-                status.message = span.context.error.message;
+            if ('message' in error) {
+                status.message = error.message;
             }
-            delete span.context.error;
         }
         otel_spans.push({
             traceId: span.id.trace_id,
@@ -80,7 +78,7 @@ const exporter = (config) => (spans, context) => {
             droppedAttributesCount: 0,
             droppedEventsCount: 0,
             droppedLinksCount: 0,
-            attributes: convert_object_to_kv(span.context),
+            attributes: convert_object_to_kv(span_ctx),
             status: status || { code: SpanStatusCode_UNSET },
         });
     }

package/exporter.otel.http.mjs

@@ -55,17 +55,15 @@ const map_kind = (kind) => {
 const exporter = (config) => (spans, context) => {
     const otel_spans = [];
     for (let span of spans) {
-        const kind = span.context.kind;
-        delete span.context.kind;
+        const { kind, error, ...span_ctx } = span.context;
         let status;
-        if ('error' in span.context) {
+        if (error) {
             status = {
                 code: SpanStatusCode_ERROR,
             };
-            if ('message' in span.context.error) {
-                status.message = span.context.error.message;
+            if ('message' in error) {
+                status.message = error.message;
             }
-            delete span.context.error;
         }
         otel_spans.push({
             traceId: span.id.trace_id,
@@ -78,7 +76,7 @@ const exporter = (config) => (spans, context) => {
             droppedAttributesCount: 0,
             droppedEventsCount: 0,
             droppedLinksCount: 0,
-            attributes: convert_object_to_kv(span.context),
+            attributes: convert_object_to_kv(span_ctx),
             status: status || { code: SpanStatusCode_UNSET },
         });
     }

package/exporter.zipkin.js

@@ -5,31 +5,29 @@ const flattie = require('flattie');
 const exporter = (config) => (spans, context) => {
     const zipkin = [];
     for (let span of spans) {
-        const kind = span.context.kind;
-        delete span.context.kind;
-        if ('error' in span.context) {
-            const error = span.context.error;
+        const { kind, error, ...span_ctx } = span.context;
+        if (error) {
             if ('message' in error) {
-                span.context.error = {
+                span_ctx.error = {
                     name: error.name,
                     message: error.message,
                     stack: error.stack,
                 };
             }
             else {
-                span.context.error = true;
+                span_ctx.error = true;
             }
         }
         zipkin.push({
             id: span.id.parent_id,
             traceId: span.id.trace_id,
-            parentId: span.parent?.parent_id,
+            parentId: span.parent ? span.parent.parent_id : undefined,
             name: span.name,
             kind: kind === 'INTERNAL' ? undefined : kind,
             timestamp: span.start * 1000,
             duration: span.end ? (span.end - span.start) * 1000 : undefined,
             localEndpoint: context.localEndpoint,
-            tags: flattie.flattie(Object.assign({}, context, span.context), '.', true),
+            tags: flattie.flattie(Object.assign({}, context, span_ctx), '.', true),
         });
     }
     return config.onRequest(zipkin);

package/exporter.zipkin.mjs

@@ -3,31 +3,29 @@ import { flattie } from 'flattie';
 const exporter = (config) => (spans, context) => {
     const zipkin = [];
     for (let span of spans) {
-        const kind = span.context.kind;
-        delete span.context.kind;
-        if ('error' in span.context) {
-            const error = span.context.error;
+        const { kind, error, ...span_ctx } = span.context;
+        if (error) {
             if ('message' in error) {
-                span.context.error = {
+                span_ctx.error = {
                     name: error.name,
                     message: error.message,
                     stack: error.stack,
                 };
             }
             else {
-                span.context.error = true;
+                span_ctx.error = true;
             }
         }
         zipkin.push({
             id: span.id.parent_id,
             traceId: span.id.trace_id,
-            parentId: span.parent?.parent_id,
+            parentId: span.parent ? span.parent.parent_id : undefined,
             name: span.name,
             kind: kind === 'INTERNAL' ? undefined : kind,
             timestamp: span.start * 1000,
             duration: span.end ? (span.end - span.start) * 1000 : undefined,
             localEndpoint: context.localEndpoint,
-            tags: flattie(Object.assign({}, context, span.context), '.', true),
+            tags: flattie(Object.assign({}, context, span_ctx), '.', true),
         });
     }
     return config.onRequest(zipkin);

package/index.d.ts

@@ -79,7 +79,7 @@ interface Span {
  * An exporter is a method called when the parent scope ends, gets given a Set of all spans traced
  * during this execution.
  */
-declare type Exporter = (spans: ReadonlySet<Span>, context: Context) => any;
+declare type Exporter = (spans: ReadonlySet<Readonly<Span>>, context: Context) => any;
 /**
  * @borrows {@link Span.context}
  */
@@ -118,12 +118,37 @@ interface CallableScope extends Scope {
     (cb: (scope: Omit<Scope, 'end'>) => void): ReturnType<typeof cb>;
 }
 interface Scope {
+    /**
+     * A W3C traceparent. One can .toString() this if you want to cross a network.
+     */
     traceparent: Traceparent;
+    /**
+     * Forks the span into a new child span.
+     */
     fork(name: string): CallableScope;
+    /**
+     * With a passed function — will start a span, and run the function, when the function finishes
+     * the span finishes.
+     *
+     * The measure method will return whatever the function is, so if it's a promise, it returns a
+     * promise and so on. Any error is caught and re thrown, and automatically tracked in the
+     * context under the `error` property.
+     *
+     * All promises are tracked, and awaited on a `tracer.end`
+     */
     measure<Fn extends MeasureFn>(name: string, fn: Fn, // TODO: fn doesnt see scope correctly
     ...args: RealMeasureFnParams<Parameters<Fn>>): ReturnType<Fn>;
-    set_context(contextFn: (context: Context) => Context): void;
-    set_context(context: Context): void;
+    /**
+     * Allows the span's context to be set. Passing an object will be `Object.assign`ed into the
+     * current context.
+     *
+     * Passing a function will be available to return a new context.
+     */
+    set_context(contextFn: Context | ((context: Context) => Context)): void;
+    /**
+     * Ends the current span — setting its `end` timestamp. Not calling this, will have its `end`
+     * timestamp nulled out — when the tracer ends.
+     */
     end(): void;
 }
 interface Tracer extends Omit<Scope, 'end'> {

package/index.js

@@ -71,16 +71,16 @@ const sdk_object = {
 const create = (name, options) => {
     const spans = new Set();
     const promises = [];
+    const sampler = options.sampler || defaultSampler;
     const span = (name, parent) => {
-        const should_sample = (options.sampler || defaultSampler)(name, parent, options.context);
+        const should_sample = sampler(name, parent, options.context);
         const id = parent
             ? parent.child(should_sample)
             : tctx__namespace.make(should_sample);
-        const start = Date.now();
         const span_obj = {
             id,
             parent,
-            start,
+            start: Date.now(),
             name,
             context: {},
         };

package/index.mjs

@@ -49,16 +49,16 @@ const sdk_object = {
 const create = (name, options) => {
     const spans = new Set();
     const promises = [];
+    const sampler = options.sampler || defaultSampler;
     const span = (name, parent) => {
-        const should_sample = (options.sampler || defaultSampler)(name, parent, options.context);
+        const should_sample = sampler(name, parent, options.context);
         const id = parent
             ? parent.child(should_sample)
             : tctx.make(should_sample);
-        const start = Date.now();
         const span_obj = {
             id,
             parent,
-            start,
+            start: Date.now(),
             name,
             context: {},
         };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rian",
-	"version": "0.0.2-alpha.13",
+	"version": "0.0.2-alpha.14",
 	"description": "A tracer for the edge",
 	"keywords": [
 		"TODO"