References general file structure (methods)

2025-12-03 18:15:49 +00:00 · 2018-05-03 15:28:40 -07:00
parent c072b2622c
commit 48391ba3d5
99 changed files with 297 additions and 324 deletions
--- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md
+++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/get_counts.md
@@ -0,0 +1,148 @@
+## get_counts
+[[Source]<br>](https://github.com/ripple/rippled/blob/c7118a183a660648aa88a3546a6b2c5bce858440/src/ripple/rpc/handlers/GetCounts.cpp "Source")
+
+The `get_counts` command provides various stats about the health of the server, mostly the number of objects of different types that it currently holds in memory.
+
+_The `get_counts` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._
+
+#### Request Format
+An example of the request format:
+
+<!-- MULTICODE_BLOCK_START -->
+
+*WebSocket*
+
+```
+{
+    "id": 90,
+    "command": "get_counts",
+    "min_count": 100
+}
+```
+
+*JSON-RPC*
+
+```
+{
+    "method": "get_counts",
+    "params": [
+        {
+            "min_count": 100
+        }
+    ]
+}
+```
+
+*Commandline*
+
+```
+#Syntax: get_counts [min_count]
+rippled get_counts 100
+```
+
+<!-- MULTICODE_BLOCK_END -->
+
+The request includes the following parameters:
+
+| `Field`     | Type                      | Description                        |
+|:------------|:--------------------------|:-----------------------------------|
+| `min_count` | Number (Unsigned Integer) | Only return fields with a value at least this high. |
+
+#### Response Format
+
+An example of a successful response:
+
+<!-- MULTICODE_BLOCK_START -->
+
+*JSON-RPC*
+
+```
+{
+   "result" : {
+      "AL_hit_rate" : 48.36725616455078,
+      "HashRouterEntry" : 3048,
+      "Ledger" : 46,
+      "NodeObject" : 10417,
+      "SLE_hit_rate" : 64.62035369873047,
+      "STArray" : 1299,
+      "STLedgerEntry" : 646,
+      "STObject" : 6987,
+      "STTx" : 4104,
+      "STValidation" : 610,
+      "Transaction" : 4069,
+      "dbKBLedger" : 10733,
+      "dbKBTotal" : 39069,
+      "dbKBTransaction" : 26982,
+      "fullbelow_size" : 0,
+      "historical_perminute" : 0,
+      "ledger_hit_rate" : 71.0565185546875,
+      "node_hit_rate" : 3.808214902877808,
+      "node_read_bytes" : 393611911,
+      "node_reads_hit" : 1283098,
+      "node_reads_total" : 679410,
+      "node_writes" : 1744285,
+      "node_written_bytes" : 794368909,
+      "status" : "success",
+      "treenode_cache_size" : 6650,
+      "treenode_track_size" : 598631,
+      "uptime" : "3 hours, 50 minutes, 27 seconds",
+      "write_load" : 0
+   }
+}
+```
+
+*Commandline*
+
+```
+Loading: "/etc/rippled.cfg"
+Connecting to 127.0.0.1:5005
+{
+   "result" : {
+      "AL_hit_rate" : 48.36725616455078,
+      "HashRouterEntry" : 3048,
+      "Ledger" : 46,
+      "NodeObject" : 10417,
+      "SLE_hit_rate" : 64.62035369873047,
+      "STArray" : 1299,
+      "STLedgerEntry" : 646,
+      "STObject" : 6987,
+      "STTx" : 4104,
+      "STValidation" : 610,
+      "Transaction" : 4069,
+      "dbKBLedger" : 10733,
+      "dbKBTotal" : 39069,
+      "dbKBTransaction" : 26982,
+      "fullbelow_size" : 0,
+      "historical_perminute" : 0,
+      "ledger_hit_rate" : 71.0565185546875,
+      "node_hit_rate" : 3.808214902877808,
+      "node_read_bytes" : 393611911,
+      "node_reads_hit" : 1283098,
+      "node_reads_total" : 679410,
+      "node_writes" : 1744285,
+      "node_written_bytes" : 794368909,
+      "status" : "success",
+      "treenode_cache_size" : 6650,
+      "treenode_track_size" : 598631,
+      "uptime" : "3 hours, 50 minutes, 27 seconds",
+      "write_load" : 0
+   }
+}
+```
+
+<!-- MULTICODE_BLOCK_END -->
+
+The response follows the [standard format](#response-formatting). The list of fields contained in the result is subject to change without notice, but it may contain any of the following (among others):
+
+| `Field`       | Type   | Description                                         |
+|:--------------|:-------|:----------------------------------------------------|
+| `Transaction` | Number | The number of `Transaction` objects in memory       |
+| `Ledger`      | Number | The number of ledgers in memory                     |
+| `uptime`      | String | The amount of time this server has been running uninterrupted. |
+
+For most other entries, the value indicates the number of objects of that type currently in memory.
+
+#### Possible Errors
+
+* Any of the [universal error types](#universal-errors).
+* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.