Interface Observe

interface Observe {
    flush(): Promise<void>;
    parseHeaders(headers: Headers | IncomingHttpHeaders): RequestContext;
    recordCount(metric: Metric): void;
    recordError(
        error: Error,
        secureSessionId: undefined | string,
        requestId: undefined | string,
        metadata?: Attributes,
        options?: { span: Span },
    ): void;
    recordHistogram(metric: Metric): void;
    recordIncr(metric: Omit<Metric, "value">): void;
    recordLog(
        message: any,
        level: string,
        secureSessionId?: string,
        requestId?: string,
        metadata?: Attributes,
    ): void;
    recordMetric(metric: Metric): void;
    recordUpDownCounter(metric: Metric): void;
    runWithHeaders<T>(
        name: string,
        headers: Headers | IncomingHttpHeaders,
        cb: (span: Span) => T | Promise<T>,
        options?: SpanOptions,
    ): Promise<T>;
    setAttributes(attributes: Attributes): void;
    startWithHeaders<T>(
        spanName: string,
        headers: Headers | IncomingHttpHeaders,
        options?: SpanOptions,
    ): { ctx: Context; span: Span };
    stop(): Promise<void>;
}

Index

Methods

flush parseHeaders recordCount recordError recordHistogram recordIncr recordLog recordMetric recordUpDownCounter runWithHeaders setAttributes startWithHeaders stop

Methods

flush

flush(): Promise<void>
Flushes all pending telemetry data

Returns Promise<void>
- Defined in api/Observe.ts:77

parseHeaders

parseHeaders(headers: Headers | IncomingHttpHeaders): RequestContext
Parses headers to extract highlight context
Parameters
- headers: Headers | IncomingHttpHeaders
Returns RequestContext
- Defined in api/Observe.ts:87

recordCount

recordCount(metric: Metric): void
Record arbitrary metric values via as a Counter. A Counter efficiently records an increment in a metric, such as number of cache hits. Values with the same metric name and attributes are aggregated via the OTel SDK. See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
Parameters
- metric: Metric
Returns void
- Defined in api/Observe.ts:26

recordError

recordError(
    error: Error,
    secureSessionId: undefined | string,
    requestId: undefined | string,
    metadata?: Attributes,
    options?: { span: Span },
): void
Record an error.
Parameters
- error: Error
- secureSessionId: undefined | string
- requestId: undefined | string
- Optionalmetadata: Attributes
- Optionaloptions: { span: Span }
Returns void
- Defined in api/Observe.ts:66

recordHistogram

recordHistogram(metric: Metric): void
Record arbitrary metric values via as a Histogram. A Histogram efficiently records near-by point-in-time measurement into a bucketed aggregate. Values with the same metric name and attributes are aggregated via the OTel SDK. See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
Parameters
- metric: Metric
Returns void
- Defined in api/Observe.ts:42

recordIncr

recordIncr(metric: Omit<Metric, "value">): void
Record arbitrary metric values via as a Counter. A Counter efficiently records an increment in a metric, such as number of cache hits. Values with the same metric name and attributes are aggregated via the OTel SDK. See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
Parameters
- metric: Omit<Metric, "value">
Returns void
- Defined in api/Observe.ts:34

recordLog

recordLog(
    message: any,
    level: string,
    secureSessionId?: string,
    requestId?: string,
    metadata?: Attributes,
): void
Logs a message with optional session and request context
Parameters
- message: any
- level: string
- OptionalsecureSessionId: string
- OptionalrequestId: string
- Optionalmetadata: Attributes
Returns void
- Defined in api/Observe.ts:55

recordMetric

recordMetric(metric: Metric): void
Record arbitrary metric values via as a Gauge. A Gauge records any point-in-time measurement, such as the current CPU utilization %. Values with the same metric name and attributes are aggregated via the OTel SDK. See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
Parameters
- metric: Metric
Returns void
- Defined in api/Observe.ts:18

recordUpDownCounter

recordUpDownCounter(metric: Metric): void
Record arbitrary metric values via as a UpDownCounter. A UpDownCounter efficiently records an increment or decrement in a metric, such as number of paying customers. Values with the same metric name and attributes are aggregated via the OTel SDK. See https://opentelemetry.io/docs/specs/otel/metrics/data-model/ for more details.
Parameters
- metric: Metric
Returns void
- Defined in api/Observe.ts:50

runWithHeaders

runWithHeaders<T>(
    name: string,
    headers: Headers | IncomingHttpHeaders,
    cb: (span: Span) => T | Promise<T>,
    options?: SpanOptions,
): Promise<T>
Runs a callback with headers context and returns the result
Type Parameters
- T
Parameters
- name: string
- headers: Headers | IncomingHttpHeaders
- cb: (span: Span) => T | Promise<T>
- Optionaloptions: SpanOptions
Returns Promise<T>
- Defined in api/Observe.ts:92

setAttributes

setAttributes(attributes: Attributes): void
Sets attributes on the active span
Parameters
- attributes: Attributes
Returns void
- Defined in api/Observe.ts:82

startWithHeaders

startWithHeaders<T>(
    spanName: string,
    headers: Headers | IncomingHttpHeaders,
    options?: SpanOptions,
): { ctx: Context; span: Span }
Starts a span with headers context
Type Parameters
- T
Parameters
- spanName: string
- headers: Headers | IncomingHttpHeaders
- Optionaloptions: SpanOptions
Returns { ctx: Context; span: Span }
- Defined in api/Observe.ts:102

stop

stop(): Promise<void>
Stops the observability client and flushes remaining data

Returns Promise<void>
- Defined in api/Observe.ts:111

Interface Observe

Index

Methods

Methods

flush

Returns Promise<void>

parseHeaders

Parameters

Returns RequestContext

recordCount

Parameters

Returns void

recordError

Parameters

Returns void

recordHistogram

Parameters

Returns void

recordIncr

Parameters

Returns void

recordLog

Parameters

Returns void

recordMetric

Parameters

Returns void

recordUpDownCounter

Parameters

Returns void

runWithHeaders

Type Parameters

Parameters

Returns Promise<T>

setAttributes

Parameters

Returns void

startWithHeaders

Type Parameters

Parameters

Returns { ctx: Context; span: Span }

stop

Returns Promise<void>

Settings

On This Page