peer logging¶
The peer logging
subcommand allows administrators to dynamically view and
configure the log levels of a peer.
Syntax¶
The peer logging
command has the following subcommands:
- getlogspec
- setlogspec
and the following deprecated subcommands, which will be removed in a future release:
- getlevel
- setlevel
- revertlevels
The different subcommand options (getlogspec
, setlogspec
, getlevel
, setlevel
,
and revertlevels
) relate to the different logging operations that are relevant
to a peer.
Each peer logging subcommand is described together with its options in its own section in this topic.
peer logging¶
Logging configuration: getlevel|setlevel|getlogspec|setlogspec|revertlevels.
Usage:
peer logging [command]
Available Commands:
getlevel Returns the logging level of the requested logger.
getlogspec Returns the active log spec.
revertlevels Reverts the logging spec to the peer's spec at startup.
setlevel Adds the logger and log level to the current logging spec.
setlogspec Sets the logging spec.
Flags:
-h, --help help for logging
Use "peer logging [command] --help" for more information about a command.
peer logging getlevel¶
Returns the logging level of the requested logger. Note: the logger name should exactly match the name that is displayed in the logs.
Usage:
peer logging getlevel <logger> [flags]
Flags:
-h, --help help for getlevel
peer logging revertlevels¶
Reverts the logging spec to the peer's spec at startup.
Usage:
peer logging revertlevels [flags]
Flags:
-h, --help help for revertlevels
peer logging setlevel¶
Adds the logger and log level to the current logging specification.
Usage:
peer logging setlevel <logger> <log level> [flags]
Flags:
-h, --help help for setlevel
Example Usage¶
Get Level Usage¶
Here is an example of the peer logging getlevel
command:
To get the log level for logger
peer
:peer logging getlevel peer 2018-11-01 14:18:11.276 UTC [cli.logging] getLevel -> INFO 001 Current log level for logger 'peer': INFO
Get Log Spec Usage¶
Here is an example of the peer logging getlogspec
command:
To get the active logging spec for the peer:
peer logging getlogspec 2018-11-01 14:21:03.591 UTC [cli.logging] getLogSpec -> INFO 001 Current logging spec: info
Set Level Usage¶
Here are some examples of the peer logging setlevel
command:
To set the log level for loggers matching logger name prefix
gossip
to log levelWARNING
:peer logging setlevel gossip warning 2018-11-01 14:21:55.509 UTC [cli.logging] setLevel -> INFO 001 Log level set for logger name/prefix 'gossip': WARNING
To set the log level to
ERROR
for only the logger that exactly matches the supplied name, append a period to the logger name:peer logging setlevel gossip. error 2018-11-01 14:27:33.080 UTC [cli.logging] setLevel -> INFO 001 Log level set for logger name/prefix 'gossip.': ERROR
Set Log Spec Usage¶
Here is an example of the peer logging setlogspec
command:
To set the active logging spec for the peer where loggers that begin with
gossip
andmsp
are set to log levelWARNING
and the default for all other loggers is log levelINFO
:peer logging setlogspec gossip=warning:msp=warning:info 2018-11-01 14:32:12.871 UTC [cli.logging] setLogSpec -> INFO 001 Current logging spec set to: gossip=warning:msp=warning:info
Note: there is only one active logging spec. Any previous spec, including modules updated via ‘setlevel’, will no longer be applicable.
Revert Levels Usage¶
Here is an example of the peer logging revertlevels
command:
To revert the logging spec to the start-up value:
peer logging revertlevels 2018-11-01 14:37:12.402 UTC [cli.logging] revertLevels -> INFO 001 Logging spec reverted to the peer's spec at startup.
This work is licensed under a Creative Commons Attribution 4.0 International License.