JSDoc: Module: fathom/baseline

fathom.baseline.* namespace.

Source:

api.js, line 1645

Methods

(static) get(range, what)

Get historical baseline measurements data. Returns approximately the last 'range' of values (if available). To fetch a single metric, you can use the helper methods.

Parameters:

Name	Type	Description
`range`	string	One of 'latest', day' (default), 'week', 'month', 'year'.
`what`	Array	List of metrics. Valid metrics are 'cpu', 'load', 'tasks', 'mem', 'traffic', 'wifi' and 'rtt'. Undefined defaults to all metrics.

Source:

api.js, line 1658

(static) getCPU(range)

Get historical CPU usage data from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1670

(static) getEnv(range)

Get historical network locations from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1751

(static) getLoad(range)

Get historical CPU load data from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1681

(static) getMem(range)

Get historical memory usage data from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1703

(static) getRTT(range)

Get historical network delay performance data from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1739

(static) getTasks(range)

Get historical CPU tasks data from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1692

(static) getTraffic(range)

Get historical network usage data from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1715

(static) getWifi(range)

Get historical wifi performance data from the baseline measurements. Returns approximately the last 'range' of values (if available).

Parameters:

Name	Type	Description
`range`	string	One of 'latest', 'day' (default), 'week', 'month', 'year'.

Source:

api.js, line 1727