kstars/doc/ekos-logs.docbook

0001 <sect1 id="ekos-logs">
0002     <title>Logs</title>
0003     <indexterm>
0004         <primary>Tools</primary>
0005         <secondary>Ekos</secondary>
0006         <tertiary>Logs</tertiary>
0007     </indexterm>
0008     <para>
0009         Logging is a very important tool in order to diagnose any issues with either INDI drivers or Ekos. Before submitting any support request, the log must be attached in order to help diagnose the exact issue. Depending on the exact problem, you may need to enable logging for the feature or drivers that exhibit issues. Enabling logging for everything is not recommended as it will produce too much data that would be useful to diagnose the issue and could result in missing the root cause all other. So only enable the necessary logs.
0010     </para>
0011     <para>
0012         The following short video explains how to use the Logging feature to submit logs.
0013     </para>
0014     <mediaobject>
0015         <videoobject>
0016             <videodata contentdepth="450" contentwidth="800" fileref="https://www.stellarmate.com/images/videos/indi_logs_guide.mp4"/>
0017         </videoobject>
0018         <caption>
0019             <para>
0020                 <phrase>Logging feature</phrase>
0021             </para>
0022         </caption>
0023     </mediaobject>
0024 </sect1>