Custom Metrics

You can define at configuration time your own metrics that can be updated using Lua.

The first step is to declare a new metric using declareMetric().

Then you can update those at runtime using the following functions, depending on the metric type:

declareMetric(name, type, description) → bool

New in version 1.8.0.

Return true if declaration was successful

Parameters:
  • name (str) – The name of the metric, lowercase alphanumerical characters and dashes (-) only
  • type (str) – The desired type in gauge or counter
  • name – The description of the metric
incMetric(name) → int

New in version 1.8.0.

Increment counter by one, will issue an error if the metric is not declared or not a counter Return the new value

Parameters:name (str) – The name of the metric
decMetric(name) → int

New in version 1.8.0.

Decrement counter by one, will issue an error if the metric is not declared or not a counter Return the new value

Parameters:name (str) – The name of the metric
getMetric(name) → double

New in version 1.8.0.

Get metric value

Parameters:name (str) – The name of the metric
setMetric(name, value) → double

New in version 1.8.0.

Set the new value, will issue an error if the metric is not declared or not a gauge Return the new value

Parameters:name (str) – The name of the metric