# Quick Tracing

tracing initialization library to easily get started with tracing.

<div>
    <a href="https://docs.rs/quick_tracing">
        <img src="https://img.shields.io/docsrs/quick_tracing" alt="docs.rs">
    </a>
    <a href="https://github.com/SARDONYX-sard/quick_tracing/actions/workflows/build-and-test.yml">
        <img src="https://github.com/SARDONYX-sard/quick_tracing/actions/workflows/build-and-test.yml/badge.svg" alt="Build & Test">
    </a>
    <a href="https://github.com/SARDONYX-sard/quick_tracing/actions/workflows/release.yaml">
        <img src="https://github.com/SARDONYX-sard/quick_tracing/actions/workflows/release.yaml/badge.svg" alt="Release">
    </a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
    </a>

</div>

```rust
fn main() -> std:io::Result<()> {
     let _guard = quick_tracing::init()?;
     tracing::info!("Hey!");
     Ok(())
 }
```

## Derive

Need to write the following it in Cargo.toml

```toml
quick_tracing = { version = "0.1.5", features = ["derive"] }
```

### Attributes

- `test`: Sets the test name for the logger. Log output will be written to a file named `../../logs/{test_name}.log`.
- `file`: Sets the file path for the log output.
- `stdio`: Enables standard I/O output for the logger.(default: true)
- `level`: Sets the log level filter (e.g., `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`).

### Examples

```rust
#[quick_tracing::init]
fn main() {
    tracing::debug!("Hello, world!");
}
```

- Debug mode + Output file

  If there is no parent directory, it will automatically create one.

> [!WARNING]
> Panic is a possibility.

```rust
#[quick_tracing::init(level= "DEBUG", file = "./log/test.log", stdio = false)]
fn main() {
    tracing::debug!("Hello, world!");
}
```

- non panic + Debug mode + Output file

  If there is no parent directory, it will automatically create one.

```rust
#[quick_tracing::try_init(level= "DEBUG", file = "./log/test.log", stdio = false)]
fn main() -> std::io::Result<()> {
    tracing::debug!("Hello, world!");
    Ok(())
}
```