DocsReference@proto-kit/apiClassesOpenTelemetryServer

@proto-kit/apiDocs


Documentation / @proto-kit/api / OpenTelemetryServer

Class: OpenTelemetryServer

Lifecycle of a SequencerModule

start(): Executed to execute any logic required to start the module

Extends

Constructors

new OpenTelemetryServer()

new OpenTelemetryServer(parentContainer): OpenTelemetryServer

Parameters

parentContainer: ModuleContainerLike

Returns

OpenTelemetryServer

Overrides

SequencerModule.constructor

Defined in

packages/api/src/metrics/OpenTelemetryServer.ts:38

Properties

currentConfig

protected currentConfig: undefined | OpenTelemetryServerConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

SequencerModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17


presets

static presets: Presets<unknown>

Inherited from

SequencerModule.presets

Defined in

packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

config: Config

Returns

void

Inherited from

SequencerModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

create()

create(childContainerProvider): void

Parameters

childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

SequencerModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20


start()

start(): Promise<void>

Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.

Returns

Promise<void>

Overrides

SequencerModule.start

Defined in

packages/api/src/metrics/OpenTelemetryServer.ts:54


dependencies()

static dependencies(): object

Returns

object

Tracer

Tracer: object

Tracer.forceOverwrite

Tracer.forceOverwrite: true = true

Tracer.useClass

Tracer.useClass: typeof OpenTelemetryTracer = OpenTelemetryTracer

Defined in

packages/api/src/metrics/OpenTelemetryServer.ts:45