Class BaseOtelService

constructor

• new BaseOtelService(root0: BaseOtelServiceOptions): BaseOtelService

  Bootstraps an Otel exporter which can send Otel metrics to a dedicated Shopify supported collector endpoint.

  Parameters

  • root0: BaseOtelServiceOptions

    • OptionalmeterProvider?: MeterProvider

      Override the default meter provider.

    • Optionalmetrics?: MetricsConfig

      Metrics to register on startup.

    • OptionalonRecord?: OnRecordCallback

      Called when a metric is recorded. addOnRecord can also be used to add listeners anytime.

    • OptionalprefixMetric?: boolean

      If this is set to true then the service name is prefixed to every metric.

    • serviceName: string

      Service name is a unique name for an application/service.

  Returns BaseOtelService

ReadonlyprefixMetric

ReadonlyserviceName

addOnRecord

• addOnRecord(onRecord: OnRecordCallback): () => void

  onRecord callback is called when a metric is recorded. Returns a function to unsubscribe.

  Parameters

  • onRecord: OnRecordCallback

  Returns () => void

addView

• addView(viewOptions: ViewOptions): void

  Parameters

  • viewOptions: ViewOptions

  Returns void

getMeterProvider

• getMeterProvider(): MeterProvider

  Returns MeterProvider

record

• record(metricName: string, value: number, labels?: Attributes): void

  Parameters

  • metricName: string
  • value: number
  • Optionallabels: Attributes

  Returns void

register

• register(metrics: MetricsConfig): void

  Parameters

  • metrics: MetricsConfig

  Returns void

registerMetric

• registerMetric(metricName: string, __namedParameters: MetricDescriptor): void

  Parameters

  • metricName: string
  • __namedParameters: MetricDescriptor

  Returns void

removeOnRecord

• removeOnRecord(onRecord: OnRecordCallback): void

  Parameters

  • onRecord: OnRecordCallback

  Returns void

shutdown

• shutdown(): Promise<void>

  Returns Promise<void>