|
6 | 6 | log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j, |
7 | 7 | Log4net, etc. |
8 | 8 |
|
9 | | -> **Current Status** |
10 | | -> The library is now complete enough to be used in production if the `ConsoleAppender` and |
11 | | -`LocalStorageAppender` are sufficient for your needs. Documentation is being completed in the |
12 | | -repository and will be updated as progress is made - as soon as it is in a reasonably complete |
13 | | -state, a proper link will be made available here. |
14 | | -> |
15 | | -> Until then, the [demo project](tree/main/projects/demo/) contains examples of configuring and |
16 | | -using the library. |
17 | | - |
18 | 9 | ## Concepts |
19 | 10 |
|
| 11 | +### Loggers |
| 12 | + |
| 13 | +`Loggers` provide access to the methods for logging messages at the required `Level`. Each class - |
| 14 | +i.e. component, module or service - will usually define its own `Logger` which will identify that |
| 15 | +class within any messages logged via it. |
| 16 | + |
20 | 17 | ### LogService |
21 | 18 |
|
22 | 19 | The `LogService` is the factory with which you instantiate `Loggers` in each of the components, |
23 | 20 | services, etc, in which you wish to log messages. Behind the scenes, it also orchestrates the |
24 | 21 | dispatch of messages from the `Loggers` to the appropriate `Appenders`. |
25 | 22 |
|
| 23 | +### Appenders |
| 24 | + |
| 25 | +`Appenders` are responsible for sending log entries to the underlying target or service. |
| 26 | +Configuration will normally depend on the target/service, but all `Appenders` are configured with |
| 27 | +the layout format for messages logged to them. |
| 28 | + |
26 | 29 | ### LogServiceConfig |
27 | 30 |
|
28 | 31 | The `LogService` is configured using an instance of the `LogServiceConfig`, typically created in |
29 | 32 | your application's main module. The configuration defines the parameters used with each `Appender` |
30 | 33 | and how each `Appender` relates to the various `Loggers`. |
31 | 34 |
|
32 | | -### Loggers |
33 | | - |
34 | | -`Loggers` provide access to the methods for logging messages at the required `Level`. Each class - |
35 | | -i.e. component, module or service - will usually define its own `Logger` which will identify that |
36 | | -class within any messages logged via it. |
37 | | - |
38 | | -### Appenders |
39 | | - |
40 | | -`Appenders` are responsible for sending log entries to the underlying target or service. |
41 | | -Configuration will normally depend on the target/service, but all `Appenders` are configured with |
42 | | -the layout format for messages logged to them. |
| 35 | +For more information about using and configuring log4ngx, see <https://secondbounce.github.io/log4ngx/>. |
| 36 | +The [demo project](projects/demo/) also contains examples of configuring and using the |
| 37 | +library. |
0 commit comments