@opentelemetry/sdk-trace-web | OpenTelemetry SDK

Index

Modules

<internal>

Enumerations

PerformanceTimingNames

Classes

Interfaces

Type Aliases

Functions

Type Aliases

PerformanceEntries

PerformanceEntries: { connectEnd?: number; connectStart?: number; decodedBodySize?: number; domComplete?: number; domContentLoadedEventEnd?: number; domContentLoadedEventStart?: number; domInteractive?: number; domainLookupEnd?: number; domainLookupStart?: number; encodedBodySize?: number; fetchStart?: number; loadEventEnd?: number; loadEventStart?: number; redirectEnd?: number; redirectStart?: number; requestStart?: number; responseEnd?: number; responseStart?: number; secureConnectionStart?: number; unloadEventEnd?: number; unloadEventStart?: number }

Type declaration

Optional connectEnd?: number
Optional connectStart?: number
Optional decodedBodySize?: number
Optional domComplete?: number
Optional domContentLoadedEventEnd?: number
Optional domContentLoadedEventStart?: number
Optional domInteractive?: number
Optional domainLookupEnd?: number
Optional domainLookupStart?: number
Optional encodedBodySize?: number
Optional fetchStart?: number
Optional loadEventEnd?: number
Optional loadEventStart?: number
Optional redirectEnd?: number
Optional redirectStart?: number
Optional requestStart?: number
Optional responseEnd?: number
Optional responseStart?: number
Optional secureConnectionStart?: number
Optional unloadEventEnd?: number
Optional unloadEventStart?: number

PropagateTraceHeaderCorsUrls

PropagateTraceHeaderCorsUrls: PropagateTraceHeaderCorsUrl | PropagateTraceHeaderCorsUrl[]

urls which should include trace headers when origin doesn't match

WebTracerConfig

WebTracerConfig: TracerConfig

WebTracerConfig provides an interface for configuring a Web Tracer.

Functions

addSpanNetworkEvent

addSpanNetworkEvent(span: Span, performanceName: string, entries: PerformanceEntries, refPerfName?: string): api.Span | undefined

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:61
Helper function for starting an event on span based on PerformanceEntries

Parameters
- span: Span
- performanceName: string
  
  name of performance entry for time start
- entries: PerformanceEntries
- Optional refPerfName: string
  
  name of performance entry to use for reference
Returns api.Span | undefined

addSpanNetworkEvents

addSpanNetworkEvents(span: Span, resource: PerformanceEntries): void

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:93
Helper function for adding network events

Parameters
- span: Span
- resource: PerformanceEntries
Returns void

getElementXPath

getElementXPath(target: any, optimised?: boolean): string

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:365
Get element XPath

Parameters
- target: any
  
  target element
- Optional optimised: boolean
  
  when id attribute of element is present the xpath can be simplified to contain id
Returns string

getResource

getResource(spanUrl: string, startTimeHR: HrTime, endTimeHR: HrTime, resources: PerformanceResourceTiming[], ignoredResources?: WeakSet<PerformanceResourceTiming>, initiatorType?: string): PerformanceResourceTimingInfo

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:162
Get closest performance resource ignoring the resources that have been already used.

Parameters
- spanUrl: string
- startTimeHR: HrTime
- endTimeHR: HrTime
- resources: PerformanceResourceTiming[]
- ignoredResources: WeakSet<PerformanceResourceTiming> = ...
- Optional initiatorType: string
Returns PerformanceResourceTimingInfo

hasKey

hasKey<O>(obj: O, key: string | number | symbol): key is keyof O

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:47
Helper function to be able to use enum as typed key in type and in interface when using forEach

Type Parameters
- O extends object
Parameters
- obj: O
- key: string | number | symbol
Returns key is keyof O

normalizeUrl

normalizeUrl(url: string): string

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:353
Parses url using URL constructor or fallback to anchor element and serialize it to a string.

Performs the steps described in https://html.spec.whatwg.org/multipage/urls-and-fetching.html#parse-a-url

Parameters
- url: string
Returns string

parseUrl

parseUrl(url: string): URLLike

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:329
Parses url using URL constructor or fallback to anchor element.

Parameters
- url: string
Returns URLLike

sortResources

sortResources(filteredResources: PerformanceResourceTiming[]): PerformanceResourceTiming[]

- Defined in packages/opentelemetry-sdk-trace-web/src/utils.ts:132
sort resources by startTime

Parameters
- filteredResources: PerformanceResourceTiming[]
Returns PerformanceResourceTiming[]

Index

Modules

Enumerations

Classes

Interfaces

Type Aliases

Functions

Type Aliases

PerformanceEntries

Type declaration

Optional connectEnd?: number

Optional connectStart?: number

Optional decodedBodySize?: number

Optional domComplete?: number

Optional domContentLoadedEventEnd?: number

Optional domContentLoadedEventStart?: number

Optional domInteractive?: number

Optional domainLookupEnd?: number

Optional domainLookupStart?: number

Optional encodedBodySize?: number

Optional fetchStart?: number

Optional loadEventEnd?: number

Optional loadEventStart?: number

Optional redirectEnd?: number

Optional redirectStart?: number

Optional requestStart?: number

Optional responseEnd?: number

Optional responseStart?: number

Optional secureConnectionStart?: number

Optional unloadEventEnd?: number

Optional unloadEventStart?: number

PropagateTraceHeaderCorsUrls

WebTracerConfig

Functions

addSpanNetworkEvent

Parameters

span: Span

performanceName: string

entries: PerformanceEntries

Optional refPerfName: string

Returns api.Span | undefined

addSpanNetworkEvents

Parameters

span: Span

resource: PerformanceEntries

Returns void

getElementXPath

Parameters

target: any

Optional optimised: boolean

Returns string

getResource

Parameters

spanUrl: string

startTimeHR: HrTime

endTimeHR: HrTime

resources: PerformanceResourceTiming[]

ignoredResources: WeakSet<PerformanceResourceTiming> = ...

Optional initiatorType: string

Returns PerformanceResourceTimingInfo

hasKey

Type Parameters

O extends object

Parameters

obj: O

key: string | number | symbol

Returns key is keyof O

normalizeUrl

Parameters

url: string

Returns string

parseUrl

Parameters

url: string

Returns URLLike

sortResources

Parameters

filteredResources: PerformanceResourceTiming[]

Returns PerformanceResourceTiming[]