Skip to main content

Module dial9

Module dial9 

Source
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 with TraceField, read a trace back with Decoder.
trace_format
dial9-trace-format

Structs§

Dial9Handle
Cheap, cloneable handle for recording events and controlling telemetry.
Dial9TokioHandletokio
Tokio handle for spawning instrumented tasks.
Disk
Disk-backed mode (default).
ExportReport
What a best-effort copy of a live recording captured.
InstallGlobalHandleError
Recorder::install_global_handle did not install: a process-global Dial9Handle was already installed.
Memory
In-memory mode.
Operation
A lifecycle recorded only when the ambient recorder is enabled at creation.
RamaOperationFinished
A recorded operation ended, including cancellation by dropping its future.
RamaOperationLink
An association between independently lived operations, such as a request and the pooled connection selected for it. No context is reassigned.
RamaOperationStarted
A recorded operation started. Parent IDs describe nesting within a flow.
Recorder
Owns the recording state: the Dial9Handle, the flush thread, and (with the pipeline feature) the background worker.
RecorderBuilder
Builder for a runtime-agnostic Recorder. See recorder.
RecorderHealth
Recorder health for an application’s metrics exporter or diagnostics bundle. Pass sink to 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.
RecorderHealthSnapshot
Independently sampled counters; not a transactional snapshot. A zero flushes count 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.
TaskDumpConfigtokio
Configuration for task dump capture.
TokioAttachOptionstokio
Per-runtime attach settings. All optional; runtime-scoped only (session-wide settings like the pipeline, S3, and segment metadata stay on the recorder).
TokioHookstokio
User-provided callbacks to run alongside dial9’s internal Tokio runtime hooks.
TraceContext
Correlation for a logical flow and the operation currently handling it.
TracedFuturetokio
Future wrapper produced by spawn_with for custom spawn APIs.

Enums§

Outcome
Terminal outcome of an operation. The numeric values are part of the schema.

Traits§

Dial9HandleTokioExttokio
Tokio instrumentation for Dial9Handle.
JoinSetExttokio
Dial9 instrumentation for [JoinSet].
RecorderPipelineExttokio
dial9 pipeline presets on the recorder builder.
RecorderSourceExtDeprecated
Empty, its methods are inherent on RecorderBuilder now.

Functions§

block_ontokio
Run future to completion on runtime, instrumented.
block_on_localtokio
block_on for a [tokio::runtime::LocalRuntime]: runs future as 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::current resolves.
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 handle returns a disabled handle.
recorder_from_envtokio
Build a recorder and its instrumented Tokio runtime from standard DIAL9_* environment variables.
recorder_from_env_withtokio
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.
spawntokio
Spawn a traced task on the current tokio runtime.
spawn_intokio
Spawn a traced task onto a specific runtime, from any thread.
spawn_localtokio
spawn without the Send bounds.
spawn_local_intokio
spawn_in for a [tokio::task::LocalSet]: spawn a traced !Send task onto set, from inside or outside its context.

Type Aliases§

AttachedRuntimetokio
The recorder and runtime pair a #[dial9::main] config returns.
DiskBuffer
Alias for the disk-backed writer (the default mode).
MemoryBuffer
Alias for the in-memory writer.

Attribute Macros§

maintokio
Instrument an async main with dial9 telemetry. Replaces #[tokio::main]. Instrument an async main function with dial9 telemetry.