Skip to content

Commit daff120

Browse files
authored
Move summary of logging libraries from Logging2 README (#1)
1 parent 315cb42 commit daff120

File tree

1 file changed

+45
-4
lines changed

1 file changed

+45
-4
lines changed

src/index.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,50 @@
22

33
This is the landing page of the [JuliaLogging GitHub organization](https://github.com/JuliaLogging/).
44
JuliaLogging is an umbrella organization for logging-related packages and repositories
5-
of [Julia programming language](https://julialang.org/) ecosystem.
5+
in the [Julia programming language](https://julialang.org/) ecosystem.
66

7-
JuliaLogging is the home for the following packages and repositories:
7+
Here's a summary of libraries which integrate with the standard logging
8+
frontend macros `@debug`, `@info`, `@warn`, `@error` from `Base` and with the
9+
abstractions from the
10+
[`Logging`](https://docs.julialang.org/en/v1/stdlib/Logging) standard library.
11+
12+
### Frontend
13+
14+
* [`ProgressLogging.jl`](https://github.com/JuliaLogging/ProgressLogging.jl)
15+
provides some convenient frontend macros including `@progress` which makes it
16+
easy to emit log records tracking the progress of looping constructs.
17+
18+
### Log Event routing and transformation
19+
20+
* [`LoggingExtras.jl`](https://github.com/JuliaLogging/LoggingExtras.jl) provides
21+
generic log transformation, filtering and routing functionality. You can use
22+
this to mutate messages as they go through the chain, duplicate a stream of
23+
log records into multiple streams, discard messages based on a predicate, etc.
24+
* [`Logging2.jl`](https://github.com/JuliaLogging/Logging2.jl) provides
25+
utilities to redirect
26+
27+
### Sinks
28+
29+
* The [`Logging`](https://docs.julialang.org/en/v1/stdlib/Logging) stdlib
30+
provides a default logger backend `ConsoleLogger` for basic filtering and
31+
pretty printing of log records in the terminal.
32+
* [`TerminalLoggers.jl`](https://github.com/JuliaLogging/TerminalLoggers.jl) is a
33+
library for advanced terminal-based pretty printing of log records, including
34+
fancy progress bars and markdown formatting.
35+
* [`TensorBoardLogger.jl`](https://github.com/PhilipVinc/TensorBoardLogger.jl)
36+
can log structured numeric data to
37+
[TensorBoard](https://www.tensorflow.org/tensorboard) as a backend.
38+
* [`LogRoller.jl`](https://github.com/JuliaLogging/LogRoller.jl) has a backend for
39+
rotating log files once they hit a size limit.
40+
* [`Syslogging.jl`](https://github.com/JuliaLogging/SyslogLogging.jl) provides a
41+
backend to direct logs to syslog.
42+
* [`LoggingExtras.jl`](https://github.com/JuliaLogging/LoggingExtras.jl) provides a
43+
simple `FileLogger` sink.
44+
* [LokiLogger](https://github.com/JuliaLogging/LokiLogger.jl) is a log message
45+
sink for [Grafana Loki](https://grafana.com/oss/loki/)
46+
47+
### Configuration
48+
49+
* [`LogCompose.jl`](https://github.com/JuliaLogging/LogCompose.jl) provides
50+
declarative logger configuration and an associated `.toml` file format.
851

9-
* [LoggingExtras](https://github.com/JuliaLogging/LoggingExtras.jl) -- extensions to the Logging stdlib
10-
* [LokiLogger](https://github.com/JuliaLogging/LokiLogger.jl) -- log message sink for [Grafana Loki](https://grafana.com/oss/loki/)

0 commit comments

Comments
 (0)