diff options
| -rw-r--r-- | doc/hook/logger.bb | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/hook/logger.bb b/doc/hook/logger.bb new file mode 100644 index 000000000..8fe989abd --- /dev/null +++ b/doc/hook/logger.bb @@ -0,0 +1,16 @@ +[h2]logger[/h2] + +Called when making an entry to the application logfile + +Hook data: + + array( + 'filename' => name of logfile relative to application basedir. String. + 'loglevel' => the log level of this log entry, if this is higher than the configured maximum loglevel + this hook will not be called. Integer. + 'message' => The formatted log message, ready for logging. String. + 'logged' => boolean, default is false. Set to true to prevent the normal logfile entry to be made + (e.g. if the plugin is configured to handle this aspect of the function, or if it is determined + that this log entry should not be made) + ) + |