Skip to main content
Version: 1.x

Class: TelemetryError

Error subclass for OpenTelemetry initialization and runtime failures.

Example​

const error = new TelemetryError({
  message: 'Failed to initialize OTel SDK',
  attempted: 'Initialize OpenTelemetry tracing',
  exporterType: 'otlp',
});

Failure Mode​

Init failed — OTel SDK could not be started

Failure Mode​

Peer dep missing — required OTel package not installed

Failure Mode​

Exporter failed — trace/metrics exporter creation failed

Failure Mode​

Shutdown failed — graceful shutdown of SDK timed out

Failure Mode​

Metrics init failed — metrics SDK could not be started

Extends​

Constructors​

Constructor​

new TelemetryError(options): TelemetryError

Creates a new TelemetryError instance.

Parameters​

options​

TelemetryErrorOptions

Telemetry error construction options including optional exporter type and package name for diagnostic context.

Returns​

TelemetryError

Example​

import { TelemetryError } from '#core/errors/telemetry-error.js';

const error = new TelemetryError({
  message: 'Peer dependency missing: @opentelemetry/sdk-node',
  attempted: 'Dynamic import of @opentelemetry/sdk-node',
  code: 'ERR_TELEMETRY_PEER_DEP_MISSING',
  packageName: '@opentelemetry/sdk-node',
});

Overrides​

PramanError.constructor

Properties​

attempted​

readonly attempted: string

Inherited from​

PramanError.attempted

cause?​

optional cause?: unknown

Inherited from​

PramanError.cause

code​

readonly code: ErrorCode

Inherited from​

PramanError.code

details​

readonly details: Readonly<Record<string, unknown>>

Inherited from​

PramanError.details

exporterType​

readonly exporterType: string | undefined

message​

message: string

Inherited from​

PramanError.message

name​

name: string

Inherited from​

PramanError.name

packageName​

readonly packageName: string | undefined

retryable​

readonly retryable: boolean

Inherited from​

PramanError.retryable

severity​

readonly severity: "error" | "info" | "warning"

Inherited from​

PramanError.severity

stack?​

optional stack?: string

Inherited from​

PramanError.stack

suggestions​

readonly suggestions: readonly string[]

Inherited from​

PramanError.suggestions

timestamp​

readonly timestamp: string

Inherited from​

PramanError.timestamp

stackTraceLimit​

static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

PramanError.stackTraceLimit

Methods​

toAIContext()​

toAIContext(): AIErrorContext & object

Returns AI-agent-friendly context with telemetry-specific diagnostic fields.

Returns​

AIErrorContext & object

Base AI context extended with exporter type and package name details.

Example​

const ctx = error.toAIContext();
// LLM can use ctx.packageName to suggest install commands
// and ctx.exporterType to suggest alternative exporters

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

Serializes this error to a JSON-safe object with telemetry-specific fields.

Returns​

SerializedPramanError & object

Base serialization extended with exporterType and packageName.

Example​

const json = error.toJSON();
console.log(json.exporterType); // 'otlp'
console.log(json.packageName);  // '@opentelemetry/sdk-node'

Overrides​

PramanError.toJSON

toUserMessage()​

toUserMessage(): string

Formats the error for human-readable console output.

Returns​

string

Multi-line formatted string with all diagnostic sections.

Example​

console.error(error.toUserMessage());

Inherited from​

PramanError.toUserMessage

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

PramanError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

PramanError.prepareStackTrace