ReferenceSDKTypescriptClassesNoopSpan

Class: NoopSpan

A fake implementation of the Span API which does nothing. This can be used as the default span.

Implements

Constructors

constructor

new NoopSpan(): NoopSpan

Returns

NoopSpan

Methods

close

close(args?): number

Alias for end.

Parameters

NameType
args?EndSpanArgs

Returns

number

Implementation of

Span.close


end

end(args?): number

Log an end time to the span (defaults to the current time). Returns the logged time.

Will be invoked automatically if the span is constructed with traced.

Parameters

NameType
args?EndSpanArgs

Returns

number

The end time logged to the span metrics.

Implementation of

Span.end


export

export(): Promise<string>

Return a serialized representation of the span that can be used to start subspans in other places. See Span.traced for more details.

Returns

Promise<string>

Implementation of

Span.export


flush

flush(): Promise<void>

Flush any pending rows to the server.

Returns

Promise<void>

Implementation of

Span.flush


log

log(_): void

Incrementally update the current span with new data. The event will be batched and uploaded behind the scenes.

Parameters

Returns

void

Implementation of

Span.log


logFeedback

logFeedback(_event): void

Add feedback to the current span. Unlike Experiment.logFeedback and Logger.logFeedback, this method does not accept an id parameter, because it logs feedback to the current span.

Parameters

NameType
_eventOmit<LogFeedbackFullArgs, "id">

Returns

void

Implementation of

Span.logFeedback


startSpan

startSpan(_1?): NoopSpan

Lower-level alternative to traced. This allows you to start a span yourself, and can be useful in situations where you cannot use callbacks. However, spans started with startSpan will not be marked as the "current span", so currentSpan() and traced() will be no-ops. If you want to mark a span as current, use traced instead.

See traced for full details.

Parameters

NameType
_1?StartSpanArgs

Returns

NoopSpan

The newly-created Span

Implementation of

Span.startSpan


traced

traced<R>(callback, _1?): R

Create a new span and run the provided callback. This is useful if you want to log more detailed trace information beyond the scope of a single log event. Data logged over several calls to Span.log will be merged into one logical row.

Spans created within traced are ended automatically. By default, the span is marked as current, so they can be accessed using braintrust.currentSpan.

Type parameters

Name
R

Parameters

NameTypeDescription
callback(span: Span) => RThe function to be run under the span context.
_1?StartSpanArgs & SetCurrentArg-

Returns

R

Returns

The result of running callback.

Implementation of

Span.traced

Properties

id

id: string

Row ID of the span.

Implementation of

Span.id


kind

kind: "span"

Implementation of

Span.kind