rian 0.3.0-next.8 → 0.3.0

package/async.d.ts

@@ -1,6 +1,59 @@
-import type { CallableScope, Scope, Span } from 'rian';
+import type { CallableScope, Options, Scope } from 'rian';
 
-export function currentSpan(): Scope | null;
+export { report, configure } from 'rian';
+
+/**
+ * Returns the current span in the current execution context.
+ *
+ * This will throw an error if there is no current span.
+ *
+ * @example
+ *
+ * ```ts
+ * function doWork() {
+ *   const span = currentSpan();
+ *   span.set_context({ foo: 'bar' });
+ * }
+ *
+ * span('some-name')(() => {
+ *   doWork(); // will guarantee `currentSpan` returns this span
+ * });
+ * ```
+ */
+export function currentSpan(): Scope;
+
+/**
+ * Creates a new span for the currently active tracer.
+ *
+ * @example
+ *
+ * ```ts
+ * tracer('some-name')(() => {
+ *    // some deeply nested moments later
+ *    const s = span('my-span');
+ * });
+ * ```
+ */
 export function span(name: string): CallableScope;
 
-export { tracer, report, configure } from 'rian';
+export type Tracer<T> = (cb: T) => ReturnType<T>;
+
+/**
+ * A tracer is a logical unit in your application. This alleviates the need to pass around a tracer instance.
+ *
+ * All spans produced by a tracer will all collect into a single span collection that is given to {@link report}.
+ *
+ * @example
+ *
+ * ```ts
+ * const trace = tracer('server');
+ *
+ * trace(() => {
+ *  // application logic
+ * });
+ * ```
+ */
+export function tracer<T extends () => any>(
+	name: string,
+	options?: Options,
+): Tracer<T>;

package/async.js

@@ -1 +1 @@
-const { default:e } = require('node:async_hooks');const { measure:t } = require('rian/utils');const { make:n, parse:r, SAMPLED_FLAG:a } = require('tctx');const { is_sampled:o } = require('tctx');var s={};function l(e,t={}){s={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0-next.8"}}var p=new Set,c=new WeakMap;async function i(e){let t=[],n=new Map;for(let[e,r]of p){let a;n.has(r)?a=n.get(r).spans:n.set(r,{scope:r,spans:a=[]}),a.push(e),c.has(r)&&(t.push(...c.get(r)),c.delete(r))}return p.clear(),t.length&&await Promise.all(t),e({resource:s,scopeSpans:n.values()})}function u(e,t){return o(t)}var d=new e.AsyncLocalStorage;function m(){return d.getStore()?.[1]||null}function f(e){let r=d.getStore();if(!r)throw Error("TODO");let a=r[0],o=a.scope,s=r[1],l=a.sampler,i=s?.traceparent??a.root_id,u=i?i.child():n(),m="boolean"!=typeof l?l(e,u,o):l;u.flags;let g={id:u,parent:i,start:Date.now(),name:e,events:[],context:{}};m&&p.add([g,o]);let h=e=>d.run([a,h],t,h,e);h.traceparent=u,h.span=f,h.set_context=e=>{"function"!=typeof e?Object.assign(g.context,e):g.context=e(g.context)},h.add_event=(e,t)=>{g.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},h.end=()=>{null==g.end&&(g.end=Date.now())};let w=c.get(o);return h.__add_promise=e=>{w.add(e),e.then((()=>w.delete(e)))},d.run([a,h],(()=>h))}function g(e,t){let n=t?.sampler??u,a={name:e},o={root_id:"string"==typeof t?.traceparent?r(t.traceparent):d.getStore()?.[0].root_id,scope:a,sampler:n};return c.set(a,new Set),{span:e=>d.run([o,null],f,e)}}exports.configure=l;exports.currentSpan=m;exports.report=i;exports.span=f;exports.tracer=g;
+const e = require('node:async_hooks');const { measure:t } = require('rian/utils');const { make:n, parse:r, SAMPLED_FLAG:o } = require('tctx');const { is_sampled:a } = require('tctx');var s={};function c(e,t={}){s={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0"}}var l=new Set,i=new WeakMap;async function p(e){let t=[],n=new Map;for(let[e,r]of l){let o;n.has(r)?o=n.get(r).spans:n.set(r,{scope:r,spans:o=[]}),o.push(e),i.has(r)&&(t.push(...i.get(r)),i.delete(r))}return l.clear(),t.length&&await Promise.all(t),e({resource:s,scopeSpans:n.values()})}function u(e,t){return a(t)}var d=new e.AsyncLocalStorage;function m(){let e=d.getStore()?.[1];if(null==e)throw new Error("no current span");return e}function f(e){let r=d.getStore();if(!r)throw Error("TODO");let o=r[0],a=o.scope,s=r[1],c=o.sampler,p=s?.traceparent??o.root_id,u=p?p.child():n(),m="boolean"!=typeof c?c(e,u,a):c;u.flags;let w={id:u,parent:p,start:o.clock.now(),name:e,events:[],context:{}};m&&l.add([w,a]);let g=e=>d.run([o,g],t,g,e);g.traceparent=u,g.span=f,g.set_context=e=>{"function"!=typeof e?Object.assign(w.context,e):w.context=e(w.context)},g.add_event=(e,t)=>{w.events.push({name:e,timestamp:o.clock.now(),attributes:t||{}})},g.end=()=>{null==w.end&&(w.end=o.clock.now())};let h=i.get(a);return g.__add_promise=e=>{h.add(e),e.then((()=>h.delete(e)))},g}function w(e,t){let n=t?.sampler??u,o={name:e},a={root_id:"string"==typeof t?.traceparent?r(t.traceparent):void 0,scope:o,sampler:n,clock:t?.clock??Date};return i.set(o,new Set),function(e){let t=d.getStore();return a.root_id||(a.root_id=t?.[0].root_id),d.run([a,t?.[1]||null],e)}}exports.configure=c;exports.currentSpan=m;exports.report=p;exports.span=f;exports.tracer=w;

package/async.mjs

@@ -1 +1 @@
-import{default as e}from"node:async_hooks";import{measure as t}from"rian/utils";import{make as n,parse as r,SAMPLED_FLAG as a}from"tctx";import{is_sampled as o}from"tctx";var s={};function l(e,t={}){s={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0-next.8"}}var p=new Set,c=new WeakMap;async function i(e){let t=[],n=new Map;for(let[e,r]of p){let a;n.has(r)?a=n.get(r).spans:n.set(r,{scope:r,spans:a=[]}),a.push(e),c.has(r)&&(t.push(...c.get(r)),c.delete(r))}return p.clear(),t.length&&await Promise.all(t),e({resource:s,scopeSpans:n.values()})}function u(e,t){return o(t)}var d=new e.AsyncLocalStorage;function m(){return d.getStore()?.[1]||null}function f(e){let r=d.getStore();if(!r)throw Error("TODO");let a=r[0],o=a.scope,s=r[1],l=a.sampler,i=s?.traceparent??a.root_id,u=i?i.child():n(),m="boolean"!=typeof l?l(e,u,o):l;u.flags;let g={id:u,parent:i,start:Date.now(),name:e,events:[],context:{}};m&&p.add([g,o]);let h=e=>d.run([a,h],t,h,e);h.traceparent=u,h.span=f,h.set_context=e=>{"function"!=typeof e?Object.assign(g.context,e):g.context=e(g.context)},h.add_event=(e,t)=>{g.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},h.end=()=>{null==g.end&&(g.end=Date.now())};let w=c.get(o);return h.__add_promise=e=>{w.add(e),e.then((()=>w.delete(e)))},d.run([a,h],(()=>h))}function g(e,t){let n=t?.sampler??u,a={name:e},o={root_id:"string"==typeof t?.traceparent?r(t.traceparent):d.getStore()?.[0].root_id,scope:a,sampler:n};return c.set(a,new Set),{span:e=>d.run([o,null],f,e)}}export{l as configure,m as currentSpan,i as report,f as span,g as tracer};
+import*as e from"node:async_hooks";import{measure as t}from"rian/utils";import{make as n,parse as r,SAMPLED_FLAG as o}from"tctx";import{is_sampled as a}from"tctx";var s={};function c(e,t={}){s={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0"}}var l=new Set,i=new WeakMap;async function p(e){let t=[],n=new Map;for(let[e,r]of l){let o;n.has(r)?o=n.get(r).spans:n.set(r,{scope:r,spans:o=[]}),o.push(e),i.has(r)&&(t.push(...i.get(r)),i.delete(r))}return l.clear(),t.length&&await Promise.all(t),e({resource:s,scopeSpans:n.values()})}function u(e,t){return a(t)}var d=new e.AsyncLocalStorage;function m(){let e=d.getStore()?.[1];if(null==e)throw new Error("no current span");return e}function f(e){let r=d.getStore();if(!r)throw Error("TODO");let o=r[0],a=o.scope,s=r[1],c=o.sampler,p=s?.traceparent??o.root_id,u=p?p.child():n(),m="boolean"!=typeof c?c(e,u,a):c;u.flags;let w={id:u,parent:p,start:o.clock.now(),name:e,events:[],context:{}};m&&l.add([w,a]);let g=e=>d.run([o,g],t,g,e);g.traceparent=u,g.span=f,g.set_context=e=>{"function"!=typeof e?Object.assign(w.context,e):w.context=e(w.context)},g.add_event=(e,t)=>{w.events.push({name:e,timestamp:o.clock.now(),attributes:t||{}})},g.end=()=>{null==w.end&&(w.end=o.clock.now())};let h=i.get(a);return g.__add_promise=e=>{h.add(e),e.then((()=>h.delete(e)))},g}function w(e,t){let n=t?.sampler??u,o={name:e},a={root_id:"string"==typeof t?.traceparent?r(t.traceparent):void 0,scope:o,sampler:n,clock:t?.clock??Date};return i.set(o,new Set),function(e){let t=d.getStore();return a.root_id||(a.root_id=t?.[0].root_id),d.run([a,t?.[1]||null],e)}}export{c as configure,m as currentSpan,p as report,f as span,w as tracer};

package/index.d.ts

@@ -3,8 +3,7 @@ import type { Traceparent } from 'tctx';
 // --- tracer
 
 /**
- * An exporter is a method called when the parent scope ends, gets given a Set of all spans traced
- * during this execution.
+ * The exporter is called when the {@link report} method is called.
  */
 export type Exporter = (trace: {
 	resource: Context;
@@ -23,12 +22,14 @@ export type Options = {
 	sampler?: Sampler | boolean;
 
 	/**
-	 * A root, or extracted w3c traceparent stringed header.
+	 * A root, or extracted w3c traceparent string header.
 	 *
 	 * If the id is malformed, the {@link create} method will throw an exception. If no root is
-	 * provided then one will be created obeying the {@link Options.sampler|sampling} rules.
+	 * provided then one will be created obeying the {@link Options.sampler|sampling} rules on each span.
 	 */
 	traceparent?: string | null;
+
+	clock?: ClockLike;
 };
 
 export type Tracer = Pick<Scope, 'span'>;
@@ -41,17 +42,24 @@ export type Context = {
 };
 
 /**
- * Should return true when you want to sample the span, this is ran before the span is traced — so
- * decisions is made preemptively.
- *
- * Returning false will not include this span in the {@link Exporter}.
+ * Allows a sampling decision to be made. This method will influence the {@link Span.id|traceparent} sampling flag.
  *
- * Sampling does impact the traceparent, for injection — and is encoded there.
+ * Return true if the span should be sampled, and reported to the {@link Exporter}.
+ * Return false if the span should not be sampled, and not reported to the {@link Exporter}.
  */
 export type Sampler = (
+	/**
+	 * The name of the span.
+	 */
 	readonly name: string,
+	/**
+	 * The traceparent id of the span.
+	 */
 	readonly id: Traceparent,
-	readonly scope: { readonly name: string },
+	/**
+	 * The tracer this span belongs to.
+	 */
+	readonly tracer: { readonly name: string },
 ) => boolean;
 
 // --- spans
@@ -61,20 +69,15 @@ export type Sampler = (
  * {@link Span.name|name}, and a {@link Span.start|start} and {@link Span.end|end} time.
  *
  * Each span should be named, not too vague, and not too precise. For example, "resolve_user_ids"
- * and not "resolver_user_ids[1,2,3]" nor "resolve".
+ * and not "resolver_user_ids[1,2,3]" nor "resolver".
  *
  * A span forms part of a wider trace, and can be visualized like:
  *
  * ```plain
  *  [Span A················································(2ms)]
  *    [Span B·········································(1.7ms)]
- *       [Span D···············(0.8ms)]  [Span C......(0.6ms)]
+ *       [Span D···············(0.8ms)] [Span C......(0.6ms)]
  * ```
- *
- * ---
- *
- * Spans are aimed to interoperate with
- * {@link https://github.com/opentracing/specification/blob/master/specification.md|OpenTracing's Spans}, albeit not entirely api compatible — they do share principles.
  */
 export type Span = {
 	/**
@@ -82,6 +85,7 @@ export type Span = {
 	 * or stage of the larger stack.
 	 *
 	 * @example
+	 *
 	 * "resolve_user_ids"
 	 * "[POST] /api"
 	 */
@@ -105,7 +109,7 @@ export type Span = {
 	/**
 	 * The time represented as a UNIX epoch timestamp in milliseconds when this span was created.
 	 * Typically, via
-	 * {@link Scope.fork|tracer.fork()}.
+	 * {@link Scope.span|scope.span()}.
 	 */
 	start: number;
 
@@ -119,7 +123,7 @@ export type Span = {
 	 * An arbitrary context object useful for storing information during a trace.
 	 *
 	 * Usually following a convention such as `tag.*`, `http.*` or any of the
-	 * {@link https://github.com/opentracing/specification/blob/master/semantic_conventions.md|Semantic Conventions outlined by OpenTracing}.
+	 * {@link https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/|OpenTelemetry Trace Semantic Conventions}.
 	 *
 	 * ### Note!
 	 *
@@ -153,7 +157,12 @@ export type Scope = {
 	/**
 	 * Forks the span into a new child span.
 	 */
-	span(name: string): CallableScope;
+	span(
+		/**
+		 * @borrows {@link Span.name}
+		 */
+		name: string,
+	): CallableScope;
 
 	/**
 	 * Allows the span's context to be set. Passing an object will be `Object.assign`ed into the
@@ -177,13 +186,33 @@ export type Scope = {
 };
 
 export type CallableScope = Scope & {
-	(cb: (scope: Omit<Scope, 'end'>) => void): ReturnType<typeof cb>;
+	<Fn extends (scope: Omit<Scope, 'end'>) => any>(cb: Fn): ReturnType<Fn>;
 };
 
 // --- main api
 
+/**
+ * A tracer is a logical unit in your application. This alleviates the need to pass around a tracer instance.
+ *
+ * All spans produced by a tracer will all collect into a single span collection that is given to {@link report}.
+ *
+ * @example
+ *
+ * ```ts
+ * // file: server.ts
+ * const trace = tracer('server');
+ *
+ * // file: orm.ts
+ * const trace = tracer('orm');
+ *
+ * // file: api.ts
+ * const trace = tracer('api');
+ * ```
+ */
 export function tracer(name: string, options?: Options): Tracer;
 
+// -- general api
+
 /**
  * Awaits all active promises, and then calls the {@link Options.exporter|exporter}. Passing all collected spans.
  */
@@ -191,5 +220,30 @@ export async function report<T extends Exporter>(
 	exporter: T,
 ): Promise<ReturnType<T>>;
 
-// TODO
+/**
+ * Calling this method will set the resource attributes for this runtime. This is useful for things like:
+ * - setting the deployment environment of the application
+ * - setting the k8s namespace
+ * - ...
+ *
+ * The `name` argument will set the `service.name` attribute. And is required.
+ *
+ * The fields can be whatever you want, but it is recommended to follow the {@link https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/|OpenTelemetry Resource Semantic Conventions}.
+ *
+ * @example
+ *
+ * ```ts
+ * configure('my-service', { 'deployment.environment': 'production', 'k8s.namespace.name': 'default' });
+ * ```
+ */
 export function configure(name: string, attributes: Context = {}): void;
+
+/**
+ * Provinding a clock allows you to control the time of the span.
+ */
+export type ClockLike = {
+	/**
+	 * Must return the number of milliseconds since the epoch.
+	 */
+	now(): number;
+};

package/index.js

@@ -1 +1 @@
-const { measureFn:e } = require('rian/utils');const { make:t, parse:n, SAMPLED_FLAG:a } = require('tctx');const { is_sampled:r } = require('tctx');var s={};function o(e,t={}){s={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0-next.8"}}var p=new Set,i=new WeakMap;async function l(e){let t=[],n=new Map;for(let[e,a]of p){let r;n.has(a)?r=n.get(a).spans:n.set(a,{scope:a,spans:r=[]}),r.push(e),i.has(a)&&(t.push(...i.get(a)),i.delete(a))}return p.clear(),t.length&&await Promise.all(t),e({resource:s,scopeSpans:n.values()})}function c(e,t){return r(t)}function d(a,r){let s=r?.sampler??c,o={name:a},l=new Set;i.set(o,l);let d="string"==typeof r?.traceparent?n(r.traceparent):void 0,m=(n,a)=>{let r=a?a.child():t(),i="boolean"!=typeof s?s(n,r,o):s;r.flags;let c={id:r,parent:a,start:Date.now(),name:n,events:[],context:{}};i&&p.add([c,o]);let d=t=>e(d,t);return d.traceparent=r,d.span=e=>m(e,r),d.set_context=e=>"function"==typeof e?void(c.context=e(c.context)):void Object.assign(c.context,e),d.add_event=(e,t)=>{c.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},d.end=()=>{null==c.end&&(c.end=Date.now())},d.__add_promise=e=>{l.add(e),e.then((()=>l.delete(e)))},d};return{span:e=>m(e,d)}}exports.configure=o;exports.report=l;exports.tracer=d;
+const { measure:e } = require('rian/utils');const { make:t, parse:n, SAMPLED_FLAG:a } = require('tctx');const { is_sampled:r } = require('tctx');var o={};function s(e,t={}){o={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0"}}var p=new Set,c=new WeakMap;async function i(e){let t=[],n=new Map;for(let[e,a]of p){let r;n.has(a)?r=n.get(a).spans:n.set(a,{scope:a,spans:r=[]}),r.push(e),c.has(a)&&(t.push(...c.get(a)),c.delete(a))}return p.clear(),t.length&&await Promise.all(t),e({resource:o,scopeSpans:n.values()})}function l(e,t){return r(t)}function d(a,r){let o=r?.sampler??l,s=r?.clock??Date,i={name:a},d=new Set;c.set(i,d);let m="string"==typeof r?.traceparent?n(r.traceparent):void 0,u=(n,a)=>{let r=a?a.child():t(),c="boolean"!=typeof o?o(n,r,i):o;r.flags;let l={id:r,parent:a,start:s.now(),name:n,events:[],context:{}};c&&p.add([l,i]);let m=t=>e(m,t);return m.traceparent=r,m.span=e=>u(e,r),m.set_context=e=>"function"==typeof e?void(l.context=e(l.context)):void Object.assign(l.context,e),m.add_event=(e,t)=>{l.events.push({name:e,timestamp:s.now(),attributes:t||{}})},m.end=()=>{null==l.end&&(l.end=s.now())},m.__add_promise=e=>{d.add(e),e.then((()=>d.delete(e)))},m};return{span:e=>u(e,m)}}exports.configure=s;exports.report=i;exports.tracer=d;

package/index.mjs

@@ -1 +1 @@
-import{measureFn as e}from"rian/utils";import{make as t,parse as n,SAMPLED_FLAG as a}from"tctx";import{is_sampled as r}from"tctx";var s={};function o(e,t={}){s={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0-next.8"}}var p=new Set,i=new WeakMap;async function l(e){let t=[],n=new Map;for(let[e,a]of p){let r;n.has(a)?r=n.get(a).spans:n.set(a,{scope:a,spans:r=[]}),r.push(e),i.has(a)&&(t.push(...i.get(a)),i.delete(a))}return p.clear(),t.length&&await Promise.all(t),e({resource:s,scopeSpans:n.values()})}function c(e,t){return r(t)}function d(a,r){let s=r?.sampler??c,o={name:a},l=new Set;i.set(o,l);let d="string"==typeof r?.traceparent?n(r.traceparent):void 0,m=(n,a)=>{let r=a?a.child():t(),i="boolean"!=typeof s?s(n,r,o):s;r.flags;let c={id:r,parent:a,start:Date.now(),name:n,events:[],context:{}};i&&p.add([c,o]);let d=t=>e(d,t);return d.traceparent=r,d.span=e=>m(e,r),d.set_context=e=>"function"==typeof e?void(c.context=e(c.context)):void Object.assign(c.context,e),d.add_event=(e,t)=>{c.events.push({name:e,timestamp:Date.now(),attributes:t||{}})},d.end=()=>{null==c.end&&(c.end=Date.now())},d.__add_promise=e=>{l.add(e),e.then((()=>l.delete(e)))},d};return{span:e=>m(e,d)}}export{o as configure,l as report,d as tracer};
+import{measure as e}from"rian/utils";import{make as t,parse as n,SAMPLED_FLAG as a}from"tctx";import{is_sampled as r}from"tctx";var o={};function s(e,t={}){o={...t,"service.name":e,"telemetry.sdk.name":"rian","telemetry.sdk.version":"0.3.0"}}var p=new Set,c=new WeakMap;async function i(e){let t=[],n=new Map;for(let[e,a]of p){let r;n.has(a)?r=n.get(a).spans:n.set(a,{scope:a,spans:r=[]}),r.push(e),c.has(a)&&(t.push(...c.get(a)),c.delete(a))}return p.clear(),t.length&&await Promise.all(t),e({resource:o,scopeSpans:n.values()})}function l(e,t){return r(t)}function d(a,r){let o=r?.sampler??l,s=r?.clock??Date,i={name:a},d=new Set;c.set(i,d);let m="string"==typeof r?.traceparent?n(r.traceparent):void 0,u=(n,a)=>{let r=a?a.child():t(),c="boolean"!=typeof o?o(n,r,i):o;r.flags;let l={id:r,parent:a,start:s.now(),name:n,events:[],context:{}};c&&p.add([l,i]);let m=t=>e(m,t);return m.traceparent=r,m.span=e=>u(e,r),m.set_context=e=>"function"==typeof e?void(l.context=e(l.context)):void Object.assign(l.context,e),m.add_event=(e,t)=>{l.events.push({name:e,timestamp:s.now(),attributes:t||{}})},m.end=()=>{null==l.end&&(l.end=s.now())},m.__add_promise=e=>{d.add(e),e.then((()=>d.delete(e)))},m};return{span:e=>u(e,m)}}export{s as configure,i as report,d as tracer};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "rian",
-	"version": "0.3.0-next.8",
+	"version": "0.3.0",
 	"description": "Effective tracing for the edge and origins",
 	"keywords": [
 		"opentelemetry",

package/readme.md

@@ -6,9 +6,6 @@
 
 <p><code>npm add rian</code> doesn't overcomplicate tracing</p>
 <span>
-<a href="https://github.com/maraisr/rian/actions/workflows/ci.yml">
-	<img src="https://github.com/maraisr/rian/actions/workflows/ci.yml/badge.svg"/>
-</a>
 <a href="https://npm-stat.com/charts.html?package=rian">
 	<img src="https://badgen.net/npm/dw/rian?labelColor=black&color=black&cache=600" alt="downloads"/>
 </a>
@@ -26,78 +23,136 @@
 
 ## ⚡ Features
 
-- 🤔 **Familiar** — looks very much like OpenTracing.
+- 🤔 **Familiar** — looks very much like opentelemetry.
 
-- ✅ **Simple** — `create` a tracer, and `report()`, done.
+- ✅ **Simple** — `configure()` an environment, create a `tracer()`, `report()` and done.
 
 - 🏎 **Performant** — check the [benchmarks](#-benchmark).
 
-- 🪶 **Lightweight** — a mere 1Kb and next to no [dependencies](https://npm.anvaka.com/#/view/2d/rian/).
+- 🪶 **Lightweight** — a mere 1KB and next to no [dependencies](https://npm.anvaka.com/#/view/2d/rian/).
 
 ## 🚀 Usage
 
-> Visit [/examples](/examples) for more info!
+> Visit [/examples](/examples) for more!
 
 ```ts
-import { create, report } from 'rian';
-import { measure } from 'rian/utils';
+import { configure, tracer, report } from 'rian';
 import { exporter } from 'rian/exporter.otel.http';
 
-// ~> Where to send the spans.
-const otel_endpoint = exporter((payload) =>
-  fetch('/traces/otlp', {
-    method: 'POST',
-    body: JSON.stringify(payload),
-  }),
-);
+// ~> configure the environment, all tracers will inherit this
+configure('my-service' {
+  'service.version': 'DEV'
+});
 
-// ~> Create a tracer — typically "per request" or "per operation"
-const tracer = create('my-service');
+// ~> create a tracer — typically "per request" or "per operation".
+const trace = tracer('request');
 
-// Let us trace
+function handler(req) {
+  // ~> start a span
+  return trace.span(`${req.method} ${req.path}`)(async (s) => {
+    // set some fields on this span's context
+    s.set_context({ user_id: req.params.user_id });
 
-const req = tracer.span('GET ~> /data');
+    // ~> span again for `db::read`
+    const data = await s.span('db::read')(() => db_execute('SELECT * FROM users'));
 
-req.set_context({
-  user: request_context.user_id,
-});
+    // ~> maybe have some manual spanning
+    const processing_span = s.span('process records');
 
-// ~> Wrap any method and be timed 🕺🏻
-const data = await measure(req.span('db::read'), get_data);
+    for (let row of data) {
+      processing_span.add_event('doing stuff', { id: row.id });
+      do_stuff(row);
+    }
 
-// ~> Maybe have some in-flow spanning
-const span = req.span('process records');
+    // don't forget to end
+    processing_span.end();
 
-for (let row of data) {
-  span.add_event('doing stuff', { id: row.id });
-  do_stuff(row);
+    return reply(200, { data });
+  });
 }
 
-span.end();
-
-req.end();
+const otel_exporter = exporter((payload) =>
+  fetch('/traces/otlp', {
+    method: 'POST',
+    body: JSON.stringify(payload),
+  }),
+);
 
-// ~> And finally let's export — will also end the root span.
-await report(otel_endpoint);
+http.listen((req, executionCtx) => {
+  // ~> report all the spans once the response is sent
+  executionCtx.defer(() => report(otel_exporter));
+  return handler(req);
+});
 
 /*
 And we end up with something like this in our reporting tool:
 
-[ GET ~> /data .................................... (1.2ms) ]
-   [ db::read .... (0.5ms) ]
-                           [ process records .... (0.5ms) ]
+[ GET /data .................,,...................... (1.2ms) ] { request }
+   [ db::read .... (0.5ms) ] [ process records .... (0.5ms) ]
+   ^                           ^             ^            ^
+   { user_id }                 ev { id: 1 }  |            |
+                                             ev { id: 2 } |
+                                                          ev { id: 3 }
  */
 ```
 
+You only need to `report` in your application once somewhere. All spans are collected into the same "bucket".
+
 ## 🔎 API
 
 #### Module: [`rian`](./packages/rian/src/index.ts)
 
 The main and _default_ module responsible for creating and provisioning spans.
 
-> 💡 Note ~> when providing span context values, please stick to
-> [Semantic Conventions](https://github.com/opentracing/specification/blob/master/semantic_conventions.md), but won't be
-> enforced.
+> 💡 Note ~> when providing span context values, you can use
+> [Semantic Conventions](https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/), but won't
+> be enforced.
+
+#### Module: [`rian/async`](./packages/rian/src/async.ts)
+
+A module that utilizes the `async_hooks` API to provide a `tracer` and `spans` that can be used where the current span
+isn't accessible.
+
+> 💡 Note ~> this module should be used mutually exclusively with the main `rian` module.
+
+<detials>
+
+<summary>Example</summary>
+
+```ts
+import { configure, tracer, span, currentSpan, report } from 'rian/async';
+import { exporter } from 'rian/exporter.otel.http';
+
+function handler(req) {
+  return span(`${req.method} ${req.path}`)(async () => {
+    const s = currentSpan();
+
+    s.set_context({ user_id: req.params.user_id });
+
+    const data = await s.span('db::read')(() => db_execute('SELECT * FROM users'));
+
+    const processing_span = s.span('process records');
+
+    for (let row of data) {
+      processing_span.add_event('doing stuff', { id: row.id });
+      do_stuff(row);
+    }
+
+    processing_span.end();
+
+    return reply(200, { data });
+  });
+}
+
+const httpTrace = tracer('http');
+
+http.listen((req, executionCtx) => {
+  executionCtx.defer(() => report(exporter));
+  return httpTrace(() => handler(req));
+});
+```
+
+</details>
 
 #### Module: [`rian/exporter.zipkin`](./packages/rian/src/exporter.zipkin.ts)
 
@@ -112,7 +167,7 @@ Implements the OpenTelemetry protocol for use with http transports.
 <details><summary>NewRelic</summary>
 
 ```ts
-import { create, report } from 'rian';
+import { configure, tracer, report } from 'rian';
 import { exporter } from 'rian/exporter.zipkin';
 
 const newrelic = exporter((payload) =>
@@ -128,7 +183,9 @@ const newrelic = exporter((payload) =>
   }),
 );
 
-const tracer = create('my-service');
+configure('my-service');
+
+const tracer = tracer('app');
 
 await report(newrelic);
 ```
@@ -137,14 +194,14 @@ await report(newrelic);
 
 </details>
 
-<details><summary>LightStep</summary>
+<details><summary>Lightstep</summary>
 
 ```ts
-import { create, report } from 'rian';
+import { configure, tracer, report } from 'rian';
 import { exporter } from 'rian/exporter.otel.http';
 
 const lightstep = exporter((payload) =>
-  fetch('https://ingest.lightstep.com/traces/otlp/v0.6', {
+  fetch('https://ingest.lightstep.com/traces/otlp/v0.9', {
     method: 'POST',
     headers: {
       'lightstep-access-token': '<your api key>',
@@ -154,7 +211,9 @@ const lightstep = exporter((payload) =>
   }),
 );
 
-const tracer = create('my-service');
+configure('my-service');
+
+const tracer = tracer('app');
 
 await report(lightstep);
 ```
@@ -165,34 +224,23 @@ await report(lightstep);
 
 ## 🤔 Motivation
 
-Firstly, what is `rian`? _trace_ in Irish is `rian`.
-
-In efforts to be better observant citizens, we generally reach for the — NewRelic, LightStep, DataDog's. Which, and in
-no offence to them, is bloated and slow! Where they more often than not do way too much or and relatively speaking, ship
-useless traces. Which ramp up your bill — see... every span you trace, costs.
-
-And here we are, introducing **rian** — a lightweight, fast effective tracer. Inspired by the giants in the industry,
-OpenTracing and OpenTelemetry.
-
-You might have not heard of those before — and that is okay. It means the design goals from OpenTelemetry or OpenTracing
-has been met. They are frameworks built to abstract the telemetry part from vendors. So folk like NewRelic can wrap
-their layers on top of open telemetry — and have libraries instrument theirs without knowing about the vendor. Which
-allows consumers to ship those spans to the vendor of their choosing. OpenTracing has a very similar design goal, so
-please do go checkout their documentation's, to help decide.
+To clarify, `rian` is the Irish word for "trace".
 
-Rian does not intend to align or compete with them. rian's intent is to be used to instrument your application and
-**only** your application. Rian is primed in that critical business paths — where you don't care " which handlers
-MongoDB ran", or how many network calls your ORM made. Cardinality will destroy you. Although rian can scale to support
-those as well. But the reality is; there are profiler tools far more capable — "right tool for the job".
+In our efforts to be observant citizens, we often rely on tools such as NewRelic, Lightstep, and Datadog. However, these
+tools can be bloated and slow, often performing too many unnecessary tasks and driving up costs, as every span costs.
 
-Rian is simply a tracer you can use to see what your application is doing, have better insight into why something failed
-and stitch it with your logs. It starts by capturing a [`w3c trace-context`](https://www.w3.org/TR/trace-context/),
-tracing some business steps. "inbound request /data", "getting data", "sending email", or as granular as you'd like. And
-have that forwarded onto all sub-services.
+This is where rian comes in as a lightweight, fast, and effective tracer inspired by industry giants OpenTracing and
+OpenTelemetry. These frameworks were designed to abstract the telemetry part from vendors, allowing libraries to be
+instrumented without needing to know about the vendor.
 
-You see, the primary design goal is targeted at edge or service workers — where lean quick tracers is favoured.
+Rian does not intend to align or compete with them, slightly different goals. Rian aims to be used exclusively for
+instrumenting your application, particularly critical business paths. While rian can scale to support more complex
+constructs, there are profiler tools that are better suited for those jobs. Rian's primary design goal is to provide
+better insights into your application's behavior, particularly for edge or service workers where a lean tracer is
+favored.
 
-Rian is still in active development, but ready for production!
+Rian does not by design handle injecting [`w3c trace-context`](https://www.w3.org/TR/trace-context/), or
+[propagating baggage](https://www.w3.org/TR/baggage/). But we do expose api's for achieving this.
 
 ## 💨 Benchmark
 
@@ -201,19 +249,23 @@ Rian is still in active development, but ready for production!
 ```
 Validation :: single span
 ✔ rian
+✔ rian/async
 ✔ opentelemetry
 
 Benchmark :: single span
-  rian                   x 385,085 ops/sec ±4.26% (85 runs sampled)
-  opentelemetry          x 205,004 ops/sec ±11.99% (65 runs sampled)
+  rian                   x 277,283 ops/sec ±3.57% (90 runs sampled)
+  rian/async             x 279,525 ops/sec ±2.33% (91 runs sampled)
+  opentelemetry          x 155,019 ops/sec ±13.13% (70 runs sampled)
 
 Validation :: child span
 ✔ rian
+✔ rian/async
 ✔ opentelemetry
 
 Benchmark :: child span
-  rian                   x 206,736 ops/sec ±6.37% (86 runs sampled)
-  opentelemetry          x 128,298 ops/sec ±14.82% (68 runs sampled)
+  rian                   x 146,793 ops/sec ±3.38% (87 runs sampled)
+  rian/async             x 180,488 ops/sec ±1.64% (92 runs sampled)
+  opentelemetry          x 102,541 ops/sec ±9.77% (73 runs sampled)
 ```
 
 > And please... I know these results are anything but the full story. But it's a number and point on comparison.
@@ -225,5 +277,5 @@ MIT © [Marais Rossouw](https://marais.io)
 ##### Disclaimer
 
 <sup>- NewRelic is a registered trademark of https://newrelic.com/ and not affiliated with this project.</sup><br />
-<sup>- DataDog is a registered trademark of https://www.datadoghq.com/ and not affiliated with this project.</sup><br />
-<sup>- LightStep is a registered trademark of https://lightstep.com/ and not affiliated with this project.</sup>
+<sup>- Datadog is a registered trademark of https://www.datadoghq.com/ and not affiliated with this project.</sup><br />
+<sup>- Lightstep is a registered trademark of https://lightstep.com/ and not affiliated with this project.</sup>

package/utils.d.ts

@@ -1,66 +1,25 @@
 import type { Scope } from 'rian';
 
-export type MeasureFn =
-	| ((...args: [...args: any[]]) => any)
-	| ((...args: [...args: any[], scope: Scope]) => any);
-
 /**
- * With a passed function — will start a span, and run the function, when the function finishes
- * the span finishes.
+ * With a passed function, `measure` will run the function and once finishes, will end the span.
  *
  * 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`.
+ * All promises are tracked, and awaited on a `report`.
  *
- * @example
- *
- * ```text
- * 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,
-	fn: Fn, // TODO: fn doesnt see scope correctly
-	...args: RealMeasureFnParams<Parameters<Fn>>
-) => ReturnType<Fn>;
-
-/**
- * Wraps any function with a measured scoped function. Useful for when defer function execution
- * till a later time.
+ * This is a utility method, but is functionally equivalent to `scope.span('name')(fn)`.
  *
  * @example
  *
- * ```js
- * const wrapped = wrap(scope, "run something", my_function);
- *
- * // ... lots of things, where the access to `scope` is lost.
- *
- * wrapped();
+ * ```text
+ * const data = await measure(scope, get_data);
+ * // or with arguments:
+ * const data = await measure(scope, () => get_data('foo', 'bar'));
  * ```
  */
-export const wrap: <Fn extends MeasureFn>(
+export function measure<Fn extends (scope: Scope) => any>(
 	scope: Scope,
-	fn: Fn, // TODO: fn doesnt see scope correctly
-) => Fn;
-
-// ==> internals
-
-/** @internal */
-export type RealMeasureFnParams<T extends unknown[]> = T extends []
-	? []
-	: T extends [...rest: infer U, scope: Scope]
-	? U
-	: T;
-
-/** @internal */
-export const measureFn: (scope: Scope, fn: any, ...args: any[]) => any;
+	fn: Fn,
+): ReturnType<Fn>;

package/utils.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)=>r(t,e,...n),e=(t,e)=>function(){return r(t,e,...arguments)};exports.measure=t;exports.measureFn=r;exports.wrap=e;
+function r(r,t){try{var e=t(r),n=e instanceof Promise;return n&&r.__add_promise(e.catch((t=>{r.set_context({error:t})})).finally((()=>r.end()))),e}catch(t){throw t instanceof Error&&r.set_context({error:t}),t}finally{!0!==n&&r.end()}}exports.measure=r;

package/utils.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)=>r(t,e,...n),e=(t,e)=>function(){return r(t,e,...arguments)};export{t as measure,r as measureFn,e as wrap};
+function r(r,t){try{var e=t(r),n=e instanceof Promise;return n&&r.__add_promise(e.catch((t=>{r.set_context({error:t})})).finally((()=>r.end()))),e}catch(t){throw t instanceof Error&&r.set_context({error:t}),t}finally{!0!==n&&r.end()}}export{r as measure};