tracing-rolling-file 0.1.3

A rolling file appender with customizable rolling conditions.
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

# tracing-rolling-file

[![tracing-rolling-file on GitHub Actions](https://github.com/cavivie/tracing-rolling-file/actions/workflows/main.yaml/badge.svg)](https://github.com/cavivie/tracing-rolling-file/actions?query=workflow%3Atest)
[![tracing-rolling-file on crates.io](https://img.shields.io/crates/v/tracing-rolling-file.svg)](https://crates.io/crates/tracing-rolling-file)
[![tracing-rolling-file on docs.rs](https://docs.rs/tracing-rolling-file/badge.svg)](https://docs.rs/tracing-rolling-file)
[![GitHub: cavivie/tracing-rolling-file](https://img.shields.io/badge/GitHub--cavivie-tracing--rolling--file-lightgrey?style=flat-square)](https://github.com/cavivie/tracing-rolling-file)
![license: MIT or Apache-2.0](https://img.shields.io/badge/license-MIT%20or%20Apache--2.0-red?style=flat-square)

A rolling file appender with customizable rolling conditions, based on [rolling-file](https://github.com/Axcient/rolling-file-rs).
Includes built-in support for rolling conditions on date/time
(daily, hourly, every minute) and/or size.

Follows a Debian-style naming convention for logfiles,
using basename, basename.1, ..., basename.N where N is
the maximum number of allowed historical logfiles.

This is useful to combine with the [tracing](https://crates.io/crates/tracing) crate and
[tracing_appender::non_blocking::NonBlocking](https://docs.rs/tracing-appender/latest/tracing_appender/non_blocking/index.html) -- use it
as an alternative to [tracing_appender::rolling::RollingFileAppender](https://docs.rs/tracing-appender/latest/tracing_appender/rolling/struct.RollingFileAppender.html).

## Examples

```rust
use tracing_rolling_file::*;
let file_appender = RollingFileAppenderBase::new(
    "/var/log/myprogram",
    RollingConditionBase::new().daily(),
    9
).unwrap();
```
### Builder

To simplify the creation of a `RollingFileAppenderBase`, an instance can be built as per the example below.

```rust
use tracing_rolling_file::*;

let builder = RollingFileAppenderBase::builder();
let appender = builder
    .filename(String::from("/var/log/myprogram"))
    .max_filecount(10)
    .condition_max_file_size(100)
    .build()
    .unwrap();
```

### Non-blocking support

To combine the `tracing_appender::non_blocking::NonBlocking` functionality, the feature needs to be enabled in Cargo.toml, i.e.

```toml
[dependencies]
tracing-rolling-file = { version = "0.1.3", features = ["non-blocking"] }
```

Once enabled, you can use the method `get_non_blocking_appender` to generate
a non-blocking version of the RollingFileAppenderBase.

```rust
use tracing_rolling_file::*;

let file_appender = RollingFileAppenderBase::new(
    "/var/log/myprogram",
    RollingConditionBase::new().daily(),
    9
)?;
let (non_blocking, _guard) = file_appender.get_non_blocking_appender();
```


## Development

Must pass latest stable clippy, be formatted with nightly rustfmt, and pass unit tests:

```
cargo +nightly fmt
cargo clippy --all-targets
cargo test
```

## License

Dual-licensed under the terms of either the MIT license or the Apache 2.0 license.