rippled APIs: reorg methods to separate files

2025-11-27 23:25:51 +00:00 · 2018-01-22 16:26:45 -08:00
parent 084f4a833f
commit 45e0f2f70f
54 changed files with 11357 additions and 11381 deletions
--- a/content/rippled-api-methods/log_level.md
+++ b/content/rippled-api-methods/log_level.md
@@ -0,0 +1,135 @@
+## log_level
+[[Source]<br>](https://github.com/ripple/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source")
+
+The `log_level` command changes the `rippled` server's logging verbosity, or returns the current logging level for each category (called a _partition_) of log messages.
+
+_The `log_level` 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": "ll1",
+    "command": "log_level",
+    "severity": "debug",
+    "partition": "PathRequest"
+}
+```
+
+*Commandline*
+
+```
+#Syntax: log_level [[partition] severity]
+rippled log_level PathRequest debug
+```
+
+<!-- MULTICODE_BLOCK_END -->
+
+The request includes the following parameters:
+
+| `Field`     | Type   | Description                                           |
+|:------------|:-------|:------------------------------------------------------|
+| `severity`  | String | _(Optional)_ What level of verbosity to set logging at. Valid values are, in order from least to most verbose: `fatal`, `error`, `warn`, `info`, `debug`, and `trace`. If omitted, return current log verbosity for all categories. |
+| `partition` | String | _(Optional)_ Ignored unless `severity` is provided. Which logging category to modify. If omitted, or if provided with the value `base`, set logging level for all categories. |
+
+#### Response Format
+
+Examples of successful responses:
+
+<!-- MULTICODE_BLOCK_START -->
+
+*Commandline (set log level)*
+
+```
+Loading: "/etc/rippled.cfg"
+Connecting to 127.0.0.1:5005
+{
+   "result" : {
+      "status" : "success"
+   }
+}
+```
+
+*Commandline (check log levels)*
+
+```
+Loading: "/etc/rippled.cfg"
+Connecting to 127.0.0.1:5005
+{
+   "result" : {
+      "levels" : {
+         "AmendmentTable" : "Error",
+         "Application" : "Error",
+         "CancelOffer" : "Error",
+         "Collector" : "Error",
+         "CreateOffer" : "Error",
+         "DeferredCredits" : "Error",
+         "FeeVote" : "Error",
+         "InboundLedger" : "Error",
+         "JobQueue" : "Error",
+         "Ledger" : "Error",
+         "LedgerCleaner" : "Error",
+         "LedgerConsensus" : "Error",
+         "LedgerEntrySet" : "Error",
+         "LedgerMaster" : "Error",
+         "LedgerTiming" : "Error",
+         "LoadManager" : "Error",
+         "LoadMonitor" : "Error",
+         "NetworkOPs" : "Error",
+         "NodeObject" : "Error",
+         "OrderBookDB" : "Error",
+         "Overlay" : "Error",
+         "PathRequest" : "Debug",
+         "Payment" : "Error",
+         "Peer" : "Error",
+         "PeerFinder" : "Error",
+         "Protocol" : "Error",
+         "RPC" : "Error",
+         "RPCErr" : "Error",
+         "RPCHandler" : "Error",
+         "RPCManager" : "Error",
+         "Resolver" : "Error",
+         "Resource" : "Error",
+         "RippleCalc" : "Error",
+         "SHAMap" : "Error",
+         "SHAMapStore" : "Error",
+         "SNTPClient" : "Error",
+         "STAmount" : "Error",
+         "SerializedLedger" : "Error",
+         "Server" : "Error",
+         "SetAccount" : "Error",
+         "SetTrust" : "Error",
+         "TaggedCache" : "Error",
+         "TransactionAcquire" : "Error",
+         "TransactionEngine" : "Error",
+         "UVL" : "Error",
+         "UniqueNodeList" : "Error",
+         "Validations" : "Error",
+         "WALCheckpointer" : "Error",
+         "WebSocket" : "Trace",
+         "base" : "Error"
+      },
+      "status" : "success"
+   }
+}
+```
+
+<!-- MULTICODE_BLOCK_END -->
+
+The response follows the [standard format](#response-formatting). The response format depends on whether the request specified a `severity`. If it did, the log level is changed and a successful result contains no additional fields.
+
+Otherwise, the request contains the following field:
+
+| `Field` | Type   | Description                                               |
+|:--------|:-------|:----------------------------------------------------------|
+| `level` | Object | The current log levels of each category. This list of categories is subject to change without notice in future releases. You can use the field names as values to `partition` in requests to this command. |
+
+#### 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.