Skip to main content

OtelClient

Datalayer Core

Datalayer Core / OtelClient

Class: OtelClient

Defined in: src/otel/client/OtelClient.ts:172

Typed HTTP client for all OTEL service endpoints.

Construct via createOtelClient() or new OtelClient(options).

Constructors​

Constructor​

new OtelClient(options?): OtelClient

Defined in: src/otel/client/OtelClient.ts:176

Parameters​

options?​

OtelClientOptions = {}

Returns​

OtelClient

Methods​

executeQuery()​

executeQuery(sql): Promise<OtelQueryResult>

Defined in: src/otel/client/OtelClient.ts:312

Execute an ad-hoc DataFusion SQL query against the OTEL service.

Available tables: spans, logs, metrics.

Parameters​

sql​

string

Returns​

Promise<OtelQueryResult>

fetchLogs()​

fetchLogs(options?): Promise<{ count: number; data: OtelLog[]; }>

Defined in: src/otel/client/OtelClient.ts:211

List recent log records.

Parameters​

options?​

FetchLogsOptions = {}

Returns​

Promise<{ count: number; data: OtelLog[]; }>

fetchMetrics()​

fetchMetrics(options?): Promise<{ count: number; data: OtelMetric[]; }>

Defined in: src/otel/client/OtelClient.ts:229

List recent metric data points.

Parameters​

options?​

FetchMetricsOptions = {}

Returns​

Promise<{ count: number; data: OtelMetric[]; }>

fetchMetricTotal()​

fetchMetricTotal(metricName, options?): Promise<number>

Defined in: src/otel/client/OtelClient.ts:249

Sum all values for one metric name, with optional service filter.

Parameters​

metricName​

string

options?​

FetchMetricTotalOptions = {}

Returns​

Promise<number>

fetchServices()​

fetchServices(): Promise<string[]>

Defined in: src/otel/client/OtelClient.ts:277

List known service names observed in traces.

Returns​

Promise<string[]>

fetchStats()​

fetchStats(): Promise<Record<string, unknown>>

Defined in: src/otel/client/OtelClient.ts:298

Fetch storage / ingestion statistics.

Returns​

Promise<Record<string, unknown>>

fetchSystem()​

fetchSystem(): Promise<OtelSystemData>

Defined in: src/otel/client/OtelClient.ts:327

Fetch system statistics (platform_admin only).

Returns process memory/CPU, disk usage, and per-table row counts.

Returns​

Promise<OtelSystemData>

fetchTrace()​

fetchTrace(traceId): Promise<{ data: OtelSpan[]; }>

Defined in: src/otel/client/OtelClient.ts:199

Fetch all spans for a single trace by traceId.

Parameters​

traceId​

string

Returns​

Promise<{ data: OtelSpan[]; }>

fetchTraces()​

fetchTraces(options?): Promise<{ count: number; data: OtelSpan[]; }>

Defined in: src/otel/client/OtelClient.ts:185

List recent spans / traces.

Parameters​

options?​

FetchTracesOptions = {}

Returns​

Promise<{ count: number; data: OtelSpan[]; }>