Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/observability / / GraphorinTracer

Interface: GraphorinTracer

Defined in: packages/observability/src/tracer/tracer.ts:88

The createTracer return value extends the standard Tracer contract from @graphorin/core with introspection helpers (counter snapshots, validator handle).

Stable

Extends

Properties

PropertyModifierTypeDescriptionDefined in
serviceNamereadonlystringService name embedded in the OTLP resource.packages/observability/src/tracer/tracer.ts:90
validatorreadonly| RedactionValidatorInstance | nullThe tracer-managed validator. null when validation: 'off'.packages/observability/src/tracer/tracer.ts:98

Methods

flush()

ts
flush(): Promise<void>;

Defined in: packages/observability/src/tracer/tracer.ts:100

Force-flush every registered exporter.

Returns

Promise&lt;void&gt;


getMetrics()

ts
getMetrics(): RedactionCounters;

Defined in: packages/observability/src/tracer/tracer.ts:96

Snapshot of the redaction counters (droppedTotal, droppedByReason, matchesByPattern) maintained by the tracer-managed validator.

Returns

RedactionCounters


shutdown()

ts
shutdown(): Promise<void>;

Defined in: packages/core/dist/contracts/tracer.d.ts:73

Force-flush any pending spans.

Returns

Promise&lt;void&gt;

Inherited from

Tracer.shutdown


span()

ts
span<T, R>(opts, fn): Promise<R>;

Defined in: packages/core/dist/contracts/tracer.d.ts:71

Convenience wrapper: start a span, run fn inside, and call setStatus('ok' | 'error') + end() based on the outcome.

Type Parameters

Type Parameter
T extends SpanType
R

Parameters

ParameterType
optsStartSpanOptions&lt;T&gt;
fn(span) => R | Promise&lt;R&gt;

Returns

Promise&lt;R&gt;

Inherited from

Tracer.span


startSpan()

ts
startSpan<T>(opts): AISpan<T>;

Defined in: packages/core/dist/contracts/tracer.d.ts:66

Type Parameters

Type Parameter
T extends SpanType

Parameters

ParameterType
optsStartSpanOptions&lt;T&gt;

Returns

AISpan&lt;T&gt;

Inherited from

Tracer.startSpan