Interface Transaction

Transaction "Class", inherits Span only has setName

interface Transaction {
    attributes: SpanAttributes;
    data: { [key: string]: any };
    description?: string;
    endTimestamp?: number;
    exclusiveTime?: number;
    instrumenter: Instrumenter;
    measurements?: Measurements;
    metadata: TransactionMetadata;
    name: string;
    op?: string;
    origin?: SpanOrigin;
    parentSampled?: boolean;
    parentSpanId?: string;
    sampled?: boolean;
    spanId: string;
    startTimestamp: number;
    status?: string;
    tags: { [key: string]: Primitive };
    traceId: string;
    transaction?: Transaction;
    trimEnd?: boolean;
    end(endTimestamp?: SpanTimeInput): void;
    finish(endTimestamp?: number): void;
    getDynamicSamplingContext(): Partial<DynamicSamplingContext>;
    getProfileId(): undefined | string;
    getTraceContext(): TraceContext;
    isRecording(): boolean;
    isSuccess(): boolean;
    setAttribute(key: string, value: undefined | SpanAttributeValue): void;
    setAttributes(attributes: SpanAttributes): void;
    setContext(key: string, context: Context): void;
    setData(key: string, value: any): this;
    setHttpStatus(httpStatus: number): this;
    setMeasurement(name: string, value: number, unit: MeasurementUnit): void;
    setMetadata(newMetadata: Partial<TransactionMetadata>): void;
    setName(name: string, source?: TransactionSource): void;
    setStatus(status: string): this;
    setTag(key: string, value: Primitive): this;
    spanContext(): SpanContextData;
    startChild(
        spanContext?: Pick<
            SpanContext,
            | "instrumenter"
            | "name"
            | "status"
            | "op"
            | "origin"
            | "description"
            | "spanId"
            | "tags"
            | "data"
            | "attributes"
            | "startTimestamp"
            | "endTimestamp"
            | "exclusiveTime"
            | "measurements",
        >,
    ): Span;
    toContext(): TransactionContext;
    toJSON(): SpanJSON;
    toTraceparent(): string;
    updateName(name: string): this;
    updateWithContext(transactionContext: TransactionContext): this;
}

Hierarchy

  • TransactionContext
  • Omit<Span, "setName" | "name">
    • Transaction

Properties

attributes data description? endTimestamp? exclusiveTime? instrumenter measurements? metadata name op? origin? parentSampled? parentSpanId? sampled? spanId startTimestamp status? tags traceId transaction? trimEnd?

Methods

end finish getDynamicSamplingContext getProfileId getTraceContext isRecording isSuccess setAttribute setAttributes setContext setData setHttpStatus setMeasurement setMetadata setName setStatus setTag spanContext startChild toContext toJSON toTraceparent updateName updateWithContext

Properties

attributes

attributes: SpanAttributes

Attributes for the transaction.

Deprecated

Use getSpanAttributes(transaction) instead.

data

data: { [key: string]: any }

Data for the transaction.

Deprecated

Use getSpanAttributes(transaction) instead.

Optionaldescription

description?: string

Description of the Span.

Deprecated

Use name instead.

OptionalendTimestamp

endTimestamp?: number

Timestamp in seconds (epoch time) indicating when the span ended.

OptionalexclusiveTime

exclusiveTime?: number

Exclusive time in milliseconds.

instrumenter

instrumenter: Instrumenter

The instrumenter that created this transaction.

Deprecated

This field will be removed in v8.

Optionalmeasurements

measurements?: Measurements

Measurements of the Span.

metadata

metadata: TransactionMetadata

Metadata about the transaction.

Deprecated

Use attributes or store data on the scope instead.

name

name: string

Human-readable identifier for the transaction.

Deprecated

Use spanToJSON(span).description instead.

Optionalop

op?: string

Operation of the Span.

Optionalorigin

origin?: SpanOrigin

The origin of the span, giving context about what created the span.

OptionalparentSampled

parentSampled?: boolean

If this transaction has a parent, the parent's sampling decision

OptionalparentSpanId

parentSpanId?: string

Parent Span ID

Optionalsampled

sampled?: boolean

Was this transaction chosen to be sent as part of the sample?

Deprecated

Use spanIsSampled(transaction) instead.

spanId

spanId: string

The ID of the transaction.

Deprecated

Use spanContext().spanId instead.

startTimestamp

startTimestamp: number

Inherit Doc

Optionalstatus

status?: string

Completion status of the Span. See: {@sentry/tracing SpanStatus} for possible values

tags

tags: { [key: string]: Primitive }

Tags for the transaction.

Deprecated

Use getSpanAttributes(transaction) instead.

traceId

traceId: string

The ID of the trace.

Deprecated

Use spanContext().traceId instead.

Optionaltransaction

transaction?: Transaction

The transaction containing this span

Deprecated

Use top level Sentry.getRootSpan() instead

OptionaltrimEnd

trimEnd?: boolean

If true, sets the end timestamp of the transaction to the highest timestamp of child spans, trimming the duration of the transaction. This is useful to discard extra time in the transaction that is not accounted for in child spans, like what happens in the idle transaction Tracing integration, where we finish the transaction after a given "idle time" and we don't want this "idle time" to be part of the transaction.

Methods

end

  • end(endTimestamp?: SpanTimeInput): void

  • End the current span.

    Parameters

    • OptionalendTimestamp: SpanTimeInput

    Returns void

finish

  • finish(endTimestamp?: number): void

  • Sets the finish timestamp on the current span.

    Parameters

    • OptionalendTimestamp: number

      Takes an endTimestamp if the end should not be the time when you call this function.

    Returns void

    Deprecated

    Use .end() instead.

getDynamicSamplingContext

  • getDynamicSamplingContext(): Partial<DynamicSamplingContext>

  • Return the current Dynamic Sampling Context of this transaction

    Returns Partial<DynamicSamplingContext>

    Deprecated

    Use top-level getDynamicSamplingContextFromSpan instead.

getProfileId

  • getProfileId(): undefined | string

  • Get the profile id from the transaction

    Returns undefined | string

    Deprecated

    Use toJSON() or access the fields directly instead.

getTraceContext

  • getTraceContext(): TraceContext

  • Convert the object to JSON for w. spans array info only.

    Returns TraceContext

    Deprecated

    Use spanToTraceContext() util function instead.

isRecording

  • isRecording(): boolean

  • If this is span is actually recording data. This will return false if tracing is disabled, this span was not sampled or if the span is already finished.

    Returns boolean

isSuccess

  • isSuccess(): boolean

  • Determines whether span was successful (HTTP200)

    Returns boolean

    Deprecated

    Use spanToJSON(span).status === 'ok' instead.

setAttribute

  • setAttribute(key: string, value: undefined | SpanAttributeValue): void

  • Set a single attribute on the span. Set it to undefined to remove the attribute.

    Parameters

    • key: string
    • value: undefined | SpanAttributeValue

    Returns void

setAttributes

  • setAttributes(attributes: SpanAttributes): void

  • Set multiple attributes on the span. Any attribute set to undefined will be removed.

    Parameters

    • attributes: SpanAttributes

    Returns void

setContext

  • setContext(key: string, context: Context): void

  • Set the context of a transaction event.

    Parameters

    • key: string
    • context: Context

    Returns void

    Deprecated

    Use either .setAttribute(), or set the context on the scope before creating the transaction.

setData

  • setData(key: string, value: any): this

  • Sets the data attribute on the current span

    Parameters

    • key: string

      Data key

    • value: any

      Data value

    Returns this

    Deprecated

    Use setAttribute() instead.

setHttpStatus

  • setHttpStatus(httpStatus: number): this

  • Sets the status attribute on the current span based on the http code

    Parameters

    • httpStatus: number

      http code used to set the status

    Returns this

    Deprecated

    Use top-level setHttpStatus() instead.

setMeasurement

  • setMeasurement(name: string, value: number, unit: MeasurementUnit): void

  • Set observed measurement for this transaction.

    Parameters

    • name: string

      Name of the measurement

    • value: number

      Value of the measurement

    • unit: MeasurementUnit

      Unit of the measurement. (Defaults to an empty string)

    Returns void

    Deprecated

    Use top-level setMeasurement() instead.

setMetadata

  • setMetadata(newMetadata: Partial<TransactionMetadata>): void

  • Set metadata for this transaction.

    Parameters

    • newMetadata: Partial<TransactionMetadata>

    Returns void

    Deprecated

    Use attributes or store data on the scope instead.

setName

  • setName(name: string, source?: TransactionSource): void

  • Set the name of the transaction

    Parameters

    • name: string
    • Optionalsource: TransactionSource

    Returns void

    Deprecated

    Use .updateName() and .setAttribute() instead.

setStatus

  • setStatus(status: string): this

  • Sets the status attribute on the current span See: {@sentry/tracing SpanStatus} for possible values

    Parameters

    • status: string

      http code used to set the status

    Returns this

setTag

  • setTag(key: string, value: Primitive): this

  • Sets the tag attribute on the current span.

    Can also be used to unset a tag, by passing undefined.

    Parameters

    • key: string

      Tag key

    • value: Primitive

      Tag value

    Returns this

    Deprecated

    Use setAttribute() instead.

spanContext

  • spanContext(): SpanContextData

  • Get context data for this span. This includes the spanId & the traceId.

    Returns SpanContextData

startChild

  • startChild(
        spanContext?: Pick<
            SpanContext,
            | "instrumenter"
            | "name"
            | "status"
            | "op"
            | "origin"
            | "description"
            | "spanId"
            | "tags"
            | "data"
            | "attributes"
            | "startTimestamp"
            | "endTimestamp"
            | "exclusiveTime"
            | "measurements",
        >,
    ): Span

  • Creates a new Span while setting the current Span.id as parentSpanId. Also the sampled decision will be inherited.

    Parameters

    • OptionalspanContext: Pick<
          SpanContext,
          | "instrumenter"
          | "name"
          | "status"
          | "op"
          | "origin"
          | "description"
          | "spanId"
          | "tags"
          | "data"
          | "attributes"
          | "startTimestamp"
          | "endTimestamp"
          | "exclusiveTime"
          | "measurements",
      >

    Returns Span

    Deprecated

    Use startSpan(), startSpanManual() or startInactiveSpan() instead.

toContext

  • toContext(): TransactionContext

  • Returns the current transaction properties as a TransactionContext.

    Returns TransactionContext

    Deprecated

    Use toJSON() or access the fields directly instead.

toJSON

  • toJSON(): SpanJSON

  • Convert the object to JSON.

    Returns SpanJSON

    Deprecated

    Use spanToJSON(span) instead.

toTraceparent

  • toTraceparent(): string

  • Return a traceparent compatible header string.

    Returns string

    Deprecated

    Use spanToTraceHeader() instead.

updateName

  • updateName(name: string): this

  • Update the name of the span.

    Parameters

    • name: string

    Returns this

updateWithContext

  • updateWithContext(transactionContext: TransactionContext): this

  • Updates the current transaction with a new TransactionContext.

    Parameters

    • transactionContext: TransactionContext

    Returns this

    Deprecated

    Update the fields directly instead.

Settings

Member Visibility

On This Page

Properties
Methods