This page uses machine translation from English, which may contain errors or unclear language. For the most accurate information, please see the original English version. Some content may be in the original English due to frequent updates. Help us improve this page's translation by joining our effort on Crowdin. (Crowdin translation page, Contributing guide)

[runtimeDebug] debug_metrics

Retrieves all the known system metrics collected by the node.

JSONRPC: debug_metrics

Request

application/json

Body

params Raw (boolean)[]required

true If raw data is output as it is, false If not

Responses

200

The structured metrics collected by the node.

application/json

Schema

Schema

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

code	message	description
-32700	Parse error	invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.
-32602	Invalid params	Invalid method parameter(s).

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result object

The structured metrics collected by the node.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": {
    "blockchain": {
      "block": {
        "tx": {
          "counter": {
            "Overall": 98307
          },
          "rate": {
            "AvgRate01Min": 19.99999999999893,
            "AvgRate05Min": 19.999669059400787,
            "AvgRate15Min": 19.91097896398045,
            "MeanRate": 16.321034565305364,
            "Overall": 98307
          }
        }
      },
      "head": {
        "blocknumber": "Unknown metric type"
      }
    },
    "bridgeTxpool": {
      "refuse": {
        "Overall": 0
      }
    },
    "...": null,
    "inserts": {
      "AvgRate01Min": 0.9999999999999988,
      "AvgRate05Min": 0.9999997215208508,
      "AvgRate15Min": 0.9986124269288207,
      "MeanRate": 0.9946322927570416,
      "Overall": 5991,
      "Percentiles": {
        "5": 5986862.3,
        "20": 6229668,
        "50": 6585653,
        "80": 6864326.2,
        "95": 7486187.249999999
      }
    }
  }
}

• curl
• python
• nodejs
• java

• Curl

curl -X 'POST' \
  'https://public-en-kairos.node.kaia.io' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "method": "debug_metrics",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [true]
}'

• CURL

curl -L 'https://public-en-kairos.node.kaia.io/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "method": "debug_metrics",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    true
  ]
}'

Request Collapse all

Base URL

https://public-en-kairos.node.kaia.io

Body

{
  "method": "debug_metrics",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    true
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!