README
pm2-prtg
The package expects 2 parameters:
- id or name of pm2 process (will be evalueated on type of argument (number - id, string - name))
- Optional configuration object. It can be provided with:
counters
(array of{name: string, group: string, unit: string}
)fields
(array of{name: string, value: any, group: string, unit: string}
)histogrms
(array of{name: string, group: string, unit: string}
)
returns promise
Availible methods
startTimer
- starts timer for providedname
(string)getTimerValue
- returns timer falue for providedname
(string)addHistogram
- adds new histogram. params:name
(string)group
(string - optional) andunit
(string - optional)getHistogram
- returns histogram value by providedname
(string)updateHistogram
- updates histogram for providedname
(string) with providedvalue
(number)setField
- sets new filed or updates existing one - provedname
(string)val
(any)group
(string) andunit
(string)getField
- get field by providedname
(string)group
(string - optional)incrementCounter
- increment existing counder byname
(string)getCounterValue
- get counder value byname
(string)addCounter
- add new counter with providedname
(string) andgroup
(string - optional)listAllCounters
- list all counters with their values |group
- optional filter (string)listAllFields
- list all fields with their values |group
- optional filter (string)listAllHistograms
- list all histograms with their values |group
- optional filter (string)getSanitizedData
update
- updates current pm2 data with relevant and newes data. Is asynchronousgetPrtgObject
- returns data prepared for ptrg |group
- optional filter (string)
Defaults
The package has 2 default counters: successCounter
and errorCounter
Other
When you import package you have access to jsdoc types like PM2_PRTG_HANDLER
and Config
You can also import them separately by require('pm2-prtg/types')