Interface Transaction

Transaction "Class", inherits Span only has setName

Hierarchy

TransactionContext
Span
- Transaction

Implemented by

Properties

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 (epoch time) indicating when the span ended.

instrumenter

instrumenter: Instrumenter

The instrumenter that created this transaction.

metadata

metadata: TransactionMetadata

Metadata about the transaction

name

name: string

Human-readable identifier for the transaction

`Optional` op

op?: string

Operation of the Span.

`Optional` parentSampled

parentSampled?: boolean

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

`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

startTimestamp

startTimestamp: number

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

`Optional` status

status?: string

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

traceId

traceId: string

Trace ID

`Optional` transaction

transaction?: Transaction

The transaction containing this span

`Optional` trimEnd

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

finish

finish(endTimestamp?): void
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 void
Inherited from Span.finish
- Defined in packages/types/build/types/span.d.ts:98

getDynamicSamplingContext

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

Returns Partial<DynamicSamplingContext>
- Defined in packages/types/build/types/transaction.d.ts:98

getTraceContext

getTraceContext(): {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    trace_id: string;
}
Convert the object to JSON for w. spans array info only

Returns {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    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
- Optional status?: string
- Optional tags?: {
  [key: string]: Primitive;
  }
  - [key: string]: Primitive
- trace_id: string
Inherited from Span.getTraceContext
- Defined in packages/types/build/types/span.d.ts:141

isSuccess

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

Returns boolean
Inherited from Span.isSuccess
- Defined in packages/types/build/types/span.d.ts:133

setContext

setContext(key, context): void
Set the context of a transaction event
Parameters
- key: string
- context: Context
Returns void
- Defined in packages/types/build/types/transaction.d.ts:79

setData

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

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
Inherited from Span.setHttpStatus
- Defined in packages/types/build/types/span.d.ts:124

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
- Defined in packages/types/build/types/transaction.d.ts:87

setName

setName(name, source?): void
Set the name of the transaction
Parameters
- name: string
- Optional source: TransactionSource
Returns void
- Defined in packages/types/build/types/transaction.d.ts:75

setStatus

setStatus(status): Transaction
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 Transaction
Inherited from Span.setStatus
- Defined in packages/types/build/types/span.d.ts:119

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
Inherited from Span.setTag
- Defined in packages/types/build/types/span.d.ts:107

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, "tags" | "data" | "instrumenter" | "description" | "op" | "status" | "spanId" | "startTimestamp" | "endTimestamp">
Returns Span
Inherited from Span.startChild
- Defined in packages/types/build/types/span.d.ts:129

toContext

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

Returns TransactionContext
Overrides Span.toContext
- Defined in packages/types/build/types/transaction.d.ts:89

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 Span.toJSON
- Defined in packages/types/build/types/span.d.ts:156

toTraceparent

toTraceparent(): string
Return a traceparent compatible header string

Returns string
Inherited from Span.toTraceparent
- Defined in packages/types/build/types/span.d.ts:135

updateWithContext

updateWithContext(transactionContext): Transaction
Updates the current transaction with a new TransactionContext
Parameters
- transactionContext: TransactionContext
Returns Transaction
Overrides Span.updateWithContext
- Defined in packages/types/build/types/transaction.d.ts:91

Interface Transaction

Hierarchy

Implemented by

Index

Properties

Methods

Properties

data

Type declaration

[key: string]: any

Optional description

Optional endTimestamp

instrumenter

metadata

name

Optional op

Optional parentSampled

Optional parentSpanId

Optional sampled

spanId

startTimestamp

Optional status

tags

Type declaration

[key: string]: Primitive

traceId

Optional transaction

Optional trimEnd

Methods

finish

Parameters

Optional endTimestamp: number

Returns void

getDynamicSamplingContext

Returns Partial<DynamicSamplingContext>

getTraceContext

Returns { data?: { [key: string]: any; }; description?: string; op?: string; parent_span_id?: string; span_id: string; status?: string; tags?: { [key: string]: Primitive; }; 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

Optional status?: string

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

[key: string]: Primitive

trace_id: string

isSuccess

Returns boolean

setContext

Parameters

key: string

context: Context

Returns void

setData

Parameters

key: string

value: any

Returns Transaction

setHttpStatus

Parameters

httpStatus: number

Returns Transaction

setMeasurement

Parameters

name: string

value: number

unit: MeasurementUnit

Returns void

setName

Parameters

name: string

Optional source: TransactionSource

Returns void

setStatus

Parameters

status: string

Returns Transaction

setTag

Parameters

`Optional` description

`Optional` endTimestamp

`Optional` op

`Optional` parentSampled

`Optional` parentSpanId

`Optional` sampled

`Optional` status

`Optional` transaction

`Optional` trimEnd

`Optional` endTimestamp: number

Returns {
data?: {
[key: string]: any;
};
description?: string;
op?: string;
parent_span_id?: string;
span_id: string;
status?: string;
tags?: {
[key: string]: Primitive;
};
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` source: TransactionSource

`Optional` spanContext: Pick<SpanContext, "tags" | "data" | "instrumenter" | "description" | "op" | "status" | "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