Class DefaultOtelService

Hierarchy (View Summary)

BaseOtelService
- DefaultOtelService

Index

Constructors

Properties

meterProvider metrics prefixMetric recordListeners serviceName

Methods

addOnRecord addView getMeterProvider notifyRecordListeners record register registerMetric removeOnRecord shutdown

Constructors

constructor

new DefaultOtelService(
__namedParameters: DefaultOtelServiceOptions,
): DefaultOtelService
Bootstraps an Otel exporter which can send Otel metrics to a dedicated Shopify supported collector endpoint.
Parameters
- __namedParameters: DefaultOtelServiceOptions
Returns DefaultOtelService
Overrides BaseOtelService.constructor
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/DefaultOtelService/DefaultOtelService.ts:29

Properties

`Protected` `Readonly`meterProvider

meterProvider: MeterProvider

`Protected` `Readonly`metrics

metrics: Map<string, RecordMetricFunction> = ...

`Readonly`prefixMetric

prefixMetric: boolean

`Protected` `Readonly`recordListeners

recordListeners: Set<OnRecordCallback> = ...

`Readonly`serviceName

serviceName: string

Methods

addOnRecord

addOnRecord(onRecord: OnRecordCallback): () => void
onRecord callback is called when a metric is recorded. Returns a function to unsubscribe.
Parameters
- onRecord: OnRecordCallback
Returns () => void
Inherited from BaseOtelService.addOnRecord
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:152

addView

addView(viewOptions: ViewOptions): void
Parameters
- viewOptions: ViewOptions
Returns void
Inherited from BaseOtelService.addView
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:78

getMeterProvider

getMeterProvider(): MeterProvider
Returns MeterProvider
Inherited from BaseOtelService.getMeterProvider
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:74

`Protected`notifyRecordListeners

notifyRecordListeners(
    metricName: string,
    initialValue: number,
    initialLabels: Attributes,
): MetricRecording
Parameters
- metricName: string
- initialValue: number
- initialLabels: Attributes
Returns MetricRecording
Inherited from BaseOtelService.notifyRecordListeners
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:169

record

record(metricName: string, value: number, labels?: Attributes): void
Parameters
- metricName: string
- value: number
- Optionallabels: Attributes
Returns void
Inherited from BaseOtelService.record
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:84

register

register(metrics: MetricsConfig): void
Parameters
- metrics: MetricsConfig
Returns void
Inherited from BaseOtelService.register
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:146

registerMetric

registerMetric(metricName: string, __namedParameters: MetricDescriptor): void
Parameters
- metricName: string
- __namedParameters: MetricDescriptor
Returns void
Inherited from BaseOtelService.registerMetric
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:94

removeOnRecord

removeOnRecord(onRecord: OnRecordCallback): void
Parameters
- onRecord: OnRecordCallback
Returns void
Inherited from BaseOtelService.removeOnRecord
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/BaseOtelService/BaseOtelService.ts:159

shutdown

shutdown(): Promise<void>
Returns Promise<void>
Overrides BaseOtelService.shutdown
- Defined in packages/cli-kit/src/public/node/vendor/otel-js/service/DefaultOtelService/DefaultOtelService.ts:64