Reference¶
Exact behaviour of the crate's public surface: what each item is, what it defaults to, and what happens when it is wrong. Prose explanations of why live under Explanation; task-shaped instructions live under How-to.
The generated API listing is on docs.rs/rtb-telemetry. These pages cover the things a generated listing cannot: defaults, failure modes, and the parts of the behaviour that are not visible in a signature.
| Page | Answers |
|---|---|
TelemetryContext and its builder |
Which builder fields are required, what the defaults are, when build() panics, what record does when collection is disabled. |
Event and its JSON shape |
Field names on the wire, which fields are omitted, timestamp format, severity mapping. |
| Sinks | The five built-in sinks, every configuration field with its default, and what each one does on failure. |
| The consent file | On-disk TOML format, the schema version rule, and the three functions that read, write and delete it. |
| Cargo features | What remote-sinks turns on, what is enabled by default, the MSRV, and the runtime the crate needs. |
| Errors | Every TelemetryError variant, its message, its diagnostic code, and which call produces it. |
Version this documents¶
These pages were written against rtb-telemetry 0.7.3. Where behaviour is version-sensitive — the OTLP transports especially — the page says which version was tested.