Class ObservabilityAppManager

Manages the lifecycle and configuration of an Express application dedicated to observability. This includes setting up middleware, routing, and server configuration. It also supports dynamic registration of services and links for enhanced observability.

Index

Constructors

constructor

new ObservabilityAppManager(
options: ObservabilityOptions,
registry: Registry<"text/plain; version=0.0.4; charset=utf-8">,
): ObservabilityAppManager
Create an instance of observability service
Parameters
- options: ObservabilityOptions
  observability options
- registry: Registry<"text/plain; version=0.0.4; charset=utf-8">
  registry to be used for endpoints metrics
Returns ObservabilityAppManager

Accessors

isBuild

get isBuild(): boolean
Indicates whether the server has been initialized.

Returns boolean

Methods

build

build(): void
Constructs the server with the configured options.

Returns void

register

register(service: Layer.App.Service | Layer.App.Service[]): void
Registers a new service with the observability app.
Parameters
- service: Layer.App.Service | Layer.App.Service[]
Returns void

start

start(): Promise<void>
Starts the server if it has been built.

Returns Promise<void>

stop

stop(): Promise<void>
Stops the server if it is running.

Returns Promise<void>

unbuilt

unbuilt(): void
Resets the server to its initial state.

Returns void

Class ObservabilityAppManager

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ObservabilityAppManager

Accessors

isBuild

Returns boolean

links

Returns Links

Methods

build

Returns void

register

Parameters

Returns void

start

Returns Promise<void>

stop

Returns Promise<void>

unbuilt

Returns void

Settings

On This Page