From 80d7b670b4732e3305bb13c8517743763cf7b5c7 Mon Sep 17 00:00:00 2001 From: Ben Walker Date: Tue, 15 Sep 2020 10:26:32 -0700 Subject: [PATCH] doc: Document log_set_flag RPC Signed-off-by: Ben Walker Change-Id: I9ab1b6b2b1c3d12ce3ed04172c8e165d989460ef Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4254 Reviewed-by: Tomasz Zawadzki Reviewed-by: Jim Harris Tested-by: SPDK CI Jenkins --- doc/jsonrpc.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 2f80310c3..4090e23e9 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -832,6 +832,43 @@ Example response: } ~~~ +## log_set_flag {#rpc_log_set_flag} + +Enable logging for specific portions of the application. The list of possible +log flags can be obtained using the `log_get_flags` RPC and may be different +for each application. + +### Parameters + +Name | Optional | Type | Description +----------------------- | -------- | ----------- | ----------- +flag | Required | string | A log flag, or 'all' + +### Example + +Example request: + +~~~ +{ + "jsonrpc": "2.0", + "method": "log_set_flag", + "id": 1, + "params": { + "flag": "all" + } +} +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + ## log_enable_timestamps {#rpc_log_enable_timestamps} Enable or disable timestamps.