cirious_codex_logger 0.1.0

Structured logging library for the Cirious Codex ecosystem.
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

<div align="center">

# 📜 Cirious Codex Logger

**Structured Logging & Tracing for the Cirious Ecosystem**

[![CI](https://github.com/cirious-studio/cirious_codex_logger/actions/workflows/ci.yml/badge.svg)](https://github.com/cirious-studio/cirious_codex_logger/actions/workflows/ci.yml) [![Crates.io](https://img.shields.io/crates/v/cirious_codex_logger.svg)](https://crates.io/crates/cirious_codex_logger) [![Docs.rs](https://docs.rs/cirious_codex_logger/badge.svg)](https://docs.rs/cirious_codex_logger) [![Language](https://img.shields.io/badge/Language-Rust-black?logo=rust)](https://www.rust-lang.org/) [![License](https://img.shields.io/badge/License-MIT%2FApache-blue.svg)](#-license)

</div>

---

## 📖 Overview

**Cirious Codex Logger** is a highly optimized, foundational library for structured logging and event tracing. It provides efficient mechanisms for capturing, formatting, and dispatching application events with rich metadata. 

Designed to be the ultimate observability bedrock for tools and applications within the Cirious ecosystem, prioritizing performance, structural integrity, and seamless terminal integration.

---

## ✨ Features

- Core logging macros (`trace`, `debug`, `info`, `warn`, `error`).
- Extensible output formatters (JSON, human-readable terminal).
- Pluggable dispatchers (stdout, stderr, rolling files).
- Integration with `cirious_codex_term` for rich, native terminal styling.

---

## 🚀 Quick Start
 
Add the following to your `Cargo.toml`:

```toml
[dependencies]
cirious_codex_logger = "0.1"
```

And then in your code:

```rust
use cirious_codex_logger::{debug, error, info, trace, warn};
 
fn main() {
  info!("Application started successfully.");
  debug!("Debugging an internal variable: {}", 42);
  warn!("Memory usage is high.");
  error!("Failed to connect to the database.");
  trace!("Tracing execution flow.");
}
```
---

## 🚧 Current Status & Roadmap

The architecture is currently being mapped out for the initial `v0.2` release:

- [ ] Global Logger Registration (`OnceLock` integration for macros).
- [ ] Context & Metadata Enrichment (`timestamp`, `module_path`, `file`, `line`).
- [ ] Log Filtering (Level & Module-based filtering capabilities).
- [ ] Non-blocking / Async Dispatching (Background thread queueing).
- [ ] Rolling File Dispatcher (Size or Date-based file rotation).

---

## 📜 License

Licensed under either of the following, at your option:

* **[MIT License](LICENSE-MIT)**
* **[Apache License 2.0](LICENSE-APACHE)**

---

<div align="center">
  <i>Minimalist by design. Consistent in execution.</i><br>
  <sub>Engineered by Cirious Studio</sub>
</div>