zlogger 0.0.1

A lightweight, configurable Rust logging library with color support and file rotation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# zlogger.rs

A lightweight, configurable Rust logging library with color support and file rotation.

## Features

- 🌈 **Color-coded log levels** for terminal output
- 🔧 **Environment variable configuration**
- 📁 **File logging** with automatic rotation
- ðŸŽŊ **Multiple output targets** (console, file, or both)
- ⚡ **Thread-safe logging**
- ðŸŠķ **Minimal dependencies**

## Quick Start

Add this to your `Cargo.toml`:

```toml
[dependencies]
zlogger = "0.0.1"
```

Basic usage:

```rust
use zlogger::{init, info, warn, error};

fn main() {
    // Initialize with default settings
    init();
    
    info!("Application started");
    warn!("This is a warning");
    error!("Something went wrong");
}
```

## Configuration

### Environment Variables

| Variable | Description | Default | Example |
|----------|-------------|---------|---------|
| `ZLOG_LEVEL` | Minimum log level | `info` | `debug` |
| `ZLOG_OUTPUT` | Output target | `console` | `file`, `both` |
| `ZLOG_FILE` | Log file path | `app.log` | `/var/log/myapp.log` |
| `ZLOG_MAX_SIZE` | Max file size (bytes) | `10485760` (10MB) | `1048576` (1MB) |
| `ZLOG_MAX_FILES` | Max rotated files | `5` | `10` |
| `ZLOG_COLOR` | Enable colors | `true` | `false` |

### Programmatic Configuration

```rust
use zlogger::{init_with_config, Config, LogLevel, OutputTarget};

let config = Config::default()
    .level(LogLevel::Debug)
    .output(OutputTarget::Both)
    .file_path("myapp.log")
    .max_file_size(5 * 1024 * 1024) // 5MB
    .max_files(10)
    .use_colors(true);

init_with_config(config);
```

## Log Levels

- `trace` - Very detailed debug information
- `debug` - Debug information
- `info` - General information
- `warn` - Warning messages
- `error` - Error messages

## File Rotation

When a log file reaches the maximum size, it's automatically rotated:
- `app.log` → `app.log.1`
- `app.log.1` → `app.log.2`
- etc.

Old files beyond the maximum count are automatically deleted.

## Examples

Run the basic example:

```bash
cargo run --example basic_usage
```

## License

Licensed under MIT license.

## Credits

- [@liuzhen9320](https://github.com/liuzhen9320) - Project author
- All contributors to the `rust-lang` ecosystem who have made this project possible

---

Built with âĪïļ in Rust for the community