iron_telemetry 0.4.0

Logging and tracing infrastructure for Iron Cage AI agent management
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

# iron_telemetry

Structured logging and tracing for all Iron Cage crates.

[![Documentation](https://img.shields.io/badge/docs.rs-iron_telemetry-E5E7EB.svg)](https://docs.rs/iron_telemetry)

## Installation

```toml
[dependencies]
iron_telemetry = { path = "../iron_telemetry" }
```


## Quick Start

```rust
use iron_telemetry::{init_logging, log_agent_event, log_pii_detection};

// Initialize logging with default configuration
init_logging()?;

// Log agent lifecycle events
log_agent_event("agent_001", "Agent started processing leads");

// Log PII detection (specialized format)
log_pii_detection("agent_001", "email", "john@example.com");

// Output: [14:32:05] INFO  agent-001 | Agent started processing leads
// Output: [14:32:06] WARN  agent-001 | PII DETECTED: email redacted
```


<details>
<summary>Scope & Boundaries</summary>

**Responsibilities:**
Provides centralized logging abstraction using the `tracing` crate. Outputs structured, timestamped, colored logs for terminal display and machine-readable JSON for storage. Injects agent context into all log events for traceability.

**In Scope:**
- Structured logging via `tracing` crate
- Terminal output formatting (timestamp, colors, human-readable)
- Log levels (DEBUG, INFO, WARN, ERROR, CRIT, OK)
- Agent context injection (agent_id in all events)
- Specialized logging functions (PII detections, budget warnings, circuit breaker events)
- Environment-based log level configuration
- JSON export for audit compliance

**Out of Scope:**
- Log aggregation to external services (Datadog, Splunk, Grafana)
- Log sampling and filtering (future)
- Distributed tracing (OpenTelemetry integration)
- Log rotation and archival (future)
- Metrics collection (Prometheus, StatsD)
- Custom log formatters (future)
- Dashboard log display (see iron_dashboard)

</details>


<details>
<summary>Directory Structure</summary>

### Source Files

| File | Responsibility |
|------|----------------|
| lib.rs | Centralized structured logging and tracing for Iron Runtime. |

**Notes:**
- Entries marked 'TBD' require manual documentation
- Entries marked '⚠️ ANTI-PATTERN' should be renamed to specific responsibilities

</details>


## License

Apache-2.0