Class SBObservable

BSB Observable Controller - Unified logging, metrics, and tracing

This class is responsible for managing all observability in the BSB framework. It coordinates observable plugins (like OpenTelemetry, Prometheus, etc.) and routes events from the Observable API to the configured backends.

If you have a specific way of managing observability, you can extend this class and use your own class when creating the ServiceBase instance.

See

API: SBObservable

Example

// Custom observable controller
class MyObservable extends SBObservable {
  // Override methods as needed
}

// Use custom controller
const serviceBase = new ServiceBase(appId, {
  observableClass: MyObservable
});

Index

Constructors

constructor

new SBObservable(
    appId: string,
    mode: DEBUG_MODE,
    cwd: string,
    sbPlugins: SBPlugins,
): SBObservable
Create an SBObservable instance
Parameters
- appId: string
  Application ID
- mode: DEBUG_MODE
  Debug mode (development, production, production-debug)
- cwd: string
  Current working directory
- sbPlugins: SBPlugins
  Plugin manager instance
Returns SBObservable
- Defined in src/serviceBase/observable.ts:106

Properties

observableBus

observableBus: EventEmitter = ...

Accessors

isReady

get isReady(): boolean
Check if observable plugins are ready

Returns boolean
true if all plugins have been initialized
- Defined in src/serviceBase/observable.ts:95

Methods

setupObservablePlugins

setupObservablePlugins(sbConfig: SBConfig): Promise<void>
Setup and load observable plugins from configuration

Loads configured observable plugins and initializes their filters. This is called during ServiceBase initialization.
Parameters
- sbConfig: SBConfig
  Configuration manager instance
Returns Promise<void>
- Defined in src/serviceBase/observable.ts:418

init

init(trace: DTrace, sbConfig: SBConfig): Promise<void>
Initialize all observable plugins

Calls the init lifecycle method on all loaded observable plugins. This is called during ServiceBase initialization.
Parameters
- trace: DTrace
  DTrace for tracking initialization
- sbConfig: SBConfig
  Configuration manager instance
Returns Promise<void>
- Defined in src/serviceBase/observable.ts:511

run

run(trace: DTrace): Promise<void>
Run all observable plugins

Calls the run lifecycle method on all loaded observable plugins. This is called during ServiceBase startup.
Parameters
- trace: DTrace
  DTrace for tracking the run phase
Returns Promise<void>
- Defined in src/serviceBase/observable.ts:532

dispose

dispose(): Promise<void>
Dispose all observable plugins

Calls the dispose lifecycle method on all loaded observable plugins and clears the plugin list. This is called during ServiceBase shutdown.

Returns Promise<void>
- Defined in src/serviceBase/observable.ts:564

debug

debug(plugin: string, trace: DTrace, message: string, meta: LogMeta<any>): void
Emit a debug log event
Parameters
- plugin: string
  Plugin name
- trace: DTrace
  DTrace object
- message: string
  Log message
- meta: LogMeta<any>
  Log metadata
Returns void
- Defined in src/serviceBase/observable.ts:581

info

info(plugin: string, trace: DTrace, message: string, meta: LogMeta<any>): void
Emit an info log event
Parameters
- plugin: string
  Plugin name
- trace: DTrace
  DTrace object
- message: string
  Log message
- meta: LogMeta<any>
  Log metadata
Returns void
- Defined in src/serviceBase/observable.ts:592

warn

warn(plugin: string, trace: DTrace, message: string, meta: LogMeta<any>): void
Emit a warn log event
Parameters
- plugin: string
  Plugin name
- trace: DTrace
  DTrace object
- message: string
  Log message
- meta: LogMeta<any>
  Log metadata
Returns void
- Defined in src/serviceBase/observable.ts:603

error

error(
    plugin: string,
    trace: DTrace,
    message: string | BSBError<any>,
    meta?: LogMeta<any>,
): void
Emit an error log event
Parameters
- plugin: string
  Plugin name
- trace: DTrace
  DTrace object
- message: string | BSBError<any>
  Log message or BSBError
- Optionalmeta: LogMeta<any>
  Log metadata (optional)
Returns void
- Defined in src/serviceBase/observable.ts:614

createCounter

createCounter(
    timestamp: number,
    pluginName: string,
    name: string,
    description: string,
    help: string,
    labels?: string[],
): void
Emit counter creation event
Parameters
- timestamp: number
  Event timestamp
- pluginName: string
  Plugin name
- name: string
  Metric name
- description: string
  Short description
- help: string
  Detailed help text
- Optionallabels: string[]
  Optional label names
Returns void
- Defined in src/serviceBase/observable.ts:628

incrementCounter

incrementCounter(
    timestamp: number,
    pluginName: string,
    name: string,
    value: number,
    labels?: Record<string, string>,
): void
Emit counter increment event
Parameters
- timestamp: number
  Event timestamp
- pluginName: string
  Plugin name
- name: string
  Metric name
- value: number
  Increment value
- Optionallabels: Record<string, string>
  Optional label values
Returns void
- Defined in src/serviceBase/observable.ts:640

createGauge

createGauge(
    timestamp: number,
    pluginName: string,
    name: string,
    description: string,
    help: string,
    labels?: string[],
): void
Emit gauge creation event
Parameters
- timestamp: number
  Event timestamp
- pluginName: string
  Plugin name
- name: string
  Metric name
- description: string
  Short description
- help: string
  Detailed help text
- Optionallabels: string[]
  Optional label names
Returns void
- Defined in src/serviceBase/observable.ts:653

setGauge

setGauge(
    timestamp: number,
    pluginName: string,
    name: string,
    value: number,
    labels?: Record<string, string>,
): void
Emit gauge set event
Parameters
- timestamp: number
  Event timestamp
- pluginName: string
  Plugin name
- name: string
  Metric name
- value: number
  New gauge value
- Optionallabels: Record<string, string>
  Optional label values
Returns void
- Defined in src/serviceBase/observable.ts:665

createHistogram

createHistogram(
    timestamp: number,
    pluginName: string,
    name: string,
    description: string,
    help: string,
    boundaries?: number[],
    labels?: string[],
): void
Emit histogram creation event
Parameters
- timestamp: number
  Event timestamp
- pluginName: string
  Plugin name
- name: string
  Metric name
- description: string
  Short description
- help: string
  Detailed help text
- Optionalboundaries: number[]
  Optional histogram boundaries
- Optionallabels: string[]
  Optional label names
Returns void
- Defined in src/serviceBase/observable.ts:679

observeHistogram

observeHistogram(
    timestamp: number,
    pluginName: string,
    name: string,
    value: number,
    labels?: Record<string, string>,
): void
Emit histogram observation event
Parameters
- timestamp: number
  Event timestamp
- pluginName: string
  Plugin name
- name: string
  Metric name
- value: number
  Observed value
- Optionallabels: Record<string, string>
  Optional label values
Returns void
- Defined in src/serviceBase/observable.ts:691

startSpan

startSpan(
    timestamp: number,
    appId: string,
    pluginName: string,
    traceId: string,
    parentSpanId: string | null,
    spanId: string,
    name: string,
    attributes?: Record<string, string | number | boolean>,
): void
Emit span start event
Parameters
- timestamp: number
  Event timestamp
- appId: string
  Application ID
- pluginName: string
  Plugin name
- traceId: string
  Trace ID
- parentSpanId: string | null
  Parent span ID (null for root spans)
- spanId: string
  This span's ID
- name: string
  Span name
- Optionalattributes: Record<string, string | number | boolean>
  Optional span attributes
Returns void
- Defined in src/serviceBase/observable.ts:706

endSpan

endSpan(
    timestamp: number,
    appId: string,
    pluginName: string,
    traceId: string,
    spanId: string,
    attributes?: Record<string, string | number | boolean>,
): void
Emit span end event
Parameters
- timestamp: number
  Event timestamp
- appId: string
  Application ID
- pluginName: string
  Plugin name
- traceId: string
  Trace ID
- spanId: string
  Span ID
- Optionalattributes: Record<string, string | number | boolean>
  Optional final attributes
Returns void
- Defined in src/serviceBase/observable.ts:719

errorSpan

errorSpan(
    timestamp: number,
    appId: string,
    pluginName: string,
    traceId: string,
    spanId: string,
    error: Error,
    attributes?: Record<string, string | number | boolean>,
): void
Emit span error event
Parameters
- timestamp: number
  Event timestamp
- appId: string
  Application ID
- pluginName: string
  Plugin name
- traceId: string
  Trace ID
- spanId: string
  Span ID
- error: Error
  Error to record
- Optionalattributes: Record<string, string | number | boolean>
  Optional error attributes
Returns void
- Defined in src/serviceBase/observable.ts:733

Class SBObservable

See

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SBObservable

Properties

observableBus

Accessors

isReady

Returns boolean

Methods

setupObservablePlugins

Parameters

Returns Promise<void>

init

Parameters

Returns Promise<void>

run

Parameters

Returns Promise<void>

dispose

Returns Promise<void>

debug

Parameters

Returns void

info

Parameters

Returns void

warn

Parameters

Returns void

error

Parameters

Returns void

createCounter

Parameters

Returns void

incrementCounter

Parameters

Returns void

createGauge

Parameters

Returns void

setGauge

Parameters

Returns void

createHistogram

Parameters

Returns void

observeHistogram

Parameters

Returns void

startSpan

Parameters

Returns void

endSpan

Parameters

Returns void

errorSpan

Parameters

Returns void

Settings

On This Page