rian 0.2.3 → 0.3.0-next.1

package/exporter.otel.http/index.js

@@ -1 +1 @@
-const { name:e, version:t } = require('rian/package.json');var r=e=>{let t=typeof e,n={};return"string"===t?n.stringValue=e:"number"===t?Number.isInteger(e)?n.intValue=e:n.doubleValue=e:"boolean"===t?n.boolValue=e:Array.isArray(e)?n.arrayValue={values:e.map((e=>r(e)))}:e&&(n.kvlistValue={values:a(e)}),n},a=e=>{let t=[];for(let a of Object.keys(e))t.push({key:a,value:r(e[a])});return t},n=e=>{switch(e){default:case"INTERNAL":return 1;case"SERVER":return 2;case"CLIENT":return 3;case"PRODUCER":return 4;case"CONSUMER":return 5}},s=r=>(s,i)=>{let u=[];for(let e of s){let t,{kind:r,error:s,...i}=e.context;s&&(t={code:2},"message"in s&&(t.message=s.message)),u.push({traceId:e.id.trace_id,spanId:e.id.parent_id,parentSpanId:e.parent?.parent_id,name:e.name,kind:n(r||"INTERNAL"),startTimeUnixNano:1e6*e.start,endTimeUnixNano:e.end?1e6*e.end:void 0,droppedAttributesCount:0,droppedEventsCount:0,droppedLinksCount:0,attributes:a(i),status:t||{code:0},events:e.events.map((e=>({name:e.name,attributes:a(e.attributes),droppedAttributesCount:0,timeUnixNano:1e6*e.timestamp})))})}return r({resourceSpans:[{resource:{attributes:a(i),droppedAttributesCount:0},instrumentationLibrarySpans:[{instrumentationLibrary:{name:e,version:t},spans:u}]}]})};exports.exporter=s;
+var e=r=>{let n=typeof r,a={};return"string"===n?a.stringValue=r:"number"===n?Number.isInteger(r)?a.intValue=r:a.doubleValue=r:"boolean"===n?a.boolValue=r:Array.isArray(r)?a.arrayValue={values:r.map((t=>e(t)))}:r&&(a.kvlistValue={values:t(r)}),a},t=t=>{let r=[];for(let n of Object.keys(t))r.push({key:n,value:e(t[n])});return r},r=e=>{switch(e){default:case"INTERNAL":return 1;case"SERVER":return 2;case"CLIENT":return 3;case"PRODUCER":return 4;case"CONSUMER":return 5}},n=e=>(n,a)=>{let s=[];for(let e of n){let n,{kind:a,error:u,...i}=e.context;u&&(n={code:2},"message"in u&&(n.message=u.message)),s.push({traceId:e.id.trace_id,spanId:e.id.parent_id,parentSpanId:e.parent?.parent_id,name:e.name,kind:r(a||"INTERNAL"),startTimeUnixNano:1e6*e.start,endTimeUnixNano:e.end?1e6*e.end:void 0,droppedAttributesCount:0,droppedEventsCount:0,droppedLinksCount:0,attributes:t(i),status:n||{code:0},events:e.events.map((e=>({name:e.name,attributes:t(e.attributes),droppedAttributesCount:0,timeUnixNano:1e6*e.timestamp})))})}return e({resourceSpans:[{resource:{attributes:t(a),droppedAttributesCount:0},instrumentationLibrarySpans:[{instrumentationLibrary:{name:"rian",version:"0.3.0-next.1"},spans:s}]}]})};exports.exporter=n;

package/exporter.otel.http/index.mjs

@@ -1 +1 @@
-import{name as e,version as t}from"rian/package.json";var r=e=>{let t=typeof e,n={};return"string"===t?n.stringValue=e:"number"===t?Number.isInteger(e)?n.intValue=e:n.doubleValue=e:"boolean"===t?n.boolValue=e:Array.isArray(e)?n.arrayValue={values:e.map((e=>r(e)))}:e&&(n.kvlistValue={values:a(e)}),n},a=e=>{let t=[];for(let a of Object.keys(e))t.push({key:a,value:r(e[a])});return t},n=e=>{switch(e){default:case"INTERNAL":return 1;case"SERVER":return 2;case"CLIENT":return 3;case"PRODUCER":return 4;case"CONSUMER":return 5}},s=r=>(s,i)=>{let u=[];for(let e of s){let t,{kind:r,error:s,...i}=e.context;s&&(t={code:2},"message"in s&&(t.message=s.message)),u.push({traceId:e.id.trace_id,spanId:e.id.parent_id,parentSpanId:e.parent?.parent_id,name:e.name,kind:n(r||"INTERNAL"),startTimeUnixNano:1e6*e.start,endTimeUnixNano:e.end?1e6*e.end:void 0,droppedAttributesCount:0,droppedEventsCount:0,droppedLinksCount:0,attributes:a(i),status:t||{code:0},events:e.events.map((e=>({name:e.name,attributes:a(e.attributes),droppedAttributesCount:0,timeUnixNano:1e6*e.timestamp})))})}return r({resourceSpans:[{resource:{attributes:a(i),droppedAttributesCount:0},instrumentationLibrarySpans:[{instrumentationLibrary:{name:e,version:t},spans:u}]}]})};export{s as exporter};
+var e=r=>{let n=typeof r,a={};return"string"===n?a.stringValue=r:"number"===n?Number.isInteger(r)?a.intValue=r:a.doubleValue=r:"boolean"===n?a.boolValue=r:Array.isArray(r)?a.arrayValue={values:r.map((t=>e(t)))}:r&&(a.kvlistValue={values:t(r)}),a},t=t=>{let r=[];for(let n of Object.keys(t))r.push({key:n,value:e(t[n])});return r},r=e=>{switch(e){default:case"INTERNAL":return 1;case"SERVER":return 2;case"CLIENT":return 3;case"PRODUCER":return 4;case"CONSUMER":return 5}},n=e=>(n,a)=>{let s=[];for(let e of n){let n,{kind:a,error:u,...i}=e.context;u&&(n={code:2},"message"in u&&(n.message=u.message)),s.push({traceId:e.id.trace_id,spanId:e.id.parent_id,parentSpanId:e.parent?.parent_id,name:e.name,kind:r(a||"INTERNAL"),startTimeUnixNano:1e6*e.start,endTimeUnixNano:e.end?1e6*e.end:void 0,droppedAttributesCount:0,droppedEventsCount:0,droppedLinksCount:0,attributes:t(i),status:n||{code:0},events:e.events.map((e=>({name:e.name,attributes:t(e.attributes),droppedAttributesCount:0,timeUnixNano:1e6*e.timestamp})))})}return e({resourceSpans:[{resource:{attributes:t(a),droppedAttributesCount:0},instrumentationLibrarySpans:[{instrumentationLibrary:{name:"rian",version:"0.3.0-next.1"},spans:s}]}]})};export{n as exporter};

package/exporter.zipkin/index.js

@@ -1 +1 @@
-const { flattie:e } = require('flattie');var t=t=>(a,n)=>{let r=[];for(let t of a){let{kind:a,error:i,...s}=t.context;i&&(s.error=!("message"in i)||{name:i.name,message:i.message,stack:i.stack}),r.push({id:t.id.parent_id,traceId:t.id.trace_id,parentId:t.parent?t.parent.parent_id:void 0,name:t.name,kind:"INTERNAL"===a?void 0:a,timestamp:1e3*t.start,duration:t.end?1e3*(t.end-t.start):void 0,localEndpoint:n.localEndpoint||{serviceName:s["service.name"]},tags:e({...n,...s},".",!0),annotations:t.events.map((e=>({value:`${e.name} :: ${JSON.stringify(e.attributes)}`,timestamp:1e3*e.timestamp})))})}return t(r)};exports.exporter=t;
+const { flattie:e } = require('flattie');var t=t=>(a,r)=>{let n=[];for(let t of a){let{kind:a,error:i,...s}=t.context;i&&(s.error=!("message"in i)||{name:i.name,message:i.message,stack:i.stack}),n.push({id:t.id.parent_id,traceId:t.id.trace_id,parentId:t.parent?t.parent.parent_id:void 0,name:t.name,kind:"INTERNAL"===a?void 0:a,timestamp:1e3*t.start,duration:t.end?1e3*(t.end-t.start):void 0,localEndpoint:{serviceName:r["service.name"]},tags:e({...r,...s},".",!0),annotations:t.events.map((e=>({value:`${e.name} :: ${JSON.stringify(e.attributes)}`,timestamp:1e3*e.timestamp})))})}return t(n)};exports.exporter=t;

package/exporter.zipkin/index.mjs

@@ -1 +1 @@
-import{flattie as e}from"flattie";var t=t=>(a,n)=>{let r=[];for(let t of a){let{kind:a,error:i,...s}=t.context;i&&(s.error=!("message"in i)||{name:i.name,message:i.message,stack:i.stack}),r.push({id:t.id.parent_id,traceId:t.id.trace_id,parentId:t.parent?t.parent.parent_id:void 0,name:t.name,kind:"INTERNAL"===a?void 0:a,timestamp:1e3*t.start,duration:t.end?1e3*(t.end-t.start):void 0,localEndpoint:n.localEndpoint||{serviceName:s["service.name"]},tags:e({...n,...s},".",!0),annotations:t.events.map((e=>({value:`${e.name} :: ${JSON.stringify(e.attributes)}`,timestamp:1e3*e.timestamp})))})}return t(r)};export{t as exporter};
+import{flattie as e}from"flattie";var t=t=>(a,r)=>{let n=[];for(let t of a){let{kind:a,error:i,...s}=t.context;i&&(s.error=!("message"in i)||{name:i.name,message:i.message,stack:i.stack}),n.push({id:t.id.parent_id,traceId:t.id.trace_id,parentId:t.parent?t.parent.parent_id:void 0,name:t.name,kind:"INTERNAL"===a?void 0:a,timestamp:1e3*t.start,duration:t.end?1e3*(t.end-t.start):void 0,localEndpoint:{serviceName:r["service.name"]},tags:e({...r,...s},".",!0),annotations:t.events.map((e=>({value:`${e.name} :: ${JSON.stringify(e.attributes)}`,timestamp:1e3*e.timestamp})))})}return t(n)};export{t as exporter};

package/index.d.ts

@@ -1,3 +1,5 @@
+import type { Traceparent } from 'tctx';
+
 /**
  * Spans are units within a distributed trace. Spans encapsulate mainly 3 pieces of information, a
  * {@link Span.name|name}, and a {@link Span.start|start} and {@link Span.end|end} time.
@@ -93,7 +95,7 @@ export interface Scope {
 	/**
 	 * Forks the span into a new child span.
 	 */
-	fork(name: string): CallableScope;
+	span(name: string): CallableScope;
 
 	/**
 	 * Allows the span's context to be set. Passing an object will be `Object.assign`ed into the
@@ -116,8 +118,8 @@ export interface Scope {
 	end(): void;
 }
 
-export interface Tracer extends Omit<Scope, 'end'> {
-	end(): ReturnType<Exporter>;
+export interface Tracer extends Pick<Scope, 'span'> {
+	report(): ReturnType<Exporter>;
 }
 
 /**

package/index.js

@@ -1 +1 @@
-const { measureFn:e } = require('rian/utils');const t = require('tctx');var n=(e,n)=>!n||t.is_sampled(n),a={"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.2.3"},r=(r,o)=>{let s=new Set,d=new Set,i=o.sampler||n,p="boolean"!=typeof i,m=(n,a)=>{let r=p?i(n,a,o.context):i,c=a?a.child(r):t.make(r),l={id:c,parent:a,start:Date.now(),name:n,events:[],context:{}};r&&s.add(l);let x=t=>e(x,t);return x.traceparent=c,x.fork=e=>m(e,c),x.set_context=e=>{"function"!=typeof e?Object.assign(l.context,e):l.context=e(l.context)},x.add_event=(e,t)=>{l.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},x.end=()=>{null==l.end&&(l.end=Date.now())},x.__add_promise=d.add.bind(d),x},c=m(r,"string"==typeof o.traceparent?t.parse(o.traceparent):void 0),l=c.end.bind(c);return c.end=async()=>(l(),d.size>0&&await Promise.all([...d.values()]),o.exporter(s,{...o.context||{},...a})),c};exports.create=r;
+const { measureFn:e } = require('rian/utils');const t = require('tctx');var n=(e,n)=>!n||t.is_sampled(n),a=(a,r)=>{let o=new Set,s=new Set,i=r.sampler||n,d="boolean"!=typeof i,p=r.context||{};p["service.name"]=a,p["telemetry.sdk.name"]="rian",p["telemetry.sdk.version"]="0.3.0-next.1";let m="string"==typeof r.traceparent?t.parse(r.traceparent):void 0,c=(n,a)=>{let p=d?i(n,a,r.context):i,m=a?a.child(p):t.make(p),l={id:m,parent:a,start:Date.now(),name:n,events:[],context:{}};p&&o.add(l);let x=t=>e(x,t);return x.traceparent=m,x.span=e=>c(e,m),x.set_context=e=>"function"==typeof e?void(l.context=e(l.context)):void Object.assign(l.context,e),x.add_event=(e,t)=>{l.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},x.end=()=>{null==l.end&&(l.end=Date.now())},x.__add_promise=s.add.bind(s),x};return{span:e=>c(e,m),report:async()=>(s.size>0&&await Promise.all([...s.values()]),r.exporter(o,p))}};exports.create=a;

package/index.mjs

@@ -1 +1 @@
-import{measureFn as e}from"rian/utils";import*as t from"tctx";var n=(e,n)=>!n||t.is_sampled(n),a={"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.2.3"},r=(r,o)=>{let s=new Set,d=new Set,i=o.sampler||n,p="boolean"!=typeof i,m=(n,a)=>{let r=p?i(n,a,o.context):i,c=a?a.child(r):t.make(r),l={id:c,parent:a,start:Date.now(),name:n,events:[],context:{}};r&&s.add(l);let x=t=>e(x,t);return x.traceparent=c,x.fork=e=>m(e,c),x.set_context=e=>{"function"!=typeof e?Object.assign(l.context,e):l.context=e(l.context)},x.add_event=(e,t)=>{l.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},x.end=()=>{null==l.end&&(l.end=Date.now())},x.__add_promise=d.add.bind(d),x},c=m(r,"string"==typeof o.traceparent?t.parse(o.traceparent):void 0),l=c.end.bind(c);return c.end=async()=>(l(),d.size>0&&await Promise.all([...d.values()]),o.exporter(s,{...o.context||{},...a})),c};export{r as create};
+import{measureFn as e}from"rian/utils";import*as t from"tctx";var n=(e,n)=>!n||t.is_sampled(n),a=(a,r)=>{let o=new Set,s=new Set,i=r.sampler||n,d="boolean"!=typeof i,p=r.context||{};p["service.name"]=a,p["telemetry.sdk.name"]="rian",p["telemetry.sdk.version"]="0.3.0-next.1";let m="string"==typeof r.traceparent?t.parse(r.traceparent):void 0,c=(n,a)=>{let p=d?i(n,a,r.context):i,m=a?a.child(p):t.make(p),l={id:m,parent:a,start:Date.now(),name:n,events:[],context:{}};p&&o.add(l);let x=t=>e(x,t);return x.traceparent=m,x.span=e=>c(e,m),x.set_context=e=>"function"==typeof e?void(l.context=e(l.context)):void Object.assign(l.context,e),x.add_event=(e,t)=>{l.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},x.end=()=>{null==l.end&&(l.end=Date.now())},x.__add_promise=s.add.bind(s),x};return{span:e=>c(e,m),report:async()=>(s.size>0&&await Promise.all([...s.values()]),r.exporter(o,p))}};export{a as create};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rian",
-	"version": "0.2.3",
+	"version": "0.3.0-next.1",
 	"description": "Effective tracing for the edge and origins",
 	"keywords": [
 		"opentelemetry",
@@ -19,7 +19,6 @@
 	"license": "MIT",
 	"author": "Marais Rossow <me@marais.dev> (https://marais.io)",
 	"sideEffects": false,
-	"type": "module",
 	"exports": {
 		".": {
 			"types": "./index.d.ts",

package/readme.md

@@ -28,7 +28,7 @@
 
 - 🤔 **Familiar** — looks very much like OpenTracing.
 
-- ✅ **Simple** — `create` a tracer, and `.end()` a tracer, done.
+- ✅ **Simple** — `create` a tracer, and `.report()` a tracer, done.
 
 - 🏎 **Performant** — check the [benchmarks](#-benchmark).
 
@@ -52,21 +52,23 @@ const otel_endpoint = exporter((payload) =>
 );
 
 // ~> Create a tracer — typically "per request" or "per operation"
-const tracer = create('GET ~> /data', {
+const tracer = create('my-service', {
   exporter: otel_endpoint,
 });
 
 // Let us trace
 
-tracer.set_context({
+const req = tracer.span('GET ~> /data');
+
+req.set_context({
   user: request_context.user_id,
 });
 
 // ~> Wrap any method and be timed 🕺🏻
-const data = await measure(tracer.fork('db::read'), get_data);
+const data = await measure(req.span('db::read'), get_data);
 
 // ~> Maybe have some in-flow spanning
-const span = tracer.span('process records');
+const span = req.span('process records');
 
 for (let row of data) {
   span.add_event('doing stuff', { id: row.id });
@@ -75,8 +77,10 @@ for (let row of data) {
 
 span.end();
 
+req.end();
+
 // ~> And finally let's export — will also end the root span.
-await tracer.end();
+await tracer.report();
 
 /*
 And we end up with something like this in our reporting tool:
@@ -101,50 +105,10 @@ The main and _default_ module responsible for creating and provisioning spans.
 
 Exports the spans created using the zipkin protocol and leaves the shipping up to you.
 
-> 💡 Note ~> with the nature of zipkin, the `localEndpoint` must be set in your span context.
->
-> <details><summary>Example</summary>
->
-> ```ts
-> const tracer = create('example', {
->   context: {
->     localEndpoint: {
->       serviceName: 'my-service', // 👈 important part
->     },
->   },
-> });
-> ```
->
-> Both of these are functionally equivalent. `service.name` will be used if no `localEndpoint.serviceName` is set.
->
-> ```ts
-> const tracer = create('example', {
->   context: {
->     'service.name': 'my-service',
->   },
-> });
-> ```
->
-> </details>
-
 #### Module: [`rian/exporter.otel.http`](./packages/rian/src/exporter.otel.http.ts)
 
 Implements the OpenTelemetry protocol for use with http transports.
 
-> 💡 Note ~> services require a `service.name` context value.
->
-> <details><summary>Example</summary>
->
-> ```ts
-> const tracer = create('example', {
->   context: {
->     'service.name': 'my-service', // 👈 important part
->   },
-> });
-> ```
->
-> </details>
-
 ## 🧑‍🍳 Exporter Recipes
 
 <details><summary>NewRelic</summary>
@@ -166,10 +130,7 @@ const newrelic = exporter((payload) =>
   }),
 );
 
-const tracer = create('example', {
-  context: {
-    'service.name': 'my-service', // 👈 important part
-  },
+const tracer = create('my-service', {
   exporter: newrelic,
 });
 ```
@@ -195,10 +156,7 @@ const lightstep = exporter((payload) =>
   }),
 );
 
-const tracer = create('example', {
-  context: {
-    'service.name': 'my-service', // 👈 important part
-  },
+const tracer = create('my-service', {
   exporter: lightstep,
 });
 ```
@@ -249,9 +207,9 @@ Validation :: single span
 ✔ opentracing
 
 Benchmark :: single span
-  rian                   x 137,181 ops/sec ±2.82% (82 runs sampled)
-  opentelemetry          x 114,197 ops/sec ±11.37% (75 runs sampled)
-  opentracing            x  33,363 ops/sec ±1.27% (89 runs sampled)
+  rian                   x 392,796 ops/sec ±3.73% (86 runs sampled)
+  opentelemetry          x 205,544 ops/sec ±11.98% (65 runs sampled)
+  opentracing            x  60,043 ops/sec ±35.25% (97 runs sampled)
 
 Validation :: child span
 ✔ rian
@@ -259,10 +217,9 @@ Validation :: child span
 ✔ opentracing
 
 Benchmark :: child span
-  rian                   x 75,567 ops/sec ±7.95% (77 runs sampled)
-  opentelemetry          x 65,618 ops/sec ±8.45% (82 runs sampled)
-  opentracing            x 15,452 ops/sec ±15.35% (77 runs sampled)
-
+  rian                   x 208,186 ops/sec ±6.28% (82 runs sampled)
+  opentelemetry          x 121,740 ops/sec ±16.56% (62 runs sampled)
+  opentracing            x  37,405 ops/sec ±0.48% (99 runs sampled)
 ```
 
 > And please... I know these results are anything but the full story. But it's a number and point on comparison.

package/utils/index.d.ts

@@ -17,20 +17,19 @@ export type MeasureFn =
  * @example
  *
  * ```text
- * const data = await measure(scope, 'name', get_data, 'user_id_123');
- *        ^                    ^      ^       ^          ^
- *        |                    |      |       |          |
- *        |                    |      |       |          the first argument to get_data
- *        |                    |      |       function to be called
- *        |                    |      the name of the sub scope
- *        |                    |
- *        |                    the parent scope
- *         return value from get_data
+ * const data = await measure(scope, get_data, 'user_id_123');
+ *       ^                    ^     ^          ^
+ *       |                    |     |          |
+ *       |                    |     |          the first argument to get_data
+ *       |                    |     |
+ *       |                    |     function to be called
+ *       |                    |
+ *       |                    the parent scope
+ *       return value from get_data
  * ```
  */
 export const measure: <Fn extends MeasureFn>(
 	scope: Scope,
-	name: string,
 	fn: Fn, // TODO: fn doesnt see scope correctly
 	...args: RealMeasureFnParams<Parameters<Fn>>
 ) => ReturnType<Fn>;
@@ -51,7 +50,6 @@ export const measure: <Fn extends MeasureFn>(
  */
 export const wrap: <Fn extends MeasureFn>(
 	scope: Scope,
-	name: string,
 	fn: Fn, // TODO: fn doesnt see scope correctly
 ) => Fn;
 

package/utils/index.js

@@ -1 +1 @@
-var r=(r,t,...e)=>{try{var n=t(...e,r),o=n instanceof Promise;return o&&r.__add_promise(n.catch((t=>{r.set_context({error:t})})).finally((()=>r.end()))),n}catch(t){throw t instanceof Error&&r.set_context({error:t}),t}finally{!0!==o&&r.end()}},t=(t,e,n,...o)=>r(t.fork(e),n,...o),e=(t,e,n)=>function(){return r(t.fork(e),n,...arguments)};exports.measure=t;exports.measureFn=r;exports.wrap=e;
+var r=(r,t,...e)=>{try{var n=t(...e,r),o=n instanceof Promise;return o&&r.__add_promise(n.catch((t=>{r.set_context({error:t})})).finally((()=>r.end()))),n}catch(t){throw t instanceof Error&&r.set_context({error:t}),t}finally{!0!==o&&r.end()}},t=(t,e,...n)=>r(t,e,...n),e=(t,e)=>function(){return r(t,e,...arguments)};exports.measure=t;exports.measureFn=r;exports.wrap=e;

package/utils/index.mjs

@@ -1 +1 @@
-var r=(r,t,...e)=>{try{var n=t(...e,r),o=n instanceof Promise;return o&&r.__add_promise(n.catch((t=>{r.set_context({error:t})})).finally((()=>r.end()))),n}catch(t){throw t instanceof Error&&r.set_context({error:t}),t}finally{!0!==o&&r.end()}},t=(t,e,n,...o)=>r(t.fork(e),n,...o),e=(t,e,n)=>function(){return r(t.fork(e),n,...arguments)};export{t as measure,r as measureFn,e as wrap};
+var r=(r,t,...e)=>{try{var n=t(...e,r),o=n instanceof Promise;return o&&r.__add_promise(n.catch((t=>{r.set_context({error:t})})).finally((()=>r.end()))),n}catch(t){throw t instanceof Error&&r.set_context({error:t}),t}finally{!0!==o&&r.end()}},t=(t,e,...n)=>r(t,e,...n),e=(t,e)=>function(){return r(t,e,...arguments)};export{t as measure,r as measureFn,e as wrap};