Interface TracerInterface

Hierarchy

TracerInterface

Implemented by

Tracer

Index

Properties

putAnnotation putMetadata

Methods

addErrorAsMetadata addResponseAsMetadata addServiceNameAnnotation annotateColdStart captureAWS captureAWSClient captureAWSv3Client captureLambdaHandler captureMethod getRootXrayTraceId getSegment isTraceSampled isTracingEnabled setSegment

Properties

putAnnotation

putAnnotation: ((key, value) => void)

Type declaration

- (key, value): void
- Parameters
  - key: string
  - value: string | number | boolean
  Returns void

putMetadata

putMetadata: ((key, value, namespace?) => void)

Type declaration

- (key, value, namespace?): void
- Parameters
  - key: string
  - value: unknown
  - Optional namespace: string
  Returns void

Methods

addErrorAsMetadata

addErrorAsMetadata(error, remote?): void
Parameters
- error: Error
- Optional remote: boolean
Returns void
- Defined in tracer/src/TracerInterface.ts:10

addResponseAsMetadata

addResponseAsMetadata(data?, methodName?): void
Parameters
- Optional data: unknown
- Optional methodName: string
Returns void
- Defined in tracer/src/TracerInterface.ts:11

addServiceNameAnnotation

addServiceNameAnnotation(): void
Returns void
- Defined in tracer/src/TracerInterface.ts:12

annotateColdStart

annotateColdStart(): void
Returns void
- Defined in tracer/src/TracerInterface.ts:13

captureAWS

captureAWS<T>(aws): void | T
Type Parameters
- T
Parameters
- aws: T
Returns void | T
- Defined in tracer/src/TracerInterface.ts:14

captureAWSClient

captureAWSClient<T>(service): void | T
Type Parameters
- T
Parameters
- service: T
Returns void | T
- Defined in tracer/src/TracerInterface.ts:16

captureAWSv3Client

captureAWSv3Client<T>(service): void | T
Type Parameters
- T
Parameters
- service: T
Returns void | T
- Defined in tracer/src/TracerInterface.ts:15

captureLambdaHandler

captureLambdaHandler(options?): HandlerMethodDecorator
Parameters
- Optional options: CaptureLambdaHandlerOptions
Returns HandlerMethodDecorator
- Defined in tracer/src/TracerInterface.ts:17

captureMethod

captureMethod(options?): MethodDecorator
Parameters
- Optional options: CaptureMethodOptions
Returns MethodDecorator
- Defined in tracer/src/TracerInterface.ts:20

getRootXrayTraceId

getRootXrayTraceId(): undefined | string
Returns undefined | string
- Defined in tracer/src/TracerInterface.ts:22

getSegment

getSegment(): undefined | Segment | Subsegment
Returns undefined | Segment | Subsegment
- Defined in tracer/src/TracerInterface.ts:21

isTraceSampled

isTraceSampled(): boolean
Returns boolean
- Defined in tracer/src/TracerInterface.ts:23

isTracingEnabled

isTracingEnabled(): boolean
Returns boolean
- Defined in tracer/src/TracerInterface.ts:24

setSegment

setSegment(segment): void
Parameters
- segment: Segment | Subsegment
Returns void
- Defined in tracer/src/TracerInterface.ts:31

Generated using TypeDoc