Class Transaction

JSDoc

Hierarchy

Span
- Transaction
  - IdleTransaction
  - IdleTransaction

Implements

Transaction

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 = 'sentry'

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
Implementation of Transaction.name
- Defined in core/src/tracing/transaction.ts:73
set name(newName): void
Setter for name property, which also sets source as custom
Parameters
- newName: string
Returns void
Implementation of Transaction.name
- Defined in core/src/tracing/transaction.ts:78

Methods

finish

finish(endTimestamp?): undefined | string
Sets the finish timestamp on the current span.
Parameters
- Optional endTimestamp: number
  
  Takes an endTimestamp if the end should not be the time when you call this function.
Returns undefined | string
Implementation of Transaction.finish

Overrides Span.finish
- Defined in core/src/tracing/transaction.ts:130

getDynamicSamplingContext

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

Returns Readonly<Partial<DynamicSamplingContext>>
Implementation of Transaction.getDynamicSamplingContext
- Defined in core/src/tracing/transaction.ts:243

getTraceContext

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

Returns TraceContext
Implementation of Transaction.getTraceContext

Inherited from Span.getTraceContext
- Defined in core/src/tracing/span.ts:312

initSpanRecorder

initSpanRecorder(maxlen?): void
Attaches SpanRecorder to the span itself
Parameters
- maxlen: number = 1000
  
  maximum number of spans that can be recorded
Returns void
- Defined in core/src/tracing/transaction.ts:94

isSuccess

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

Returns boolean
Implementation of Transaction.isSuccess

Inherited from Span.isSuccess
- Defined in core/src/tracing/span.ts:241

setContext

setContext(key, context): void
Set the context of a transaction event
Parameters
- key: string
- context: null | Context
Returns void
Implementation of Transaction.setContext
- Defined in core/src/tracing/transaction.ts:104

setData

setData(key, value): Transaction
Sets the data attribute on the current span
Parameters
- key: string
  
  Data key
- value: any
  
  Data value
Returns Transaction
Implementation of Transaction.setData

Inherited from Span.setData
- Defined in core/src/tracing/span.ts:212

setHttpStatus

setHttpStatus(httpStatus): Transaction
Sets the status attribute on the current span based on the http code
Parameters
- httpStatus: number
  
  http code used to set the status
Returns Transaction
Implementation of Transaction.setHttpStatus

Inherited from Span.setHttpStatus
- Defined in core/src/tracing/span.ts:228

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
- Defined in core/src/tracing/transaction.ts:281

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
- unit: MeasurementUnit = ''
  
  Unit of the measurement. (Defaults to an empty string)
Returns void
Implementation of Transaction.setMeasurement
- Defined in core/src/tracing/transaction.ts:116

setMetadata

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

Inherit Doc
Implementation of TransactionInterface.setMetadata
- Defined in core/src/tracing/transaction.ts:123

setName

setName(name, source?): void
JSDoc
Parameters
- name: string
- source: TransactionSource = 'custom'
Returns void
Implementation of Transaction.setName
- Defined in core/src/tracing/transaction.ts:85

setStatus

setStatus(value): Transaction
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 Transaction
Implementation of Transaction.setStatus

Inherited from Span.setStatus
- Defined in core/src/tracing/span.ts:220

setTag

setTag(key, value): Transaction
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 Transaction
Implementation of Transaction.setTag

Inherited from Span.setTag
- Defined in core/src/tracing/span.ts:203

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, "status" | "tags" | "data" | "description" | "op" | "instrumenter" | "spanId" | "startTimestamp" | "endTimestamp">
Returns Span
Implementation of Transaction.startChild

Inherited from Span.startChild
- Defined in core/src/tracing/span.ts:170

toContext

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

Returns TransactionContext
Implementation of Transaction.toContext

Overrides Span.toContext
- Defined in core/src/tracing/transaction.ts:215

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
Implementation of Transaction.toJSON

Inherited from Span.toJSON
- Defined in core/src/tracing/span.ts:328

toTraceparent

toTraceparent(): string
Return a traceparent compatible header string

Returns string
Implementation of Transaction.toTraceparent

Inherited from Span.toTraceparent
- Defined in core/src/tracing/span.ts:267

updateWithContext

updateWithContext(transactionContext): Transaction
Updates the current transaction with a new TransactionContext
Parameters
- transactionContext: TransactionContext
Returns Transaction
Implementation of Transaction.updateWithContext

Overrides Span.updateWithContext
- Defined in core/src/tracing/transaction.ts:228

Class Transaction

Hierarchy

Implements

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

finish

Parameters

Optional endTimestamp: number

Returns undefined | string

getDynamicSamplingContext

Returns Readonly<Partial<DynamicSamplingContext>>

getTraceContext

Returns TraceContext

initSpanRecorder

Parameters

maxlen: number = 1000

Returns void

isSuccess

Returns boolean

setContext

Parameters

key: string

context: null | Context

Returns void

setData

Parameters

key: string

value: any

Returns Transaction

setHttpStatus

Parameters

httpStatus: number

Returns Transaction

setHub

Parameters

hub: Hub

Returns void

setMeasurement

Parameters

name: string

value: number

unit: MeasurementUnit = ''

Returns void

setMetadata

Parameters

newMetadata: Partial<TransactionMetadata>

Returns void

Inherit Doc

setName

Parameters

name: string

`Optional` description

`Optional` endTimestamp

`Optional` op

`Optional` parentSpanId

`Optional` sampled

`Optional` spanRecorder

`Optional` status

`Optional` transaction

`Optional` endTimestamp: number

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

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