13 lines
7.2 KiB
HTML
13 lines
7.2 KiB
HTML
<!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="Diagnostics: log level control and the exportable bug-report bundle."><title>jellytau_lib::commands::diagnostics - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="jellytau_lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.97.1 (8bab26f4f 2026-07-14)" data-channel="1.97.1" data-search-js="search-fd9372ac.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-fcd733ba.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module diagnostics</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../jellytau_lib/index.html">jellytau_<wbr>lib</a><span class="version">0.10.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module diagnostics</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In jellytau_<wbr>lib::<wbr>commands</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">jellytau_lib</a>::<wbr><a href="../index.html">commands</a></div><h1>Module <span>diagnostics</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/jellytau_lib/commands/diagnostics.rs.html#1-330">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Diagnostics: log level control and the exportable bug-report bundle.</p>
|
||
<p>TRACES: UR-078 | DR-218</p>
|
||
<p>The app used to forget everything it did the moment it exited. A user
|
||
reporting “the episode randomly restarted” was reporting the symptom of a
|
||
race whose evidence had been discarded microseconds later, and the only way
|
||
to recover it was to talk them through <code>adb logcat</code> — which is how several
|
||
bugs in this project’s history actually got diagnosed.</p>
|
||
<p>This module is the other half of that: the log is on disk, it survives a
|
||
crash, and the user can hand the whole thing over as one file.</p>
|
||
<p>Everything written here has been through <a href="../../utils/diagnostics/fn.redact.html" title="fn jellytau_lib::utils::diagnostics::redact"><code>crate::utils::diagnostics::redact</code></a>
|
||
twice — once in the log formatter, and again on the way into the archive, so
|
||
files written by a build that predates the formatter pass are covered too.</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.DiagnosticsBundle.html" title="struct jellytau_lib::commands::diagnostics::DiagnosticsBundle">Diagnostics<wbr>Bundle</a></dt><dd>Where an export landed, so the UI can tell the user where to find it.</dd><dt><a class="struct" href="struct.DiagnosticsInfo.html" title="struct jellytau_lib::commands::diagnostics::DiagnosticsInfo">Diagnostics<wbr>Info</a></dt><dd>Where logs live and how verbose they currently are.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.LEVEL_FILE.html" title="constant jellytau_lib::commands::diagnostics::LEVEL_FILE">LEVEL_<wbr>FILE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Name of the file holding the user’s chosen level, in the app config dir.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.diagnostics_export.html" title="fn jellytau_lib::commands::diagnostics::diagnostics_export">diagnostics_<wbr>export</a></dt><dd>Write a redacted diagnostics archive and return where it went.</dd><dt><a class="fn" href="fn.diagnostics_get_info.html" title="fn jellytau_lib::commands::diagnostics::diagnostics_get_info">diagnostics_<wbr>get_<wbr>info</a></dt><dd>Current log level and where the files are.</dd><dt><a class="fn" href="fn.diagnostics_set_level.html" title="fn jellytau_lib::commands::diagnostics::diagnostics_set_level">diagnostics_<wbr>set_<wbr>level</a></dt><dd>Set the log level, for this session and the next.</dd><dt><a class="fn" href="fn.environment_summary.html" title="fn jellytau_lib::commands::diagnostics::environment_summary">environment_<wbr>summary</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A short, non-identifying description of the environment.</dd><dt><a class="fn" href="fn.level_name.html" title="fn jellytau_lib::commands::diagnostics::level_name">level_<wbr>name</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.log_files.html" title="fn jellytau_lib::commands::diagnostics::log_files">log_<wbr>files</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Collect every log file in the log directory, newest first.</dd><dt><a class="fn" href="fn.parse_level.html" title="fn jellytau_lib::commands::diagnostics::parse_level">parse_<wbr>level</a></dt><dd>Parse a stored/user-supplied level name.</dd><dt><a class="fn" href="fn.stored_level.html" title="fn jellytau_lib::commands::diagnostics::stored_level">stored_<wbr>level</a></dt><dd>Read the persisted level, if the user has ever set one.</dd></dl></section></div></main></body></html> |