https://github.com/julialogging/miniloggers.jl
Julia logger with customizable logging string
https://github.com/julialogging/miniloggers.jl
Last synced: over 1 year ago
JSON representation
Julia logger with customizable logging string
- Host: GitHub
- URL: https://github.com/julialogging/miniloggers.jl
- Owner: JuliaLogging
- License: mit
- Created: 2021-03-09T10:16:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T14:40:56.000Z (over 2 years ago)
- Last Synced: 2025-03-10T22:43:05.374Z (over 1 year ago)
- Language: Julia
- Homepage:
- Size: 597 KB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MiniLoggers.jl
| **Documentation** | **Build Status** | **JuliaHub** |
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [](https://JuliaLogging.github.io/MiniLoggers.jl/stable)[](https://JuliaLogging.github.io/MiniLoggers.jl/dev) | [](https://github.com/JuliaLogging/MiniLoggers.jl/actions)[](https://codecov.io/gh/JuliaLogging/MiniLoggers.jl) | [](https://juliahub.com/ui/Packages/MiniLoggers/5ppWi)[](https://juliahub.com/ui/Packages/MiniLoggers/5ppWi) |
`MiniLoggers.jl` provides Julia logger with minimal setup and simple yet powerful format of logging strings. It allows to build custom and compact logging, which supports coloring, output to external files, timestamps and many more.
# Installation
`MiniLoggers.jl` is a part of General registry, so it should be installed with
```julia
julia> using Pkg; Pkg.add("MiniLoggers")
```
# Examples of usage
In it's most simple form, `MiniLoggers.jl` is used as
```julia
using MiniLoggers
MiniLogger(minlevel = MiniLoggers.Debug) |> global_logger
x = 1
y = "asd"
@debug "Values: " x y
@info "Values: " x y
@warn "Values: " x y
@error "Values: " x y
```
and produces
But one can make it more colourful and add more details with initilization like the following
```julia
MiniLogger(minlevel = MiniLoggers.Debug,
format = "{[{timestamp}] - {level} - :func}{{module}@{basename}:{line:cyan}:light_green}: {message}") |> global_logger
@debug "Values: " x y
@info "Values: " x y
@warn "Values: " x y
@error "Values: " x y
```
which yields
Or, we can add small unicode magic and get fancy two-line logging format
```julia
MiniLogger(minlevel = MiniLoggers.Debug,
format = "ā{[{timestamp}] - {level} - :func}{{module}@{basename}:{line:cyan}:light_green}\nā°ā {message}") |> global_logger
```
Format constructor is very flexible, so the output of log messages is mostly limited by your imagination.
At the same time, you can go other way arround and remove all extra details completely turning it effectively to a basic `println` command, thus making it convinient to plug minilogger in packages like [LoggingExtras.jl](https://github.com/JuliaLogging/LoggingExtras.jl)
```julia
MiniLogger(minlevel = MiniLoggers.Debug, format = "{message}") |> global_logger
```
Also `MiniLoggers.jl` support Julia exceptions, so you can generate error messages in a usual way
```julia
MiniLogger(minlevel = MiniLoggers.Debug,
format = "{[{timestamp}] {level}:func} {module}@{basename}:{line:cyan}: {message}") |> global_logger
try
error("Some error")
catch err
@error (err, catch_backtrace())
end
```
