pub.chive.admin.getNodeMetrics

chive.pub

Documentation

Get Node.js runtime metrics and process information

main query

Get Node.js runtime metrics and process information

Output

Encodingapplication/json
metrics array Required

Node.js and process metric entries

processInfo ref#processInfo Required

Process runtime information

Errors

AuthenticationRequired
AdminRequired
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "metrics",
        "processInfo"
      ],
      "properties": {
        "metrics": {
          "type": "array",
          "items": {
            "ref": "#nodeMetric",
            "type": "ref"
          },
          "description": "Node.js and process metric entries"
        },
        "processInfo": {
          "ref": "#processInfo",
          "type": "ref",
          "description": "Process runtime information"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {}
  },
  "description": "Get Node.js runtime metrics and process information"
}
nodeMetric object

A Node.js runtime metric

Properties

name string Required

Metric name

type string Required

Metric type

Known values: counter, gauge, histogram
unit string Optional

Unit of measurement (bytes, seconds, percent)

value string Required

Current value (numeric string)

View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "value",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Metric name"
    },
    "type": {
      "type": "string",
      "description": "Metric type",
      "knownValues": [
        "counter",
        "gauge",
        "histogram"
      ]
    },
    "unit": {
      "type": "string",
      "description": "Unit of measurement (bytes, seconds, percent)"
    },
    "value": {
      "type": "string",
      "description": "Current value (numeric string)"
    }
  },
  "description": "A Node.js runtime metric"
}
processInfo object

Node.js process runtime information

Properties

cpuSystem integer Optional

CPU system time in microseconds

cpuUser integer Optional

CPU user time in microseconds

eventLoopLag integer Optional

Event loop lag in microseconds

external integer Optional

External memory in bytes

heapTotal integer Required

V8 heap total in bytes

heapUsed integer Required

V8 heap used in bytes

pid integer Required

Process ID

rss integer Required

Resident set size in bytes

uptime integer Required

Process uptime in seconds

View raw schema 
{
  "type": "object",
  "required": [
    "pid",
    "uptime",
    "heapUsed",
    "heapTotal",
    "rss"
  ],
  "properties": {
    "pid": {
      "type": "integer",
      "description": "Process ID"
    },
    "rss": {
      "type": "integer",
      "description": "Resident set size in bytes"
    },
    "uptime": {
      "type": "integer",
      "description": "Process uptime in seconds"
    },
    "cpuUser": {
      "type": "integer",
      "description": "CPU user time in microseconds"
    },
    "external": {
      "type": "integer",
      "description": "External memory in bytes"
    },
    "heapUsed": {
      "type": "integer",
      "description": "V8 heap used in bytes"
    },
    "cpuSystem": {
      "type": "integer",
      "description": "CPU system time in microseconds"
    },
    "heapTotal": {
      "type": "integer",
      "description": "V8 heap total in bytes"
    },
    "eventLoopLag": {
      "type": "integer",
      "description": "Event loop lag in microseconds"
    }
  },
  "description": "Node.js process runtime information"
}

Lexicon Garden

@