From 7df9566cfecf6ed418ea85c2aa2f886dfb6f12af Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 9 Jul 2024 16:30:33 +0000 Subject: [PATCH] Update docs --- README.md | 88 +++++++++++++++++++++++++++---------------------------- 1 file changed, 44 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 0b106b5..fc09743 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ Also, [`setup`][74de] allows to change log levels for different loggers: -### [function](400d) `log4cl-extras/config:setup` config +### [function](9fb5) `log4cl-extras/config:setup` config Setup loggers and appenders via confg. @@ -146,11 +146,11 @@ inside a package and other items are params for a nested [`setup`][74de] call. -### [class](69ea) `log4cl-extras/plain:plain-layout` (layout) +### [class](6ffc) `log4cl-extras/plain:plain-layout` (layout) -### [class](639c) `log4cl-extras/json:json-layout` (layout) +### [class](40ee) `log4cl-extras/json:json-layout` (layout) @@ -189,7 +189,7 @@ CL-USER> (log4cl-extras/context:with-fields (:request-id 42) -### [macro](2deb) `log4cl-extras/context:with-fields` (&rest fields) &body body +### [macro](e967) `log4cl-extras/context:with-fields` (&rest fields) &body body Captures content of given fields into a dynamic variable. @@ -198,7 +198,7 @@ inside the [`with-fields`][b464] body. -### [function](33f7) `log4cl-extras/context:get-fields` +### [function](d9a0) `log4cl-extras/context:get-fields` Returns an alist of all fields defined using [`with-fields`][b464] macro in the current stack. @@ -302,19 +302,19 @@ how to not log secret values. -### [variable](25f3) `log4cl-extras/error:*max-traceback-depth*` 10 +### [variable](a7d4) `log4cl-extras/error:*max-traceback-depth*` 10 Keeps default value for traceback depth logged by [`with-log-unhandled`][3fd6] macro -### [variable](5e9b) `log4cl-extras/error:*max-call-length*` 100 +### [variable](d421) `log4cl-extras/error:*max-call-length*` 100 The max length of each line in a traceback. It is useful to limit it because otherwise some log collectors can discard the whole log entry. -### [variable](2271) `log4cl-extras/error:*args-filters*` nil +### [variable](f9f4) `log4cl-extras/error:*args-filters*` nil Add to this variable functions of two arguments to change arguments before they will be dumped as part of the backtrace to the log. @@ -324,7 +324,7 @@ from multiple threads. -### [variable](71d9) `log4cl-extras/error:*args-filter-constructors*` nil +### [variable](798e) `log4cl-extras/error:*args-filter-constructors*` nil Add to this variable functions of zero arguments. Each function should return an argument filter function suitable for using in the [`*args-filters*`][c7a0] variable. @@ -338,7 +338,7 @@ In this case it will create a new secret replacer for every backtrace to be proc -### [macro](bb61) `log4cl-extras/error:with-log-unhandled` (&key (depth \*max-traceback-depth\*) (errors-to-ignore nil)) &body body +### [macro](8372) `log4cl-extras/error:with-log-unhandled` (&key (depth \*max-traceback-depth\*) (errors-to-ignore nil)) &body body Logs any `ERROR` condition signaled from the body. Logged message will have a "traceback" field. @@ -347,7 +347,7 @@ Errors matching (typep err ) will not be logged as "Un -### [function](3319) `log4cl-extras/error:print-backtrace` &key (stream \*debug-io\*) (condition nil) (depth \*max-traceback-depth\*) (max-call-length \*max-call-length\*) (args-filters (get-current-args-filters)) (format-condition #'format-condition-object) +### [function](f8c5) `log4cl-extras/error:print-backtrace` &key (stream \*debug-io\*) (condition nil) (depth \*max-traceback-depth\*) (max-call-length \*max-call-length\*) (args-filters (get-current-args-filters)) (format-condition #'format-condition-object) A helper to print backtrace. Could be useful to out backtrace at places other than logs, for example at a web page. @@ -364,7 +364,7 @@ function of two arguments: `(stream condition)`. -### [function](3bf6) `log4cl-extras/error:make-args-filter` predicate placeholder +### [function](aeb2) `log4cl-extras/error:make-args-filter` predicate placeholder Returns a function, suitable to be used in [`*args-filters*`][c7a0] variable. @@ -373,7 +373,7 @@ and if it returns T, then argument will be replaced with `PLACEHOLDER`. -### [class](b26c) `log4cl-extras/error:placeholder` () +### [class](5de0) `log4cl-extras/error:placeholder` () Objects of this class can be used as replacement to arguments in a backtrace. @@ -385,7 +385,7 @@ Placeholders should be created with [`make-placeholder`][de65] function. -### [function](59f5) `log4cl-extras/error:make-placeholder` name +### [function](819b) `log4cl-extras/error:make-placeholder` name Creates a placeholder for some secret value or omitted argument. @@ -399,11 +399,11 @@ placeholders to remove sensitive information from logs. -### [function](774f) `log4cl-extras/error:placeholder-p` obj +### [function](cab1) `log4cl-extras/error:placeholder-p` obj -### [reader](c873) `log4cl-extras/error:placeholder-name` (placeholder) (:name) +### [reader](b975) `log4cl-extras/error:placeholder-name` (placeholder) (:name) @@ -707,7 +707,7 @@ CL-USER> (setf log4cl-extras/error:*args-filters* ``` -### [function](a03b) `log4cl-extras/secrets:make-secrets-replacer` +### [function](7278) `log4cl-extras/secrets:make-secrets-replacer` Returns a function which can be used to filter backtrace arguments. @@ -734,23 +734,23 @@ To debug logging errors interactively, you can set [`*debug-on-error*`][8400] va -### [class](ca59) `log4cl-extras/appenders:stable-daily-file-appender` (dont-disable-mixin daily-file-appender) +### [class](3144) `log4cl-extras/appenders:stable-daily-file-appender` (dont-disable-mixin daily-file-appender) -### [class](bd6a) `log4cl-extras/appenders:stable-file-appender` (dont-disable-mixin file-appender) +### [class](d911) `log4cl-extras/appenders:stable-file-appender` (dont-disable-mixin file-appender) -### [class](0306) `log4cl-extras/appenders:stable-this-console-appender` (dont-disable-mixin this-console-appender) +### [class](0820) `log4cl-extras/appenders:stable-this-console-appender` (dont-disable-mixin this-console-appender) -### [class](1688) `log4cl-extras/appenders:dont-disable-mixin` () +### [class](a051) `log4cl-extras/appenders:dont-disable-mixin` () -### [variable](d395) `log4cl-extras/appenders:*debug-on-error*` nil +### [variable](9fea) `log4cl-extras/appenders:*debug-on-error*` nil When T, then `INVOKE-DEBUGGER` will be called in case of any error during logging the message. @@ -773,28 +773,28 @@ When T, then `INVOKE-DEBUGGER` will be called in case of any error during loggin [bb11]: https://40ants.com/log4cl-extras/#x-28LOG4CL-EXTRAS-2FSECRETS-3AMAKE-SECRETS-REPLACER-20FUNCTION-29 [8f00]: https://github.com/40ants/log4cl-extras [b509]: https://github.com/40ants/log4cl-extras/actions -[d395]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/appenders.lisp#L17 -[1688]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/appenders.lisp#L21 -[0306]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/appenders.lisp#L25 -[ca59]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/appenders.lisp#L29 -[bd6a]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/appenders.lisp#L33 -[400d]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/config.lisp#L211 -[33f7]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/context.lisp#L62 -[2deb]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/context.lisp#L78 -[25f3]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L152 -[5e9b]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L155 -[2271]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L158 -[71d9]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L166 -[3319]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L289 -[bb61]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L368 -[b26c]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L386 -[c873]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L387 -[59f5]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L405 -[774f]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L420 -[3bf6]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/error.lisp#L424 -[639c]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/json.lisp#L54 -[69ea]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/plain.lisp#L77 -[a03b]: https://github.com/40ants/log4cl-extras/blob/02c542e455e729f64c8902f47a110b16ece6d7f6/src/secrets.lisp#L357 +[9fea]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/appenders.lisp#L17 +[a051]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/appenders.lisp#L21 +[0820]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/appenders.lisp#L25 +[3144]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/appenders.lisp#L29 +[d911]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/appenders.lisp#L33 +[9fb5]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/config.lisp#L211 +[d9a0]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/context.lisp#L62 +[e967]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/context.lisp#L78 +[a7d4]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L152 +[d421]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L155 +[f9f4]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L158 +[798e]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L166 +[f8c5]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L289 +[8372]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L368 +[5de0]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L386 +[b975]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L387 +[819b]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L405 +[cab1]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L420 +[aeb2]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/error.lisp#L424 +[40ee]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/json.lisp#L54 +[6ffc]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/plain.lisp#L77 +[7278]: https://github.com/40ants/log4cl-extras/blob/f8cd87a3207bbec9aca5f1162cb374faa23a0dd8/src/secrets.lisp#L357 [d7d4]: https://github.com/40ants/log4cl-extras/issues [d1aa]: https://github.com/fukamachi/lack/ [2c00]: https://quickdocs.org/40ants-doc