Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 22, 2024
1 parent 42650f2 commit d5e32ad
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,13 @@

## 40ANTS-LOGGING ASDF System Details

* Version: 0.1.0

* Description: Functions to configure log4cl for different contexts: `REPL`, Backend, Command Line Application.

* Licence: Unlicense

* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>

* Homepage: [https://40ants.com/logging/][3eb9]

* Bug tracker: [https://github.com/40ants/logging/issues][cd63]

* Source control: [GIT][0aac]
* Depends on: [global-vars][07be], [log4cl-extras][691c]

[![](https://github-actions.40ants.com/40ants/logging/matrix.svg?only=ci.run-tests)][2779]

Expand Down Expand Up @@ -110,19 +104,19 @@ To change log level only for the `REPL`, call `(40ants-logging:setup-for-repl :l

<a id="x-2840ANTS-LOGGING-3ASETUP-FOR-BACKEND-20FUNCTION-29"></a>

### [function](a285) `40ants-logging:setup-for-backend` &key (level \*default-level\*)
### [function](2c1c) `40ants-logging:setup-for-backend` &key (level \*default-level\*)

Configures `LOG4CL` for logging in `JSON` format.

<a id="x-2840ANTS-LOGGING-3ASETUP-FOR-CLI-20FUNCTION-29"></a>

### [function](8984) `40ants-logging:setup-for-cli` &key (level \*default-level\*)
### [function](a55f) `40ants-logging:setup-for-cli` &key (level \*default-level\*)

Configures `LOG4CL` for logging in plain-text format with context fields support.

<a id="x-2840ANTS-LOGGING-3ASETUP-FOR-REPL-20FUNCTION-29"></a>

### [function](3e3a) `40ants-logging:setup-for-repl` &key (level \*level\*) (stream \*debug-io\*)
### [function](58f6) `40ants-logging:setup-for-repl` &key (level \*level\*) (stream \*debug-io\*)

Configures `LOG4CL` for logging in `REPL` when you connect to the running lisp image already configured as a backend or `CLI` application.

Expand All @@ -131,7 +125,7 @@ when your `SLY` connects to the image.

<a id="x-2840ANTS-LOGGING-3AREMOVE-REPL-APPENDER-20FUNCTION-29"></a>

### [function](8f2a) `40ants-logging:remove-repl-appender`
### [function](792b) `40ants-logging:remove-repl-appender`

Returns configuration the state as it was after [`setup-for-backend`][d0af] or [`setup-for-cli`][78f4] call.

Expand All @@ -147,11 +141,13 @@ when your `SLY` disconnects from the image.
[04ac]: https://40ants.com/slynk/#x-28-23A-28-2812-29-20BASE-CHAR-20-2E-20-2240ants-slynk-22-29-20ASDF-2FSYSTEM-3ASYSTEM-29
[0aac]: https://github.com/40ants/logging
[2779]: https://github.com/40ants/logging/actions
[a285]: https://github.com/40ants/logging/blob/8f32a96d500ee95bb43f1d98b6ee6d6782b7149b/src/core.lisp#L22
[3e3a]: https://github.com/40ants/logging/blob/8f32a96d500ee95bb43f1d98b6ee6d6782b7149b/src/core.lisp#L36
[8f2a]: https://github.com/40ants/logging/blob/8f32a96d500ee95bb43f1d98b6ee6d6782b7149b/src/core.lisp#L53
[8984]: https://github.com/40ants/logging/blob/8f32a96d500ee95bb43f1d98b6ee6d6782b7149b/src/core.lisp#L63
[2c1c]: https://github.com/40ants/logging/blob/42650f26a86e2a88b3cfde6749f4976ddd7b4282/src/core.lisp#L22
[58f6]: https://github.com/40ants/logging/blob/42650f26a86e2a88b3cfde6749f4976ddd7b4282/src/core.lisp#L36
[792b]: https://github.com/40ants/logging/blob/42650f26a86e2a88b3cfde6749f4976ddd7b4282/src/core.lisp#L53
[a55f]: https://github.com/40ants/logging/blob/42650f26a86e2a88b3cfde6749f4976ddd7b4282/src/core.lisp#L63
[cd63]: https://github.com/40ants/logging/issues
[07be]: https://quickdocs.org/global-vars
[691c]: https://quickdocs.org/log4cl-extras

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]

0 comments on commit d5e32ad

Please sign in to comment.