Interface TraceGeneratorFunctionOptions<A, B, C>

interface TraceGeneratorFunctionOptions<A, B, C = any> {
    optionsIndex?: number;
    getAttributesFromArgs(
        args: A,
        attributes: TraceAttributes,
    ): TraceAttributes;
    getAttributesFromReturnValue(
        value: B,
        attributes: TraceAttributes,
    ): TraceAttributes;
    getAttributesFromYieldedValue(
        value: C,
        attributes: TraceAttributes,
        index: number,
    ): TraceAttributes;
}

Type Parameters

A
B
C = any

Hierarchy (View Summary)

TraceFunctionOptions<A, B>
- TraceGeneratorFunctionOptions

Index

Properties

Methods

getAttributesFromArgs? getAttributesFromReturnValue? getAttributesFromYieldedValue?

Properties

`Optional`optionsIndex

optionsIndex?: number

To construct a trace that spans multiple method invocations, it's necessary to pass the trace context onwards as part of the options object.

Specify the index of the options object in the args array here.

Default

Methods

`Optional`getAttributesFromArgs

getAttributesFromArgs(args: A, attributes: TraceAttributes): TraceAttributes
Set attributes on the trace by modifying the passed attributes object.
Parameters
- args: A
- attributes: TraceAttributes
Returns TraceAttributes
Inherited from TraceFunctionOptions.getAttributesFromArgs
- Defined in packages/interface/src/metrics.ts:531

`Optional`getAttributesFromReturnValue

getAttributesFromReturnValue(
value: B,
attributes: TraceAttributes,
): TraceAttributes
Set attributes on the trace by modifying the passed attributes object. The object will have previously been passed to appendAttributesFromArgs and/or appendAttributesFromYieldedValue (if defined)
Parameters
- value: B
- attributes: TraceAttributes
Returns TraceAttributes
Inherited from TraceFunctionOptions.getAttributesFromReturnValue
- Defined in packages/interface/src/metrics.ts:538

`Optional`getAttributesFromYieldedValue

getAttributesFromYieldedValue(
    value: C,
    attributes: TraceAttributes,
    index: number,
): TraceAttributes
Set attributes on the trace by modifying the passed attributes object. The object will have previously been passed to appendAttributesFromArgs (if defined)
Parameters
- value: C
- attributes: TraceAttributes
- index: number
Returns TraceAttributes
- Defined in packages/interface/src/metrics.ts:547