https://github.com/magiclen/pipe-logger-lib

Stores, rotates, compresses process logs.
https://github.com/magiclen/pipe-logger-lib

pipe-logger rust

Last synced: 28 days ago
JSON representation

Stores, rotates, compresses process logs.

• Host: GitHub
• URL: https://github.com/magiclen/pipe-logger-lib
• Owner: magiclen
• License: mit
• Created: 2018-09-12T16:06:29.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-09T12:22:09.000Z (over 1 year ago)
• Last Synced: 2024-11-19T06:59:23.303Z (about 1 month ago)
• Topics: pipe-logger, rust
• Language: Rust
• Homepage:
• Size: 37.1 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Pipe Logger Lib

====================

[![CI](https://github.com/magiclen/pipe-logger-lib/actions/workflows/ci.yml/badge.svg)](https://github.com/magiclen/pipe-logger-lib/actions/workflows/ci.yml)

Stores, rotates, compresses process logs.

## Example

```rust

use pipe_logger_lib::*;

use std::fs;

use std::path::Path;

let test_folder = {

  let folder = Path::join(&Path::join(Path::new("tests"), Path::new("out")), "log-example");

  fs::remove_dir_all(&folder);

  fs::create_dir_all(&folder).unwrap();

  folder

};

let test_log_file = Path::join(&test_folder, Path::new("mylog.txt"));

let mut builder = PipeLoggerBuilder::new(&test_log_file);

builder

    .set_tee(Some(Tee::Stdout))

    .set_rotate(Some(RotateMethod::FileSize(30))) // bytes

    .set_count(Some(10))

    .set_compress(false);

{

    let mut logger = builder.build().unwrap();

    logger.write_line("Hello world!").unwrap();

    let rotated_log_file_1 = logger.write_line("This is a convenient logger.").unwrap().unwrap();

    logger.write_line("Other logs...").unwrap();

    logger.write_line("Other logs...").unwrap();

    let rotated_log_file_2 = logger.write_line("Rotate again!").unwrap().unwrap();

    logger.write_line("Ops!").unwrap();

}

fs::remove_dir_all(test_folder).unwrap();

```

Now, the contents of `test_log_file` are,

```text

Ops!

```

The contents of `rotated_log_file_1` are,

```text

Hello world!

This is a convenient logger.

```

The contents of `rotated_log_file_2` are,

```text

Other logs...

Other logs...

Rotate again!

```

## Crates.io

https://crates.io/crates/pipe-logger-lib

## Documentation

https://docs.rs/pipe-logger-lib

## Official CLI

https://crates.io/crates/pipe-logger

## License

[MIT](LICENSE)