On this page

latest contributor to this doc

Last Edit:

@gcharang

metrics

The metrics method returns a snapshot of the current Komodo DeFi Framework API metrics used in Prometheus and Grafana. For more information check out the Komodo DeFi Framework metrics guide

The metrics method does not take any additional parameters, and does not require authentication with your rpc_password.

ParameterTypeDescription
metricslist of objectsThere are a variety of metrics returned, with each metrics object havine a type, key, label, and some values which vary by type.

ParameterTypeDescription
typestringA metric type which indicates how it should be displayed in visualisation.
keystringA descriptive name assigned to the metric.
labelsobjectLabels can be used to group similar metrics together or provide additional context.
valuefloatReturned if type is gauge. A numeric value which indicates the magnitude of the metric being measured.
countfloatReturned if type is histogram. How many values were measured.
minfloatReturned if type is histogram. The smallest value measured.
maxfloatReturned if type is histogram. The highest value measured.

POST
metrics
{
  "method": "metrics",
  "userpass": "RPC_UserP@SSW0RD"
}