Skip to main content

QTelemetry

@quik/telemetry

@quik/telemetry / QTelemetry

Class: QTelemetry

Defined in: telemetry/src/QTelemetry.ts:25

OpenTelemetry bootstrap wrapper.

Extends​

  • QObject

Implements​

  • IQTelemetry

Constructors​

Constructor​

new QTelemetry(): QTelemetry

Returns​

QTelemetry

Inherited from​

QObject.constructor

Properties​

_sdk?​

protected optional _sdk?: TelemetrySDK

Defined in: telemetry/src/QTelemetry.ts:26

_started​

protected _started: boolean = false

Defined in: telemetry/src/QTelemetry.ts:27

Accessors​

logger​

Get Signature​

get protected logger(): IQLogger

Defined in: core/src/QObject.ts:15

The logger getter for the object.

Returns​

IQLogger

Inherited from​

QObject.logger

name​

Get Signature​

get name(): string

Defined in: core/src/QObject.ts:8

Returns​

string

Inherited from​

QObject.name

Methods​

createSdk()​

protected createSdk(): Promise<TelemetrySDK>

Defined in: telemetry/src/QTelemetry.ts:75

Returns​

Promise<TelemetrySDK>

createSpan()​

protected createSpan(name, options?): Span

Defined in: telemetry/src/QTelemetry.ts:137

Parameters​

name​

string

options?​

TelemetrySpanOptions

Returns​

Span

endSpan()​

protected endSpan(span): void

Defined in: core/src/QObject.ts:35

End a span returned by startSpan.

Parameters​

span​

TelemetrySpan

The span to end.

Returns​

void

Inherited from​

QObject.endSpan

getTracerName()​

protected getTracerName(): string

Defined in: telemetry/src/QTelemetry.ts:159

Returns​

string

isPromiseLike()​

protected isPromiseLike<T>(value): value is Promise<T>

Defined in: telemetry/src/QTelemetry.ts:163

Type Parameters​

T​

T

Parameters​

value​

T | Promise<T>

Returns​

value is Promise<T>

markSpanError()​

protected markSpanError(span, err): void

Defined in: telemetry/src/QTelemetry.ts:149

Parameters​

span​

Span

err​

unknown

Returns​

void

recordSpanError()​

protected recordSpanError(span, err): void

Defined in: core/src/QObject.ts:45

Record an exception on an active span.

Parameters​

span​

TelemetrySpan

The span to record the error on.

err​

unknown

The error to record.

Returns​

void

Inherited from​

QObject.recordSpanError

runWithSpan()​

protected runWithSpan<T>(span, fn): T | Promise<T>

Defined in: telemetry/src/QTelemetry.ts:112

Type Parameters​

T​

T

Parameters​

span​

Span

fn​

() => T | Promise<T>

Returns​

T | Promise<T>

setSpanAttribute()​

protected setSpanAttribute(span, key, value): void

Defined in: core/src/QObject.ts:64

Set a single attribute on an active span.

Parameters​

span​

TelemetrySpan

The span to update.

key​

string

Attribute key.

value​

string | number | boolean

Attribute value.

Returns​

void

Inherited from​

QObject.setSpanAttribute

shutdown()​

shutdown(): Promise<void>

Defined in: telemetry/src/QTelemetry.ts:45

Shut down OpenTelemetry SDK.

Returns​

Promise<void>

start()​

start(): Promise<void>

Defined in: telemetry/src/QTelemetry.ts:32

Start OpenTelemetry SDK if configured.

Returns​

Promise<void>

startSpan()​

startSpan(name, options?): TelemetrySpan

Defined in: telemetry/src/QTelemetry.ts:57

Start a new telemetry span.

Parameters​

name​

string

options?​

TelemetrySpanOptions

Returns​

TelemetrySpan

Implementation of​

IQTelemetry.startSpan

Overrides​

QObject.startSpan

withSpan()​

withSpan<T>(name, fn, options?): T | Promise<T>

Defined in: telemetry/src/QTelemetry.ts:65

Execute a callback within a span and end it automatically.

Type Parameters​

T​

T

Parameters​

name​

string

fn​

() => T | Promise<T>

options?​

TelemetrySpanOptions

Returns​

T | Promise<T>

Implementation of​

IQTelemetry.withSpan