/build/rpc / cosign / session

cosign.metrics

cosign.metrics Get cosign bridge metrics (active sessions, message counts, health). Result: { (json object) "active_sessions" : n, (numeric) Number of active sessions "total_messages" : n, (numeric) Total messages sent/received "bridge_restarts" : n, (numeric) Bridge restart count (top-level for backward compatibility) "bridge_health" : { (json object) Bridge health monitoring "health_state" : "str", (string) Health state: unknown|healthy|recoverable|failed|dead "restart_count" : n, (numeric) Bridge restart attempts "max_restarts" : n, (numeric) Maximum allowed restarts "consecutive_failures" : n, (numeric) Consecutive heartbeat failures "last_successful_ping" : n, (numeric) Unix timestamp of last successful ping "seconds_since_last_ping" : n (numeric) Seconds since last ping (-1 if never) }, "transport_failures" : { (json object) Failures by transport "ws" : n, (numeric) WebSocket failures "nostr" : n (numeric) Nostr failures }, "avg_latency_ms" : n, (numeric) Average message latency "p95_latency_ms" : n, (numeric) P95 latency "p99_latency_ms" : n (numeric) P99 latency } Examples: > bitcoin-cli cosign.metrics

Signature

cosign.metrics() → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"cosign.metrics","params":[]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli cosign.metrics

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "cosign.metrics",
        "params": [],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "cosign.metrics",
    params: [],
  }),
});
console.log(await res.json());

Parameters

No parameters.

Result

Type: any

{ (json object) "active_sessions" : n, (numeric) Number of active sessions "total_messages" : n, (numeric) Total messages sent/received "bridge_restarts" : n, (numeric) Bridge restart count (top-level for backward compatibility) "bridge_health" : { (json object) Bridge health monitoring "health_state" : "str", (string) Health state: unknown|healthy|recoverable|failed|dead "restart_count" : n, (numeric) Bridge restart attempts "max_restarts" : n, (numeric) Maximum allowed restarts "consecutive_failures" : n, (numeric) Consecutive heartbeat failures "last_successful_ping" : n, (numeric) Unix timestamp of last successful ping "seconds_since_last_ping" : n (numeric) Seconds since last ping (-1 if never) }, "transport_failures" : { (json object) Failures by transport "ws" : n, (numeric) WebSocket failures "nostr" : n (numeric) Nostr failures }, "avg_latency_ms" : n, (numeric) Average message latency "p95_latency_ms" : n, (numeric) P95 latency "p99_latency_ms" : n (numeric) P99 latency }

Source: services/core-node/bcore/src/rpc/cosign.cpp:1331

C++ symbol: cosign_metrics

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"cosign.metrics","params":[]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli cosign.metrics

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "cosign.metrics",
        "params": [],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "cosign.metrics",
    params: [],
  }),
});
console.log(await res.json());