Skip to main content

OtelServiceParameters

@webda/otel

Class: OtelServiceParameters

Defined in: otel/src/otel.service.ts:83

OpenTelemetry service parameters

Extends​

  • ServiceParameters

Constructors​

Constructor​

new OtelServiceParameters(): OtelServiceParameters

Returns​

OtelServiceParameters

Inherited from​

ServiceParameters.constructor

Properties​

diagnostic?​

optional diagnostic?: "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE" | "NONE" | "ALL"

Defined in: otel/src/otel.service.ts:137

Diagnostic

Default​

NONE

loggerExporter?​

optional loggerExporter?: object

Defined in: otel/src/otel.service.ts:119

Logger export If empty it is disabled

Values (url, headers...) can be encrypted with webda config encrypt

enable?​

optional enable?: boolean

Allow to disable the logger

Default​
true

type?​

optional type?: "otlp"

url?​

optional url?: string | SecretString

Can be encrypted with webda config encrypt (when it holds credentials)

Default​
http://localhost:4317

metricExporter?​

optional metricExporter?: object

Defined in: otel/src/otel.service.ts:105

Metric exporter

enable?​

optional enable?: boolean

Allow to disable the metric exporter

Default​
true

type​

type: "console" | "otlp"

name?​

optional name?: string

Defined in: otel/src/otel.service.ts:141

Service name reported to OpenTelemetry, default to the package name

traceExporter​

traceExporter: object

Defined in: otel/src/otel.service.ts:88

Trace export configuration

enable?​

optional enable?: boolean

Allow to disable the trace exporter

Default​
true

sampling​

sampling: number

Between 0.0 and 1.0

Default​
0.01

type​

type: "console" | "otlp"

Default​

{"type":"otlp","enable":true,"sampling":0.01}

trustedTraceSources?​

optional trustedTraceSources?: string[]

Defined in: otel/src/otel.service.ts:164

Sources (IP or CIDR) whose traceparent and baggage are always honored

Default​

[]

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

webTracing?​

optional webTracing?: object

Defined in: otel/src/otel.service.ts:146

On-demand web tracing: an authorized user gets a short-lived token, the browser sends it as X-Webda-Trace to have its traceparent and baggage honored

allowedEmails?​

optional allowedEmails?: string[]

Emails allowed to enable web tracing, as regular expressions matching the whole email ("*" means any authenticated user). Empty or missing means nobody.

duration?​

optional duration?: number

Token lifetime in seconds

Default​
900

Methods​

load()​

load(params?): this

Defined in: otel/src/otel.service.ts:171

Apply default values

Parameters​

params?​

any = {}

the service parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with