Available on crate feature
dial9 only.Expand description
dial9 runtime telemetry re-exports.
Modules§
- core
- Building blocks for extending dial9: implement a
Source, write custom encoders, author custom segment processors, reach the raw recording modules. - format
- The trace format: define events with
#[derive(TraceEvent)], encode your own types withTraceField, read a trace back withDecoder. - trace_
format - dial9-trace-format
Structs§
- Dial9
Handle - Cheap, cloneable handle for recording events and controlling telemetry.
- Dial9
Tokio Handle tokio - Tokio handle for spawning instrumented tasks.
- Disk
- Disk-backed mode (default).
- Export
Report - What a best-effort copy of a live recording captured.
- Install
Global Handle Error Recorder::install_global_handledid not install: a process-globalDial9Handlewas already installed.- Memory
- In-memory mode.
- Operation
- A lifecycle recorded only when the ambient recorder is enabled at creation.
- Rama
Operation Finished - A recorded operation ended, including cancellation by dropping its future.
- Rama
Operation Link - An association between independently lived operations, such as a request and the pooled connection selected for it. No context is reassigned.
- Rama
Operation Started - A recorded operation started. Parent IDs describe nesting within a flow.
- Recorder
- Owns the recording state: the
Dial9Handle, the flush thread, and (with thepipelinefeature) the background worker. - Recorder
Builder - Builder for a runtime-agnostic
Recorder. Seerecorder. - Recorder
Health - Recorder health for an application’s metrics exporter or diagnostics bundle.
Pass
sinkto the upstream recorder builder’s metrics sink. Nothing is installed globally. Reading this handle performs no disk I/O. Create a fresh health handle for each recorder session. - Recorder
Health Snapshot - Independently sampled counters; not a transactional snapshot.
A zero
flushescount means no flush metrics have been observed yet. Seal counts reflect the last upstream flush snapshot, which precedes finalization of the last segment; they can undercount by that final seal. - Task
Dump Config tokio - Configuration for task dump capture.
- Tokio
Attach Options tokio - Per-runtime attach settings. All optional; runtime-scoped only (session-wide settings like the pipeline, S3, and segment metadata stay on the recorder).
- Tokio
Hooks tokio - User-provided callbacks to run alongside dial9’s internal Tokio runtime hooks.
- Trace
Context - Correlation for a logical flow and the operation currently handling it.
- Traced
Future tokio - Future wrapper produced by
spawn_withfor custom spawn APIs.
Enums§
- Outcome
- Terminal outcome of an operation. The numeric values are part of the schema.
Traits§
- Dial9
Handle Tokio Ext tokio - Tokio instrumentation for
Dial9Handle. - Join
SetExt tokio - Dial9 instrumentation for [
JoinSet]. - Recorder
Pipeline Ext tokio - dial9 pipeline presets on the recorder builder.
- Recorder
Source Ext Deprecated - Empty, its methods are inherent on
RecorderBuildernow.
Functions§
- block_
on tokio - Run
futureto completion onruntime, instrumented. - block_
on_ local tokio block_onfor a [tokio::runtime::LocalRuntime]: runsfutureas a traced task so its polls are recorded.- export_
completed_ segments - Copy completed dial9 segments into a new diagnostics subdirectory.
- record_
event - Record an event on the handle
Dial9Handle::currentresolves. - record_
result - Record a fallible operation, including an error or cancellation before it completes. Construction is lazy: recording starts when this future is polled.
- recorder
- Begin building a recorder backed by
writer. - recorder_
disabled - A recorder with recording permanently disabled: no flush thread, no sources,
and
handlereturns a disabled handle. - recorder_
from_ env tokio - Build a recorder and its instrumented Tokio runtime from standard
DIAL9_*environment variables. - recorder_
from_ env_ with tokio recorder_from_env, plus control over the Tokio runtime it builds.- recorder_
or_ disabled - Begin building a recorder backed by
writer, or a writer-free disabled one when the writer could not be created. - spawn
tokio - Spawn a traced task on the current tokio runtime.
- spawn_
in tokio - Spawn a traced task onto a specific runtime, from any thread.
- spawn_
local tokio spawnwithout theSendbounds.- spawn_
local_ in tokio spawn_infor a [tokio::task::LocalSet]: spawn a traced!Sendtask ontoset, from inside or outside its context.
Type Aliases§
- Attached
Runtime tokio - The recorder and runtime pair a
#[dial9::main]config returns. - Disk
Buffer - Alias for the disk-backed writer (the default mode).
- Memory
Buffer - Alias for the in-memory writer.
Attribute Macros§
- main
tokio - Instrument an async
mainwith dial9 telemetry. Replaces#[tokio::main]. Instrument an async main function with dial9 telemetry.