Class OINOBenchmark`Abstract`

Static class for benchmarking functions.

Hierarchy (View Summary)

OINOBenchmark
- OINOMemoryBenchmark

Index

Constructors

Methods

addHealthBenchmark endMetric getExceptions getHealth getInstance getMetric getMetrics removeHealthBenchmark reset setEnabled setHealthLateRatio setInstance startMetric trackException trackMetric

Constructors

constructor

new OINOBenchmark(enabledModules?: string[]): OINOBenchmark
Create a new OINOBenchmark instance.
Parameters
- enabledModules: string[] = []
  array of those benchmarks that are enabled
Returns OINOBenchmark
- Defined in common/src/OINOBenchmark.ts:23

Methods

`Static`addHealthBenchmark

addHealthBenchmark(module: string, method: string): void
Add benchmark to be used for service health monitoring.
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
Returns void
- Defined in common/src/OINOBenchmark.ts:52

`Static`endMetric

endMetric(module: string, method: string, success?: boolean): void
Complete benchmark timing
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
- success: boolean = true
  indicates if the benchmark was successful
Returns void
- Defined in common/src/OINOBenchmark.ts:131

`Static`getExceptions

getExceptions(): any[]
Get all tracked exceptions.

Returns any[]
- Defined in common/src/OINOBenchmark.ts:190

`Static`getHealth

getHealth(): number
Get service health based on the configured health benchmark.

Returns number
service health as 0-1
- Defined in common/src/OINOBenchmark.ts:85

`Static`getInstance

getInstance(): OINOBenchmark
Get active benchmarking instance.

Returns OINOBenchmark
- Defined in common/src/OINOBenchmark.ts:43

`Static`getMetric

getMetric(module: string, method: string): number
Get given benchmark data.
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
Returns number
- Defined in common/src/OINOBenchmark.ts:143

`Static`getMetrics

getMetrics(): Record<string, number>
Get all benchmark data.

Returns Record<string, number>
- Defined in common/src/OINOBenchmark.ts:152

`Static`removeHealthBenchmark

removeHealthBenchmark(module: string, method: string): void
Remove benchmark from being used for service health monitoring.
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
Returns void
- Defined in common/src/OINOBenchmark.ts:64

`Static`reset

reset(): void
Reset benchmark data (but not what is enabled).

Returns void
- Defined in common/src/OINOBenchmark.ts:96

`Static`setEnabled

setEnabled(modules: string[]): void
Set benchmark names that are enabled.
Parameters
- modules: string[]
  array of those benchmarks that are enabled
Returns void
- Defined in common/src/OINOBenchmark.ts:105

`Static`setHealthLateRatio

setHealthLateRatio(lateRatio: number): void
Set late ratio threshold for health monitoring. If a request takes this many times longer than the average duration, it is considered late and a health failure.
Parameters
- lateRatio: number
  of health benchmarks, e.g. 2.0 means requests that take 2 times longer than the average
Returns void
- Defined in common/src/OINOBenchmark.ts:76

`Static`setInstance

setInstance(instance: OINOBenchmark): void
Set active benchmarking instance.
Parameters
- instance: OINOBenchmark
  OINOBenchmark instance
Returns void
- Defined in common/src/OINOBenchmark.ts:33

`Static`startMetric

startMetric(module: string, method: string): void
Start benchmark timing.
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
Returns void
- Defined in common/src/OINOBenchmark.ts:119

`Static`trackException

trackException(
    module: string,
    method: string,
    name: string,
    message: string,
    stack: string,
): void
Track an exception. Does not consider enabled modules.
Parameters
- module: string
  of the benchmark
- method: string
  of the benchmark
- name: string
  of the exception
- message: string
  of the exception
- stack: string
  trace of the exception
Returns void
- Defined in common/src/OINOBenchmark.ts:181

`Static`trackMetric

trackMetric(
    module: string,
    method: string,
    value: number,
    success?: boolean,
): void
Track a metric value
Parameters
- module: string
  of the metric
- method: string
  of the metric
- value: number
  of the metric
- success: boolean = true
  indicates if the metric was successful
Returns void
- Defined in common/src/OINOBenchmark.ts:165