ratatouille 0.1.0

Best-effort telemetry firehose logger with bounded topic state
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

# ratatouille

A zero-dependency Rust crate for best-effort telemetry firehose logging with topic filters, per-topic sequence counters, text or NDJSON formatting, and std-only HTTP/TCP sinks and relays.

## Features

- DEBUG-style allow/deny topic filters with `*` wildcards
- per-topic monotonic local sequence counters
- text and NDJSON output modes
- stdout sink, callback sink, and custom sink trait support
- plain `http://` sink plus bounded explicit-flush HTTP relay
- plain `tcp://host:port` sink plus bounded explicit-flush TCP relay
- zero external dependencies beyond Rust std

## Quick start

```rust
use ratatouille::{Format, Logger, LoggerConfig, SourceIdentity};

fn main() {
    let mut config = LoggerConfig::default();
    config.filter = Some("api*,-api:noise".into());
    config.format = Format::Ndjson;
    config.source = SourceIdentity {
        app: Some("example".into()),
        r#where: Some("rust".into()),
        instance: Some("local".into()),
    };

    let mut logger = Logger::new(config);
    let _ = logger.log("api", "hello from Rust");
}
```

## Transports

`HttpSink` and `HttpRelay` are intentionally minimal:

- `http://` only
- no TLS
- no background thread
- bounded in-memory relay queue
- explicit `flush_now()` for relay batch delivery

`TcpSink` and `TcpRelay` are similarly minimal:

- `tcp://host:port` only
- no background thread
- bounded in-memory relay queue
- explicit `flush_now()` for relay batch delivery

## Notes

- Logging is best-effort telemetry, not an audit trail.
- `LoggerConfig::default()` does not emit anything until a filter is configured.
- The shared behavioral contract lives in `contract/cases.tsv` in the repository root.