rpc: Add logpath description for getrpcinfo #16332

pull instagibbs wants to merge 1 commits into bitcoin:master from instagibbs:getrpcinfo_logpath_help changing 1 files +2 −1

instagibbs commented at 1:24 PM on July 3, 2019: member

Introduced in https://github.com/bitcoin/bitcoin/pull/15483
fanquake added the label RPC/REST/ZMQ on Jul 3, 2019
Add logpath description for getrpcinfo a30bd09454

in src/rpc/server.cpp:214 in 5be19f9907 outdated

 209 | @@ -210,7 +210,8 @@ static UniValue getrpcinfo(const JSONRPCRequest& request)
 210 |              "    \"method\"       (string)  The name of the RPC command \n"
 211 |              "    \"duration\"     (numeric)  The running time in microseconds\n"
 212 |              "   },...\n"
 213 | -            "  ]\n"
 214 | +            "  ],\n"
 215 | +            " \"logpath\": xxx    (string) The complete file path to the debug log\n"

laanwj commented at 1:31 PM on July 3, 2019:

convention seems to be

" \"logpath\": \"xxx\"    (string) The complete file path to the debug log\n"

instagibbs force-pushed on Jul 3, 2019
darosior approved

in src/rpc/server.cpp:214 in a30bd09454

 209 | @@ -210,7 +210,8 @@ static UniValue getrpcinfo(const JSONRPCRequest& request)
 210 |              "    \"method\"       (string)  The name of the RPC command \n"
 211 |              "    \"duration\"     (numeric)  The running time in microseconds\n"
 212 |              "   },...\n"
 213 | -            "  ]\n"
 214 | +            "  ],\n"
 215 | +            " \"logpath\": \"xxx\" (string) The complete file path to the debug log\n"

promag commented at 10:37 PM on July 3, 2019:

s/complete/absolute?

fanquake renamed this:
~~Add logpath description for getrpcinfo~~
rpc: Add logpath description for getrpcinfo
on Jul 4, 2019
fanquake approved

fanquake commented at 4:18 AM on July 8, 2019: member

ACK a30bd0945427f310640d8515c11a3d1b70762e69

master (2b465195e09a9cee2e712e5aa80eb95e89ec285c):

$ src/bitcoin-cli help getrpcinfo
getrpcinfo

Returns details of the RPC server.

Result:
{
 "active_commands" (array) All active commands
  [
   {               (object) Information about an active command
    "method"       (string)  The name of the RPC command 
    "duration"     (numeric)  The running time in microseconds
   },...
  ]
}

Examples:
> bitcoin-cli getrpcinfo 
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrpcinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/

This PR (a30bd0945427f310640d8515c11a3d1b70762e69):

src/bitcoin-cli help getrpcinfo
getrpcinfo

Returns details of the RPC server.

Result:
{
 "active_commands" (array) All active commands
  [
   {               (object) Information about an active command
    "method"       (string)  The name of the RPC command 
    "duration"     (numeric)  The running time in microseconds
   },...
  ],
 "logpath": "xxx" (string) The complete file path to the debug log
}

Examples:
> bitcoin-cli getrpcinfo 
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrpcinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/

laanwj merged this on Jul 8, 2019
laanwj closed this on Jul 8, 2019
laanwj referenced this in commit f5a01cf259 on Jul 8, 2019
sidhujag referenced this in commit 5e1b1762d0 on Jul 9, 2019
jasonbcox referenced this in commit 742b6b2065 on Oct 8, 2020
MarcoFalke locked this on Dec 16, 2021

Contributors

Labels

Linked (view graph)

#15483 rpc: Adding a 'logpath' entry to getrpcinfo