Skip to content

PAN-3131: Add documentation about new admin_changeLogLevel functionality #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bgravenorst merged 5 commits into from
Oct 3, 2019
Merged

PAN-3131: Add documentation about new admin_changeLogLevel functionality #7

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ea8705c
PAN-3131: Add documentation about new admin_changeLogLevel functional…
bgravenorst Sep 18, 2019
ab425f3
Add reviewer comments.
bgravenorst Oct 2, 2019
c61fc46
Merge branch 'master' into PAN-3131
bgravenorst Oct 2, 2019
4712545
Merge branch 'master' into PAN-3131
bgravenorst Oct 3, 2019
001c58e
Merge branch 'master' into PAN-3131
bgravenorst Oct 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions docs/Reference/API-Methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,23 +51,29 @@ Adds a [static node](../HowTo/Find-and-Connect/Managing-Peers.md#static-nodes).

### admin_changeLogLevel

Change the log level without restarting Besu.
Changes the log level without restarting Besu. You can change the log level for all logs, or you can change the log level for specific packages or classes.

Only one log level can be specified per RPC call.

**Parameters**

`level` - [Log level](CLI/CLI-Syntax.md#logging)

`log_filter`: `Array` - Packages or classes to change the log level for. Optional.

**Returns**

`result` : `Success` if the log level has changed; otherwise `error`.

This example changes the debug level for specified classes to `DEBUG`.

!!! example
```bash tab="curl HTTP request"
curl -X POST --data '{"jsonrpc":"2.0","method":"admin_changeLogLevel","params":["DEBUG"], "id":1}' http://127.0.0.1:8545
curl -X POST --data '{"jsonrpc":"2.0", "method":"admin_changeLogLevel", "params":["DEBUG", ["tech.pegasys.pantheon.ethereum.eth.manager","tech.pegasys.pantheon.ethereum.p2p.rlpx.connections.netty.ApiHandler"]], "id":1}' http://127.0.0.1:8545
Comment thread
bgravenorst marked this conversation as resolved.
```

```bash tab="wscat WS request"
{"jsonrpc":"2.0","method":"admin_changeLogLevel","params":["DEBUG"], "id":1}
{"jsonrpc":"2.0", "method":"admin_changeLogLevel", "params":["DEBUG", ["tech.pegasys.pantheon.ethereum.eth.manager","tech.pegasys.pantheon.ethereum.p2p.rlpx.connections.netty.ApiHandler"]], "id":1}
```

```json tab="JSON result"
Expand All @@ -77,7 +83,25 @@ Change the log level without restarting Besu.
"result": "Success"
}
```
This example changes the debug level of all logs to `WARN`.

!!! example
```bash tab="curl HTTP request"
curl -X POST --data '{"jsonrpc":"2.0","method":"admin_changeLogLevel","params":["WARN"], "id":1}' http://127.0.0.1:8545
```

```bash tab="wscat WS request"
{"jsonrpc":"2.0","method":"admin_changeLogLevel","params":["WARN"], "id":1}
```

```json tab="JSON result"
{
"jsonrpc": "2.0",
"id": 1,
"result": "Success"
}
```

### admin_nodeInfo

Returns networking information about the node. The information includes general information about the node
Expand Down