getmemoryinfo

getmemoryinfo ( "mode" ) Returns an object containing information about memory usage. Arguments: 1. mode (string, optional, default="stats") determines what kind of information is returned. - "stats" returns general statistics about memory usage in the daemon. - "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc). Result (mode "stats"): { (json object) "locked" : { (json object) Information about locked memory manager "used" : n, (numeric) Number of bytes used "free" : n, (numeric) Number of bytes available in current arenas "total" : n, (numeric) Total number of bytes managed "locked" : n, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk. "chunks_used" : n, (numeric) Number allocated chunks "chunks_free" : n (numeric) Number unused chunks } } Result (mode "mallocinfo"): "str" (string) "<malloc version="1">..." Examples: > bitcoin-cli getmemoryinfo > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getmemoryinfo", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getmemoryinfo(mode?: string) → any

Code samples

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

bitcoin-cli getmemoryinfo

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getmemoryinfo", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getmemoryinfo",
        "params": ["stats"],
    },
    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: "getmemoryinfo",
    params: ["stats"],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
mode	`string`	—	determines what kind of information is returned. - "stats" returns general statistics about memory usage in the daemon. - "mallocinfo" returns an XML string describing low-level heap state (only available if compiled with glibc).

Result

Type: any

{ (json object) "locked" : { (json object) Information about locked memory manager "used" : n, (numeric) Number of bytes used "free" : n, (numeric) Number of bytes available in current arenas "total" : n, (numeric) Total number of bytes managed "locked" : n, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk. "chunks_used" : n, (numeric) Number allocated chunks "chunks_free" : n (numeric) Number unused chunks } } "str" (string) "<malloc version="1">..."

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

C++ symbol: getmemoryinfo

Code samples

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

bitcoin-cli getmemoryinfo

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getmemoryinfo", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getmemoryinfo",
        "params": ["stats"],
    },
    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: "getmemoryinfo",
    params: ["stats"],
  }),
});
console.log(await res.json());