Class IdleTransaction

An IdleTransaction is a transaction that automatically finishes. It does this by tracking child spans as activities. You can have multiple IdleTransactions active, but if the onScope option is specified, the idle transaction will put itself on the scope on creation.

Hierarchy

Transaction
- IdleTransaction

Properties

_hub

_hub: Hub

The reference to the current hub.

data

data: {
[key: string]: any;
}

Data of the Span.

Type declaration

[key: string]: any

`Optional` description

description?: string

Description of the Span.

`Optional` endTimestamp

endTimestamp?: number

Timestamp in seconds when the span ended.

instrumenter

instrumenter: Instrumenter

The instrumenter that created this span.

`Optional` op

op?: string

Operation of the Span.

`Optional` parentSpanId

parentSpanId?: string

Parent Span ID

`Optional` sampled

sampled?: boolean

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

spanId

spanId: string

Span ID

`Optional` spanRecorder

spanRecorder?: SpanRecorder

List of spans that were finalized

startTimestamp

startTimestamp: number

Timestamp in seconds when the span was created.

`Optional` status

status?: string

Internal keeper of the status

traceId

traceId: string

Trace ID

`Optional` transaction

transaction?: Transaction

The transaction containing this span

Accessors

name

get name(): string
Getter for name property

Returns string
Inherited from Transaction.name
- Defined in core/build/types/tracing/transaction.d.ts:25
set name(newName): void
Setter for name property, which also sets source as custom
Parameters
- newName: string
Returns void
Inherited from Transaction.name
- Defined in core/build/types/tracing/transaction.d.ts:27

Methods

cancelIdleTimeout

cancelIdleTimeout(endTimestamp?, __namedParameters?): void
Cancels the existing idle timeout, if there is one.
Parameters
- Optional endTimestamp: number
- Optional __namedParameters: {
  restartOnChildSpanChange?: boolean;
  }
  - Optional restartOnChildSpanChange?: boolean
Returns void
- Defined in core/build/types/tracing/idletransaction.d.ts:84

finish

finish(endTimestamp?): undefined | string
Parameters
- Optional endTimestamp: number
Returns undefined | string
Overrides Transaction.finish
- Defined in core/build/types/tracing/idletransaction.d.ts:65

getDynamicSamplingContext

getDynamicSamplingContext(): Readonly<Partial<DynamicSamplingContext>>
Return the current Dynamic Sampling Context of this transaction

Returns Readonly<Partial<DynamicSamplingContext>>
Inherited from Transaction.getDynamicSamplingContext
- Defined in core/build/types/tracing/transaction.d.ts:66

getTraceContext

getTraceContext(): TraceContext
Convert the object to JSON for w. spans array info only

Returns TraceContext
Inherited from Transaction.getTraceContext
- Defined in core/build/types/tracing/span.d.ts:135

initSpanRecorder

initSpanRecorder(maxlen?): void
Attaches SpanRecorder to the span itself
Parameters
- Optional maxlen: number
  
  maximum number of spans that can be recorded
Returns void
Overrides Transaction.initSpanRecorder
- Defined in core/build/types/tracing/idletransaction.d.ts:77

isSuccess

isSuccess(): boolean
Determines whether span was successful (HTTP200)

Returns boolean
Inherited from Transaction.isSuccess
- Defined in core/build/types/tracing/span.d.ts:115

registerBeforeFinishCallback

registerBeforeFinishCallback(callback): void
Register a callback function that gets excecuted before the transaction finishes. Useful for cleanup or if you want to add any additional spans based on current context.

This is exposed because users have no other way of running something before an idle transaction finishes.
Parameters
- callback: BeforeFinishCallback
Returns void
- Defined in core/build/types/tracing/idletransaction.d.ts:73

setContext

setContext(key, context): void
Set the context of a transaction event
Parameters
- key: string
- context: null | Context
Returns void
Inherited from Transaction.setContext
- Defined in core/build/types/tracing/transaction.d.ts:40

setData

setData(key, value): IdleTransaction
Sets the data attribute on the current span
Parameters
- key: string
  
  Data key
- value: any
  
  Data value
Returns IdleTransaction
Inherited from Transaction.setData
- Defined in core/build/types/tracing/span.d.ts:103

setFinishReason

setFinishReason(reason): void
Internal
Temporary method used to externally set the transaction's finishReason

** WARNING** This is for the purpose of experimentation only and will be removed in the near future, do not use!
Parameters
- reason: string
Returns void
- Defined in core/build/types/tracing/idletransaction.d.ts:96

setHttpStatus

setHttpStatus(httpStatus): IdleTransaction
Sets the status attribute on the current span based on the http code
Parameters
- httpStatus: number
  
  http code used to set the status
Returns IdleTransaction
Inherited from Transaction.setHttpStatus
- Defined in core/build/types/tracing/span.d.ts:111

setHub

setHub(hub): void
Internal
Override the current hub with a new one. Used if you want another hub to finish the transaction.
Parameters
- hub: Hub
Returns void
Inherited from Transaction.setHub
- Defined in core/build/types/tracing/transaction.d.ts:73

setMeasurement

setMeasurement(name, value, unit?): void
Set observed measurement for this transaction.
Parameters
- name: string
  
  Name of the measurement
- value: number
  
  Value of the measurement
- Optional unit: MeasurementUnit
  
  Unit of the measurement. (Defaults to an empty string)
Returns void
Inherited from Transaction.setMeasurement
- Defined in core/build/types/tracing/transaction.d.ts:44

setMetadata

setMetadata(newMetadata): void
Parameters
- newMetadata: Partial<TransactionMetadata>
Returns void

Inherit Doc
Inherited from Transaction.setMetadata
- Defined in core/build/types/tracing/transaction.d.ts:48

setName

setName(name, source?): void
JSDoc
Parameters
- name: string
- Optional source: TransactionSource
Returns void
Inherited from Transaction.setName
- Defined in core/build/types/tracing/transaction.d.ts:31

setStatus

setStatus(value): IdleTransaction
Sets the status attribute on the current span See: {@sentry/tracing SpanStatus} for possible values
Parameters
- value: SpanStatusType
  
  http code used to set the status
Returns IdleTransaction
Inherited from Transaction.setStatus
- Defined in core/build/types/tracing/span.d.ts:107

setTag

setTag(key, value): IdleTransaction
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 IdleTransaction
Inherited from Transaction.setTag
- Defined in core/build/types/tracing/span.d.ts:99

startChild

startChild(spanContext?): Span
Creates a new Span while setting the current Span.id as parentSpanId. Also the sampled decision will be inherited.
Parameters
- Optional spanContext: Pick<SpanContext, "description" | "op" | "status" | "spanId" | "tags" | "data" | "startTimestamp" | "endTimestamp" | "instrumenter">
Returns Span
Inherited from Transaction.startChild
- Defined in core/build/types/tracing/span.d.ts:95

toContext

toContext(): TransactionContext
Returns the current transaction properties as a TransactionContext

Returns TransactionContext
Inherited from Transaction.toContext
- Defined in core/build/types/tracing/transaction.d.ts:56

toJSON

toJSON(): {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    start_timestamp: number;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    timestamp?: number;
    trace_id: string;
}
Convert the object to JSON

Returns {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    start_timestamp: number;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    timestamp?: number;
    trace_id: string;
}
- Optional data?: {
  [key: string]: any;
  }
  - [key: string]: any
- Optional description?: string
- Optional op?: string
- Optional parent_span_id?: string
- span_id: string
- start_timestamp: number
- Optional status?: string
- Optional tags?: {
  [key: string]: Primitive;
  }
  - [key: string]: Primitive
- Optional timestamp?: number
- trace_id: string
Inherited from Transaction.toJSON
- Defined in core/build/types/tracing/span.d.ts:139

toTraceparent

toTraceparent(): string
Return a traceparent compatible header string

Returns string
Inherited from Transaction.toTraceparent
- Defined in core/build/types/tracing/span.d.ts:123

updateWithContext

updateWithContext(transactionContext): IdleTransaction
Updates the current transaction with a new TransactionContext
Parameters
- transactionContext: TransactionContext
Returns IdleTransaction
Inherited from Transaction.updateWithContext
- Defined in core/build/types/tracing/transaction.d.ts:60

Class IdleTransaction

Hierarchy

Index

Properties

Accessors

Methods

Properties

_hub

data

Type declaration

[key: string]: any

Optional description

Optional endTimestamp

instrumenter

Optional op

Optional parentSpanId

Optional sampled

spanId

Optional spanRecorder

startTimestamp

Optional status

tags

Type declaration

[key: string]: Primitive

traceId

Optional transaction

Accessors

name

Returns string

Parameters

newName: string

Returns void

Methods

cancelIdleTimeout

Parameters

Optional endTimestamp: number

Optional __namedParameters: { restartOnChildSpanChange?: boolean; }

Optional restartOnChildSpanChange?: boolean

Returns void

finish

Parameters

Optional endTimestamp: number

Returns undefined | string

getDynamicSamplingContext

Returns Readonly<Partial<DynamicSamplingContext>>

getTraceContext

Returns TraceContext

initSpanRecorder

Parameters

Optional maxlen: number

Returns void

isSuccess

Returns boolean

registerBeforeFinishCallback

Parameters

callback: BeforeFinishCallback

Returns void

setContext

Parameters

key: string

context: null | Context

Returns void

setData

Parameters

key: string

value: any

Returns IdleTransaction

setFinishReason

Parameters

reason: string

Returns void

setHttpStatus

Parameters

httpStatus: number

Returns IdleTransaction

setHub

Parameters

hub: Hub

Returns void

setMeasurement

`Optional` description

`Optional` endTimestamp

`Optional` op

`Optional` parentSpanId

`Optional` sampled

`Optional` spanRecorder

`Optional` status

`Optional` transaction

`Optional` endTimestamp: number

`Optional` __namedParameters: {
restartOnChildSpanChange?: boolean;
}

`Optional` restartOnChildSpanChange?: boolean

`Optional` endTimestamp: number

`Optional` maxlen: number

`Optional` unit: MeasurementUnit

`Optional` source: TransactionSource

`Optional` spanContext: Pick<SpanContext, "description" | "op" | "status" | "spanId" | "tags" | "data" | "startTimestamp" | "endTimestamp" | "instrumenter">

Returns {
data?: {
[key: string]: any;
};
description?: string;
op?: string;
parent_span_id?: string;
span_id: string;
start_timestamp: number;
status?: string;
tags?: {
[key: string]: Primitive;
};
timestamp?: number;
trace_id: string;
}

`Optional` data?: {
[key: string]: any;
}

`Optional` description?: string

`Optional` op?: string

`Optional` parent_span_id?: string

`Optional` status?: string

`Optional` tags?: {
[key: string]: Primitive;
}

`Optional` timestamp?: number