log.setLevel: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=log.setLevel |trusted=true |version=1.5.2 |description= Set the logging level for the specified logger. <br>The log file will be found in your user dire...")
 
No edit summary
(4 intermediate revisions by one other user not shown)
Line 13: Line 13:
'''Parameters'''
'''Parameters'''
{{param|logger|String containing a logger name.}}
{{param|logger|String containing a logger name.}}
{{param|loglevel|String containing a log level: DEBUG,ERROR,FATAL,INFO,WARN}}
{{param|loglevel|String containing a log level: DEBUG,INFO,WARN,ERROR,FATAL}}
 
The default level for all loggers is INFO, which means that messages at INFO, WARN, ERROR and FATAL log level will be output.  The levels noted above are in verbosity order from most(DEBUG) to least(FATAL).


|example=
|example=
Line 20: Line 22:
[r: log.setLevel("net.rptools.maptool.client.MapToolLineParser","WARN")]
[r: log.setLevel("net.rptools.maptool.client.MapToolLineParser","WARN")]
</source>
</source>
Returns:
'''Returns:'''
<source lang="mtmacro" line>
<source lang="mtmacro" line>
WARN
WARN
</source>
</source>
Get a list of loggers and then, using {{func|input}}, select a logging level for it.
<source lang="mtmacro" line>
[h: loggers = json.sort(log.getLoggers(),"a","name")]
[h: loggerList = ""]
[h, FOREACH(logger, loggers), CODE: {
    [h: loggerList = listAppend(loggerList,json.get(logger,"name"))]
}]
[h:status=input(
    "junkVar|Select a Logger and Level||LABEL|SPAN=TRUE",
    "lname|"+loggerList+"|Logger|LIST|VALUE=STRING",
    "level|DEBUG,INFO,WARN,ERROR,FATAL|Level|LIST|VALUE=STRING")]
[h:abort(status)]
[r: "Setting <i><b>" + lname + "</b></i> to <b>" + level + "</b>."]
[h: log.setLevel(lname,level)]
</source>
<br/>
[[File:SelectLoggerLevel.png]]


|also=
|also=
[[log.getLoggers|log.getLoggers]]
{{func|log.getLoggers}}  &nbsp;[[Available Loggers]]
 
}}
}}
[[Category:Log Function]]
[[Category:Log Function]]

Revision as of 08:12, 6 August 2022

log.setLevel() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.2
Set the logging level for the specified logger.
The log file will be found in your user directory under .maptool-rptools/logs.

Usage

log.setLevel(logger, loglevel)

Parameters

  • logger - String containing a logger name.
  • loglevel - String containing a log level: DEBUG,INFO,WARN,ERROR,FATAL

The default level for all loggers is INFO, which means that messages at INFO, WARN, ERROR and FATAL log level will be output. The levels noted above are in verbosity order from most(DEBUG) to least(FATAL).

Example

Set the logging level for the MapToolLineParser to WARN.
[r: log.setLevel("net.rptools.maptool.client.MapToolLineParser","WARN")]

Returns:

WARN

Get a list of loggers and then, using input(), select a logging level for it.

[h: loggers = json.sort(log.getLoggers(),"a","name")]
[h: loggerList = ""]
[h, FOREACH(logger, loggers), CODE: {
    [h: loggerList = listAppend(loggerList,json.get(logger,"name"))]
}]
[h:status=input(
    "junkVar|Select a Logger and Level||LABEL|SPAN=TRUE",
    "lname|"+loggerList+"|Logger|LIST|VALUE=STRING",
    "level|DEBUG,INFO,WARN,ERROR,FATAL|Level|LIST|VALUE=STRING")]
[h:abort(status)]
[r: "Setting <i><b>" + lname + "</b></i> to <b>" + level + "</b>."]
[h: log.setLevel(lname,level)]


See Also