Commit 80d7b670 authored by Ben Walker's avatar Ben Walker Committed by Tomasz Zawadzki
Browse files

doc: Document log_set_flag RPC 



Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
Change-Id: I9ab1b6b2b1c3d12ce3ed04172c8e165d989460ef
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4254


Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent cacc1076

doc/jsonrpc.md

+37 −0
Original line number Diff line number Diff line
@@ -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.