Class BSBObservable<ReferencedConfig>`Abstract`

Unified Observable plugin base class for logging, metrics, and tracing

See

API: BSBObservable

Type Parameters

ReferencedConfig extends BSBReferencePluginConfigType = any
The type of configuration for the plugin

Index

Constructors

constructor

new BSBObservable<ReferencedConfig extends BSBReferencePluginConfigType = any>(
config: BSBObservableConstructor<ReferencedConfig>,
): BSBObservable<ReferencedConfig>
Type Parameters
- ReferencedConfig extends BSBReferencePluginConfigType = any
  The type of configuration for the plugin
Parameters
- config: BSBObservableConstructor<ReferencedConfig>
Returns BSBObservable<ReferencedConfig>
Overrides BaseWithConfig< ReferencedConfig extends null ? null : BSBReferencePluginConfigDefinition<ReferencedConfig> & any >.constructor
- Defined in src/base/BSBObservable.ts:57

Properties

`Readonly`appId

appId: string = "tbd"

The unique app id of the app that is running

See

API: MainBase.appId

`Readonly`mode

mode: DEBUG_MODE = "development"

The mode the app is running in

Example

production (production mode - no debug)

Example

production-debug (production mode - debug)

Example

development (development mode - debug)

See

API: MainBase.mode

`Readonly`cwd

cwd: string

The current working directory of the app

See

API: MainBase.cwd

`Readonly`packageCwd

packageCwd: string

The current working directory of the plugin

See

API: MainBase.packageCwd

`Readonly`pluginCwd

pluginCwd: string

The current working directory of the service

See

API: MainBase.pluginCwd

`Readonly`pluginName

pluginName: string

The name of the plugin This is also the mapped name, or the name defined in the config rather than it's original defined name

See

API: MainBase.pluginName

`Optional` `Readonly`region

region?: string

The deployment region for resource context

See

API: MainBase.region

`Readonly`config

config: ConfigPropertyTypeSafe<ReferencedConfig extends null ? null : any>

The config of the plugin

Methods

`Optional`debug

debug?(
    trace: DTrace,
    pluginName: string,
    message: string,
    meta: LogMeta<any>,
): void
Logging: Debug level
Parameters
- trace: DTrace
  Trace for tracking the operation
- pluginName: string
  Name of the plugin emitting the log
- message: string
  Log message
- meta: LogMeta<any>
  Metadata
Returns void
- Defined in src/base/BSBObservable.ts:68

`Optional`info

info?(
    trace: DTrace,
    pluginName: string,
    message: string,
    meta: LogMeta<any>,
): void
Logging: Info level
Parameters
- trace: DTrace
  Trace for tracking the operation
- pluginName: string
  Name of the plugin emitting the log
- message: string
  Log message
- meta: LogMeta<any>
  Metadata
Returns void
- Defined in src/base/BSBObservable.ts:77

`Optional`warn

warn?(
    trace: DTrace,
    pluginName: string,
    message: string,
    meta: LogMeta<any>,
): void
Logging: Warn level
Parameters
- trace: DTrace
  Trace for tracking the operation
- pluginName: string
  Name of the plugin emitting the log
- message: string
  Log message
- meta: LogMeta<any>
  Metadata
Returns void
- Defined in src/base/BSBObservable.ts:86

`Optional`error

error?(
    trace: DTrace,
    pluginName: string,
    message: string | BSBError<any>,
    meta?: LogMeta<any>,
): void
Logging: Error level
Parameters
- trace: DTrace
  Trace for tracking the operation
- pluginName: string
  Name of the plugin emitting the log
- message: string | BSBError<any>
  Log message or error object
- Optionalmeta: LogMeta<any>
  Metadata
Returns void
- Defined in src/base/BSBObservable.ts:95

`Optional`createCounter

createCounter?(
    timestamp: number,
    pluginName: string,
    name: string,
    description: string,
    help: string,
    labels?: string[],
): void | Promise<void>
Metrics: Counter creation
Parameters
- timestamp: number
  Timestamp of the metric
- pluginName: string
  Name of the plugin emitting the metric
- name: string
  Metric name
- description: string
  Metric description
- help: string
  Help text
- Optionallabels: string[]
  Optional labels
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:106

`Optional`createGauge

createGauge?(
    timestamp: number,
    pluginName: string,
    name: string,
    description: string,
    help: string,
    labels?: string[],
): void | Promise<void>
Metrics: Gauge creation
Parameters
- timestamp: number
  Timestamp of the metric
- pluginName: string
  Name of the plugin emitting the metric
- name: string
  Metric name
- description: string
  Metric description
- help: string
  Help text
- Optionallabels: string[]
  Optional labels
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:124

`Optional`createHistogram

createHistogram?(
    timestamp: number,
    pluginName: string,
    name: string,
    description: string,
    help: string,
    boundaries?: number[],
    labels?: string[],
): void | Promise<void>
Metrics: Histogram creation
Parameters
- timestamp: number
  Timestamp of the metric
- pluginName: string
  Name of the plugin emitting the metric
- name: string
  Metric name
- description: string
  Metric description
- help: string
  Help text
- Optionalboundaries: number[]
  Histogram boundaries
- Optionallabels: string[]
  Optional labels
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:143

`Optional`incrementCounter

incrementCounter?(
    timestamp: number,
    pluginName: string,
    name: string,
    value: number,
    labels?: Record<string, string>,
): void | Promise<void>
Metrics: Counter increment
Parameters
- timestamp: number
  Timestamp of the metric
- pluginName: string
  Name of the plugin emitting the metric
- name: string
  Metric name
- value: number
  Increment value
- Optionallabels: Record<string, string>
  Optional label values
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:161

`Optional`setGauge

setGauge?(
    timestamp: number,
    pluginName: string,
    name: string,
    value: number,
    labels?: Record<string, string>,
): void | Promise<void>
Metrics: Gauge set
Parameters
- timestamp: number
  Timestamp of the metric
- pluginName: string
  Name of the plugin emitting the metric
- name: string
  Metric name
- value: number
  Gauge value
- Optionallabels: Record<string, string>
  Optional label values
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:177

`Optional`observeHistogram

observeHistogram?(
    timestamp: number,
    pluginName: string,
    name: string,
    value: number,
    labels?: Record<string, string>,
): void | Promise<void>
Metrics: Histogram observe
Parameters
- timestamp: number
  Timestamp of the metric
- pluginName: string
  Name of the plugin emitting the metric
- name: string
  Metric name
- value: number
  Observed value
- Optionallabels: Record<string, string>
  Optional label values
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:193

`Optional`spanStart

spanStart?(
    trace: DTrace,
    pluginName: string,
    spanName: string,
    parentSpanId: string | null,
    attributes?: Record<string, string | number | boolean>,
): void | Promise<void>
Tracing: Span start
Parameters
- trace: DTrace
  Span trace (contains trace ID and new span ID)
- pluginName: string
  Name of the plugin creating the span
- spanName: string
  Name of the span
- parentSpanId: string | null
  Parent span ID (null for root spans)
- Optionalattributes: Record<string, string | number | boolean>
  Span attributes
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:209

`Optional`spanEnd

spanEnd?(
    trace: DTrace,
    pluginName: string,
    attributes?: Record<string, string | number | boolean>,
): void | Promise<void>
Tracing: Span end
Parameters
- trace: DTrace
  Span trace
- pluginName: string
  Name of the plugin ending the span
- Optionalattributes: Record<string, string | number | boolean>
  Final attributes
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:223

`Optional`spanError

spanError?(
    trace: DTrace,
    pluginName: string,
    error: Error,
    attributes?: Record<string, string | number | boolean>,
): void | Promise<void>
Tracing: Span error
Parameters
- trace: DTrace
  Span trace
- pluginName: string
  Name of the plugin recording the error
- error: Error
  Error object
- Optionalattributes: Record<string, string | number | boolean>
  Error attributes
Returns void | Promise<void>
- Defined in src/base/BSBObservable.ts:236

`Optional` `Abstract`dispose

dispose?(): void
Dispose Optional function to be called when the plugin is being disposed

Returns void
Example
```
dispose?(): void; //to not use it
```
Example
```
dispose() { your code here };
```
See
API: Base.dispose
Inherited from BaseWithConfig.dispose
- Defined in src/base/base.ts:146

`Optional` `Abstract`init

init?(obs: Observable): void | Promise<void>
Init Optional function to be called when the plugin is being initialized Can be sync or async
Parameters
- obs: Observable
  Observable context with logging, metrics, and trace information
Returns void | Promise<void>
Remarks
v9 BREAKING CHANGE: Now requires Observable instead of DTrace. Observable provides unified access to logging, metrics, and tracing with automatic context propagation.
Example
```
async init(obs: Observable) {
  obs.log.info("Initializing plugin");
  // Set attributes for all child operations
  const withVersion = obs.setAttribute("plugin.version", "1.0.0");
}
```
See
API: Base.init
Inherited from BaseWithConfig.init
- Defined in src/base/base.ts:170

`Optional` `Abstract`run

run?(obs: Observable): void | Promise<void>
Run Optional function to be called when the plugin is being run Can be sync or async
Parameters
- obs: Observable
  Observable context with logging, metrics, and trace information
Returns void | Promise<void>
Remarks
v9 BREAKING CHANGE: Now requires Observable instead of DTrace. Observable provides unified access to logging, metrics, and tracing with automatic context propagation.
Example
```
async run(obs: Observable) {
  obs.log.info("Running plugin");
  // Create child span for work
  const workObs = obs.startSpan("do-work");
  // ... do work ...
  workObs.end();
}
```
See
API: Base.run
Inherited from BaseWithConfig.run
- Defined in src/base/base.ts:196

Class BSBObservable<ReferencedConfig>Abstract

See

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BSBObservable<ReferencedConfig>

Properties

ReadonlyappId

See

Readonlymode

Example

Example

Example

See

Readonlycwd

See

ReadonlypackageCwd

See

ReadonlypluginCwd

See

ReadonlypluginName

See

Optional Readonlyregion

See

Readonlyconfig

Methods

Optionaldebug

Parameters

Returns void

Optionalinfo

Parameters

Returns void

Optionalwarn

Parameters

Returns void

Optionalerror

Parameters

Returns void

OptionalcreateCounter

Parameters

Returns void | Promise<void>

OptionalcreateGauge

Parameters

Returns void | Promise<void>

OptionalcreateHistogram

Parameters

Returns void | Promise<void>

OptionalincrementCounter

Parameters

Returns void | Promise<void>

OptionalsetGauge

Parameters

Returns void | Promise<void>

OptionalobserveHistogram

Parameters

Returns void | Promise<void>

OptionalspanStart

Parameters

Returns void | Promise<void>

OptionalspanEnd

Parameters

Returns void | Promise<void>

OptionalspanError

Parameters

Returns void | Promise<void>

Optional Abstractdispose

Returns void

Example

Example

See

Optional Abstractinit

Parameters

Returns void | Promise<void>

Remarks

Class BSBObservable<ReferencedConfig>`Abstract`

`Readonly`appId

`Readonly`mode

`Readonly`cwd

`Readonly`packageCwd

`Readonly`pluginCwd

`Readonly`pluginName

`Optional` `Readonly`region

`Readonly`config

`Optional`debug

`Optional`info

`Optional`warn

`Optional`error

`Optional`createCounter

`Optional`createGauge

`Optional`createHistogram

`Optional`incrementCounter

`Optional`setGauge

`Optional`observeHistogram

`Optional`spanStart

`Optional`spanEnd

`Optional`spanError

`Optional` `Abstract`dispose

`Optional` `Abstract`init

`Optional` `Abstract`run