Class Metrics

class: Metrics holds all the accessible parts of influx-metrics API

Hierarchy

Metrics

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Metrics(db: string, options: IMetricsOption): Metrics

- Defined in metrics.ts:33
Parameters
- db: string
- options: IMetricsOption
Returns Metrics

Properties

Private book

book: IBook

Private client

client: InfluxDB

Private db

db: string = ""

Private defaultOptions

defaultOptions: IMetricsOption

Methods

Private ensureOptions

ensureOptions(): void

- Defined in metrics.ts:58
function

ensureOptions

ensures all the options inside IMetricOption are set to default values

Returns void

express

express(req: Request, res: Response, next: NextFunction): void

- Defined in metrics.ts:47
Parameters
- req: Request
- res: Response
- next: NextFunction
Returns void

Private initDb

initDb(onConnected?: undefined | function): void

- Defined in metrics.ts:88
method

Initialize this.influx and post callback to onConnected

Parameters
- Optional onConnected: undefined | function
  
  callback for when influx db connection is initialized
Returns void

log

log(message: string, severity: Severity): void

- Defined in metrics.ts:103
Parameters
- message: string
- severity: Severity
Returns void

record

record(measurement: string, point: IPoint): Promise<void>

- Defined in metrics.ts:113
records the point that forces it to keep it as a noddpoint interface

Parameters
- measurement: string
  
  name of the measurement
- point: IPoint
  
  point that
Returns Promise<void>

recordInterval

recordInterval(measurement: string, func: function, interval: number): void

- Defined in metrics.ts:122
Parameters
- measurement: string
- func: function
  - - (): IPoint
    - Returns IPoint
- interval: number
Returns void

stopRecording

stopRecording(measurement: string): void

- Defined in metrics.ts:135
Parameters
- measurement: string
Returns void

Generated using TypeDoc