Auto Generated Documentation
This commit is contained in:
github-actions[bot]
+11
-10
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `tracing` crate."><meta name="keywords" content="rust, rustlang, rust-lang, tracing"><title>tracing - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Crate tracing</p><div class="block version"><p>Version 0.1.25</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all tracing's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "tracing", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/tracing/lib.rs.html#1-1037" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">tracing</a></span></h1><div class="docblock"><p>A scoped, structured logging and diagnostics system.</p>
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../tracing/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png' alt='logo'></div></a><p class="location">Crate tracing</p><div class="block version"><p>Version 0.1.25</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all tracing's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="tracing" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">tracing</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/tracing/lib.rs.html#1-1037" title="goto source code">[src]</a></span></h1><div class="docblock"><p>A scoped, structured logging and diagnostics system.</p>
|
||||
<h1 id="overview" class="section-header"><a href="#overview">Overview</a></h1>
|
||||
<p><code>tracing</code> is a framework for instrumenting Rust programs to collect
|
||||
structured, event-based diagnostic information.</p>
|
||||
@@ -74,15 +74,15 @@ taken from a queue, and so on.</p>
|
||||
events.</p>
|
||||
<h2 id="subscribers" class="section-header"><a href="#subscribers">Subscribers</a></h2>
|
||||
<p>As <code>Span</code>s and <code>Event</code>s occur, they are recorded or aggregated by
|
||||
implementations of the <a href="../tracing/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> trait. <code>Subscriber</code>s are notified
|
||||
implementations of the <a href="../tracing/trait.Subscriber.html"><code>Subscriber</code></a> trait. <code>Subscriber</code>s are notified
|
||||
when an <code>Event</code> takes place and when a <code>Span</code> is entered or exited. These
|
||||
notifications are represented by the following <code>Subscriber</code> trait methods:</p>
|
||||
<ul>
|
||||
<li><a href="../tracing/subscriber/trait.Subscriber.html#tymethod.event"><code>event</code></a>, called when an <code>Event</code> takes place,</li>
|
||||
<li><a href="../tracing/subscriber/trait.Subscriber.html#tymethod.enter"><code>enter</code></a>, called when execution enters a <code>Span</code>,</li>
|
||||
<li><a href="../tracing/subscriber/trait.Subscriber.html#tymethod.exit"><code>exit</code></a>, called when execution exits a <code>Span</code></li>
|
||||
<li><a href="../tracing/trait.Subscriber.html#tymethod.event"><code>event</code></a>, called when an <code>Event</code> takes place,</li>
|
||||
<li><a href="../tracing/trait.Subscriber.html#tymethod.enter"><code>enter</code></a>, called when execution enters a <code>Span</code>,</li>
|
||||
<li><a href="../tracing/trait.Subscriber.html#tymethod.exit"><code>exit</code></a>, called when execution exits a <code>Span</code></li>
|
||||
</ul>
|
||||
<p>In addition, subscribers may implement the <a href="../tracing/subscriber/trait.Subscriber.html#tymethod.enabled"><code>enabled</code></a> function to <em>filter</em>
|
||||
<p>In addition, subscribers may implement the <a href="../tracing/trait.Subscriber.html#tymethod.enabled"><code>enabled</code></a> function to <em>filter</em>
|
||||
the notifications they receive based on <a href="../tracing/struct.Metadata.html">metadata</a> describing each <code>Span</code>
|
||||
or <code>Event</code>. If a call to <code>Subscriber::enabled</code> returns <code>false</code> for a given
|
||||
set of metadata, that <code>Subscriber</code> will <em>not</em> be notified about the
|
||||
@@ -410,7 +410,7 @@ denominator" for text-based logging in Rust — a vast majority of Rust
|
||||
libraries and applications either emit or consume <code>log</code> records. Therefore,
|
||||
<code>tracing</code> provides multiple forms of interoperability with <code>log</code>: <code>tracing</code>
|
||||
instrumentation can emit <code>log</code> records, and a compatibility layer enables
|
||||
<code>tracing</code> <a href="../tracing/subscriber/trait.Subscriber.html"><code>Subscriber</code></a>s to consume <code>log</code> records as <code>tracing</code> <a href="../tracing/event/struct.Event.html" title="Event"><code>Event</code></a>s.</p>
|
||||
<code>tracing</code> <a href="../tracing/trait.Subscriber.html"><code>Subscriber</code></a>s to consume <code>log</code> records as <code>tracing</code> <a href="../tracing/event/struct.Event.html" title="Event"><code>Event</code></a>s.</p>
|
||||
<h3 id="emitting-log-records" class="section-header"><a href="#emitting-log-records">Emitting <code>log</code> Records</a></h3>
|
||||
<p>This crate provides two feature flags, "log" and "log-always", which will
|
||||
cause <a href="../tracing/span/index.html">spans</a> and <a href="../tracing/event/struct.Event.html">events</a> to emit <code>log</code> records. When the "log" feature is
|
||||
@@ -442,7 +442,7 @@ may be enabled or disabled separately from other <code>log</code> records emitte
|
||||
<code>tracing</code>.</p>
|
||||
<h3 id="consuming-log-records" class="section-header"><a href="#consuming-log-records">Consuming <code>log</code> Records</a></h3>
|
||||
<p>The <a href="https://crates.io/crates/tracing-log"><code>tracing-log</code></a> crate provides a compatibility layer which
|
||||
allows a <code>tracing</code> <a href="../tracing/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to consume <code>log</code> records as though they
|
||||
allows a <code>tracing</code> <a href="../tracing/trait.Subscriber.html"><code>Subscriber</code></a> to consume <code>log</code> records as though they
|
||||
were <code>tracing</code> <a href="../tracing/event/struct.Event.html">events</a>. This allows applications using <code>tracing</code> to record
|
||||
the logs emitted by dependencies using <code>log</code> as events within the context of
|
||||
the application's trace tree. See <a href="https://docs.rs/tracing-log/latest/tracing_log/#convert-log-records-to-tracing-events">that crate's documentation</a>
|
||||
@@ -596,4 +596,5 @@ exists.</p>
|
||||
<table><tr class="module-item"><td><a class="trait" href="trait.Instrument.html" title="tracing::Instrument trait">Instrument</a></td><td class="docblock-short"><p>Attaches spans to a <code>std::future::Future</code>.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.Subscriber.html" title="tracing::Subscriber trait">Subscriber</a></td><td class="docblock-short"><p>Trait representing the functions required to collect trace data.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.Value.html" title="tracing::Value trait">Value</a></td><td class="docblock-short"><p>A field value of an erased type.</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "tracing";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="tracing"></div>
|
||||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user