@opentelemetry/otlp-exporter-base

Index

Enumerations

CompressionAlgorithm

Classes

Interfaces

Functions

appendResourcePathToUrl

appendResourcePathToUrl(url: string, path: string): string

- Defined in experimental/packages/otlp-exporter-base/src/util.ts:52
Adds path (version + signal) to a no per-signal endpoint

Parameters
- url: string
- path: string
Returns string
url + path

appendRootPathToUrlIfNeeded

appendRootPathToUrlIfNeeded(url: string): string

- Defined in experimental/packages/otlp-exporter-base/src/util.ts:64
Adds root path to signal specific endpoint when endpoint contains no path part and no root path

Parameters
- url: string
Returns string
url

configureCompression

configureCompression(compression: undefined | CompressionAlgorithm): CompressionAlgorithm

- Defined in experimental/packages/otlp-exporter-base/src/platform/node/util.ts:215
Parameters
- compression: undefined | CompressionAlgorithm
Returns CompressionAlgorithm

configureExporterTimeout

configureExporterTimeout(timeoutMillis: undefined | number): number

- Defined in experimental/packages/otlp-exporter-base/src/util.ts:82
Configure exporter trace timeout value from passed in value or environment variables

Parameters
- timeoutMillis: undefined | number
Returns number
timeout value in milliseconds

createHttpAgent

createHttpAgent(config: OTLPExporterNodeConfigBase): http.Agent | https.Agent | undefined

- Defined in experimental/packages/otlp-exporter-base/src/platform/node/util.ts:193
Parameters
- config: OTLPExporterNodeConfigBase
Returns http.Agent | https.Agent | undefined

invalidTimeout

invalidTimeout(timeout: number, defaultTimeout: number): number

- Defined in experimental/packages/otlp-exporter-base/src/util.ts:111
Parameters
- timeout: number
- defaultTimeout: number
Returns number

parseHeaders

parseHeaders(partialHeaders?: Partial<Record<string, unknown>>): Record<string, string>

- Defined in experimental/packages/otlp-exporter-base/src/util.ts:30
Parses headers from config leaving only those that have defined values

Parameters
- partialHeaders: Partial<Record<string, unknown>> = {}
Returns Record<string, string>

sendWithHttp

sendWithHttp<ExportItem, ServiceResponse>(collector: OTLPExporterNodeBase<ExportItem, ServiceResponse>, data: string | Uint8Array, contentType: string, onSuccess: (() => void), onError: ((error: OTLPExporterError) => void)): void

- Defined in experimental/packages/otlp-exporter-base/src/platform/node/util.ts:44
Sends data using http

Type Parameters
- ExportItem
- ServiceResponse
Parameters
- collector: OTLPExporterNodeBase<ExportItem, ServiceResponse>
- data: string | Uint8Array
- contentType: string
- onSuccess: (() => void)
  - - (): void
    - Returns void
- onError: ((error: OTLPExporterError) => void)
  - - (error: OTLPExporterError): void
    - Parameters
      - error: OTLPExporterError
      Returns void
Returns void

sendWithXhr

sendWithXhr(body: Uint8Array, url: string, headers: Record<string, string>, exporterTimeout: number, onSuccess: (() => void), onError: ((error: OTLPExporterError) => void)): void

- Defined in experimental/packages/otlp-exporter-base/src/platform/browser/util.ts:60
function to send metrics/spans using browser XMLHttpRequest used when navigator.sendBeacon is not available

Parameters
- body: Uint8Array
- url: string
- headers: Record<string, string>
- exporterTimeout: number
- onSuccess: (() => void)
  - - (): void
    - Returns void
- onError: ((error: OTLPExporterError) => void)
  - - (error: OTLPExporterError): void
    - Parameters
      - error: OTLPExporterError
      Returns void
Returns void

Index

Enumerations

Classes

Interfaces

Functions

Functions

appendResourcePathToUrl

Parameters

url: string

path: string

Returns string

appendRootPathToUrlIfNeeded

Parameters

url: string

Returns string

configureCompression

Parameters

compression: undefined | CompressionAlgorithm

Returns CompressionAlgorithm

configureExporterTimeout

Parameters

timeoutMillis: undefined | number

Returns number

createHttpAgent

Parameters

config: OTLPExporterNodeConfigBase

Returns http.Agent | https.Agent | undefined

invalidTimeout

Parameters

timeout: number

defaultTimeout: number

Returns number

parseHeaders

Parameters

partialHeaders: Partial<Record<string, unknown>> = {}

Returns Record<string, string>

sendWithHttp

Type Parameters

ExportItem

ServiceResponse

Parameters

collector: OTLPExporterNodeBase<ExportItem, ServiceResponse>

data: string | Uint8Array

contentType: string

onSuccess: (() => void)

Returns void

onError: ((error: OTLPExporterError) => void)

Parameters

error: OTLPExporterError

Returns void

Returns void

sendWithXhr

Parameters

body: Uint8Array

url: string

headers: Record<string, string>

exporterTimeout: number

onSuccess: (() => void)

Returns void

onError: ((error: OTLPExporterError) => void)

Parameters

error: OTLPExporterError

Returns void

Returns void