@opentelemetry/core

Variables

• internal
• otperformance
• SDK_INFO
• TRACE_PARENT_HEADER
• TRACE_STATE_HEADER

Functions

• addHrTimes()
• callWithTimeout()
• deleteRPCMetadata()
• diagLogLevelFromString()
• getBooleanFromEnv()
• getNumberFromEnv()
• getRPCMetadata()
• getStringFromEnv()
• getStringListFromEnv()
• getTimeOrigin()
• globalErrorHandler()
• hrTime()
• hrTimeDuration()
• hrTimeToMicroseconds()
• hrTimeToMilliseconds()
• hrTimeToNanoseconds()
• hrTimeToTimeStamp()
• isAttributeValue()
• isTimeInput()
• isTimeInputHrTime()
• isTracingSuppressed()
• isUrlIgnored()
• loggingErrorHandler()
• merge()
• millisToHrTime()
• parseKeyPairsIntoRecord()
• parseTraceParent()
• sanitizeAttributes()
• setGlobalErrorHandler()
• setRPCMetadata()
• suppressTracing()
• timeInputToHrTime()
• unrefTimer()
• unsuppressTracing()
• urlMatches()

Classes

• AnchoredClock

  • now()
• BindOnceFuture

  • call()
  • isCalled
  • promise
• CompositePropagator

  • extract()
  • fields()
  • inject()
• TimeoutError
• TraceState

  • get()
  • serialize()
  • set()
  • unset()
• W3CBaggagePropagator

  • extract()
  • fields()
  • inject()
• W3CTraceContextPropagator

  • extract()
  • fields()
  • inject()

Interfaces

• Clock

  • now()
• CompositePropagatorConfig

  • propagators
• ExportResult

  • code
  • error
• InstrumentationScope

  • name
  • schemaUrl
  • version

Enums

• ExportResultCode

  • FAILED
  • SUCCESS
• RPCType

  • HTTP

Type Aliases

• ErrorHandler
• RPCMetadata

variable internal

const internal: { _export: typeof _export };

variable otperformance

const otperformance: { now(): number; readonly timeOrigin: number };

variable SDK_INFO

const SDK_INFO: {
    'telemetry.sdk.name': string;
    'process.runtime.name': string;
    'telemetry.sdk.language': 'nodejs';
    'telemetry.sdk.version': string;
};

• Constants describing the SDK in use

variable TRACE_PARENT_HEADER

const TRACE_PARENT_HEADER: string;

variable TRACE_STATE_HEADER

const TRACE_STATE_HEADER: string;

function addHrTimes

addHrTimes: (time1: api.HrTime, time2: api.HrTime) => api.HrTime;

• Given 2 HrTime formatted times, return their sum as an HrTime.

function callWithTimeout

callWithTimeout: <T>(promise: Promise<T>, timeout: number) => Promise<T>;

• Adds a timeout to a promise and rejects if the specified timeout has elapsed. Also rejects if the specified promise rejects, and resolves if the specified promise resolves.

  NOTE: this operation will continue even after it throws a TimeoutError.

  Parameter promise

  promise to use with timeout.

  Parameter timeout

  the timeout in milliseconds until the returned promise is rejected.

function deleteRPCMetadata

deleteRPCMetadata: (context: Context) => Context;

function diagLogLevelFromString

diagLogLevelFromString: (value: string | undefined) => DiagLogLevel | undefined;

• Convert a string to a DiagLogLevel, defaults to DiagLogLevel if the log level does not exist or undefined if the input is undefined.

  Parameter value

function getBooleanFromEnv

getBooleanFromEnv: (key: string) => boolean;

• Retrieves a boolean value from an environment variable. - Trims leading and trailing whitespace and ignores casing. - Returns false if the environment variable is empty, unset, or contains only whitespace. - Returns false for strings that cannot be mapped to a boolean.

  Parameter key

  The name of the environment variable to retrieve.

  Returns

  {boolean} - The boolean value or false if the environment variable is unset empty, unset, or contains only whitespace.

function getNumberFromEnv

getNumberFromEnv: (key: string) => number | undefined;

• Retrieves a number from an environment variable. - Returns undefined if the environment variable is empty, unset, contains only whitespace, or is not a number. - Returns a number in all other cases.

  Parameter key

  The name of the environment variable to retrieve.

  Returns

  {number | undefined} - The number value or undefined.

function getRPCMetadata

getRPCMetadata: (context: Context) => RPCMetadata | undefined;

function getStringFromEnv

getStringFromEnv: (key: string) => string | undefined;

• Retrieves a string from an environment variable. - Returns undefined if the environment variable is empty, unset, or contains only whitespace.

  Parameter key

  The name of the environment variable to retrieve.

  Returns

  {string | undefined} - The string value or undefined.

function getStringListFromEnv

getStringListFromEnv: (key: string) => string[] | undefined;

• Retrieves a list of strings from an environment variable. - Uses ',' as the delimiter. - Trims leading and trailing whitespace from each entry. - Excludes empty entries. - Returns undefined if the environment variable is empty or contains only whitespace. - Returns an empty array if all entries are empty or whitespace.

  Parameter key

  The name of the environment variable to retrieve.

  Returns

  {string[] | undefined} - The list of strings or undefined.

function getTimeOrigin

getTimeOrigin: () => number;

function globalErrorHandler

globalErrorHandler: (ex: Exception) => void;

• Return the global error handler

  Parameter ex

function hrTime

hrTime: (performanceNow?: number) => api.HrTime;

• Returns an hrtime calculated via performance component.

  Parameter performanceNow

function hrTimeDuration

hrTimeDuration: (startTime: api.HrTime, endTime: api.HrTime) => api.HrTime;

• Returns a duration of two hrTime.

  Parameter startTime

  Parameter endTime

function hrTimeToMicroseconds

hrTimeToMicroseconds: (time: api.HrTime) => number;

• Convert hrTime to microseconds.

  Parameter time

function hrTimeToMilliseconds

hrTimeToMilliseconds: (time: api.HrTime) => number;

• Convert hrTime to milliseconds.

  Parameter time

function hrTimeToNanoseconds

hrTimeToNanoseconds: (time: api.HrTime) => number;

• Convert hrTime to nanoseconds.

  Parameter time

function hrTimeToTimeStamp

hrTimeToTimeStamp: (time: api.HrTime) => string;

• Convert hrTime to timestamp, for example "2019-05-14T17:00:00.000123456Z"

  Parameter time

function isAttributeValue

isAttributeValue: (val: unknown) => val is AttributeValue;

function isTimeInput

isTimeInput: (value: unknown) => value is any;

• check if input value is a correct types.TimeInput

  Parameter value

function isTimeInputHrTime

isTimeInputHrTime: (value: unknown) => value is api.HrTime;

• check if time is HrTime

  Parameter value

function isTracingSuppressed

isTracingSuppressed: (context: Context) => boolean;

function isUrlIgnored

isUrlIgnored: (url: string, ignoredUrls?: Array<string | RegExp>) => boolean;

• Check if should be ignored when comparing against

  Parameter url

  Parameter ignoredUrls

function loggingErrorHandler

loggingErrorHandler: () => ErrorHandler;

• Returns a function that logs an error using the provided logger, or a console logger if one was not provided.

function merge

merge: (...args: any[]) => any;

• Merges objects together

  Parameter args

  objects / values to be merged

function millisToHrTime

millisToHrTime: (epochMillis: number) => api.HrTime;

• Converts a number of milliseconds from epoch to HrTime([seconds, remainder in nanoseconds]).

  Parameter epochMillis

function parseKeyPairsIntoRecord

parseKeyPairsIntoRecord: (value?: string) => Record<string, string>;

• Parse a string serialized in the baggage HTTP Format (without metadata): https://github.com/w3c/baggage/blob/master/baggage/HTTP_HEADER_FORMAT.md

function parseTraceParent

parseTraceParent: (traceParent: string) => SpanContext | null;

• Parses information from the [traceparent] span tag and converts it into SpanContext

  Parameter traceParent

  A meta property that comes from server. It should be dynamically generated server side to have the server's request trace Id, a parent span Id that was set on the server's request span, and the trace flags to indicate the server's sampling decision (01 = sampled, 00 = not sampled). for example: '{version}-{traceId}-{spanId}-{sampleDecision}' For more information see https://www.w3.org/TR/trace-context/

function sanitizeAttributes

sanitizeAttributes: (attributes: unknown) => Attributes;

function setGlobalErrorHandler

setGlobalErrorHandler: (handler: ErrorHandler) => void;

• Set the global error handler

  Parameter handler

function setRPCMetadata

setRPCMetadata: (context: Context, meta: RPCMetadata) => Context;

function suppressTracing

suppressTracing: (context: Context) => Context;

function timeInputToHrTime

timeInputToHrTime: (time: api.TimeInput) => api.HrTime;

• Converts a TimeInput to an HrTime, defaults to _hrtime().

  Parameter time

function unrefTimer

unrefTimer: (timer: { unref(): unknown } | number) => void;

• Parameter timer

  Deprecated

  please copy this code to your implementation instead, this function will be removed in the next major version of this package.

function unsuppressTracing

unsuppressTracing: (context: Context) => Context;

function urlMatches

urlMatches: (url: string, urlToMatch: string | RegExp) => boolean;

type ErrorHandler

type ErrorHandler = (ex: Exception) => void;

• Defines an error handler function

type RPCMetadata

type RPCMetadata = HTTPMetadata;

• Allows for future rpc metadata to be used with this mechanism