Expand description
low level tracing - has minimal dependencies
Modules§
- dispatch
- Where events are recorded and eventually sent to a sink
- errors
- Error types and handling for tracing operations
- event
- Structure to record events in memory
- flush_
monitor - FlushMonitor triggers the flush of the telemetry streams at regular interval.
- guards
- RAII-style guards
- intern_
string - Store dynamically-created strings in a global container. Strings are never released from the container.
- levels
- Verbosity management
- logs
- Events representing a process’s log
- metrics
- Events representing a measured scalar at a point in time
- panic_
hook - Reports panics as fatal log entries and shuts down the telemetry system
- parsing
- Manual parsing of dynamically sized events
- prelude
- Commonly used items for convenient importing - includes macros, types, and traits
- process_
info - Process metadata
- property_
set - Interned collection of PropertySet instances. Each PropertySet contains properties where the names and the values are statically allocated. The user is expected to manage the cardinality.
- runtime
- Runtime integration utilities for micromegas tracing
- spans
- Events reprensenting units of code execution
- static_
string_ ref - StaticStringRef points to a string dependency keeping track of the codec. Necessary for unreal instrumentation where ansi and wide strings can coexist. In cases where the event format does not have to be compatible with unreal, StringId can be used.
- string_
id - StringId serializes the value of the pointer and the size of a UTF8 string. StaticStringRef should be prefered where wire compatibility with unreal is important.
- test_
utils - Test utilities for in-memory tracing in unit tests
- time
- System & monotonic tick count
Macros§
- debug
- Logs a message at the debug level.
- error
- Logs a message at the error level.
- fatal
- Logs a message representing a crash or panic
- fmetric
- Records a float metric.
- imetric
- Records a integer metric.
- info
- Logs a message at the info level.
- instrument_
named - Instruments a future with a named span.
Usage:
instrument_named!(future, "span_name") - log
- The standard logging macro.
- log_
enabled - Determines if a message logged at the specified level in that module will be logged.
- span_
async_ named - Instruments an async block with a named span using a static string. This creates both the SpanLocation and instruments the future in one macro call.
- span_
scope - Records a sync span as two thread events
- span_
scope_ named - Records a span with a name that is determined at runtime. The span name still needs to be statically allocated.
- static_
span_ desc - static_
span_ location - Creates a static SpanLocation for use with named async spans.
This is an internal implementation detail - users should use
instrument_named!instead. - trace
- Logs a message at the trace level.
- warn
- Logs a message at the warn level.