Search 1.9 billion lines of Odoo code on GitHub
smile_log
<h1 class="title">Logging in database</h1>
<p><a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/tree/12.0/smile_log"><img alt="Smile-SA/odoo_addons" src="https://img.shields.io/badge/github-Smile_SA%2Fodoo_addons-lightgray.png?logo=github" /></a></p>
<p>This module adds a logs handler writing to database.</p>
<p>Notice</p>
<blockquote>
<ul class="simple">
<li><dl class="first docutils">
<dt>Following code will create a log in db with a unique pid per logger:</dt>
<dd>import logging
logger = SmileLogger(dbname, model_name, res_id, uid)
logger.info(your_message)</dd>
</dl>
</li>
</ul>
</blockquote>
<p>Features :</p>
<ul class="simple">
<li>Create logs when executing an action.</li>
<li>Archive and delete old logs from database.</li>
<li>Give users access right to see logs.</li>
</ul>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#gdpr-eu-privacy" id="id4">GDPR / EU Privacy</a></li>
<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
<li><a class="reference internal" href="#maintainer" id="id7">Maintainer</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<ul class="simple">
<li>Developer adds <code>import logging</code> to his python file.</li>
<li>Developer must add following code to his action and specify the database, the model name, the res_id, and uid. Then give a message to log for information:</li>
</ul>
<pre>
<code lang="python">logger = SmileLogger(dbname, model_name, res_id, uid)
logger.info(your_message)</code>
</pre>
<ul class="simple">
<li>Administrator must create a <code>Scheduled Action</code> to call the function <code>archive_and_delete_old_logs</code>, configure archiving path and the number of days to archive and delete logs.</li>
</ul>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<p>To add Logs handler to an action :</p>
<blockquote>
<ol class="arabic">
<li><p class="first">Import SmileDBLogger to your python code and add code lines as shown in following example :</p>
<blockquote>
<div class="figure">
<img alt="Import SmileDBLogger" src="static/description/inherit_and_import_smile_log.png" style="width: 600px;" />
</div>
</blockquote>
</li>
<li><p class="first">Add <code>smile_log</code> to your module dependence:</p>
<blockquote>
<div class="figure">
<img alt="Depends manifest" src="static/description/manifest.png" style="width: 500px;" />
</div>
</blockquote>
</li>
<li><p class="first">Now execute the action.:</p>
<blockquote>
<div class="figure">
<img alt="Button validate" src="static/description/action.png" style="width: 850px;" />
</div>
</blockquote>
</li>
<li><p class="first">Go to <code>Settings > Technical > Logging</code>> Logs menu to see logs.</p>
<blockquote>
<div class="figure">
<img alt="Logs" src="static/description/logs.png" style="width: 850px;" />
</div>
</blockquote>
</li>
</ol>
</blockquote>
<p>Administrator can give access right to users, to see logs, by checking <code>Smile Logs / User</code>.</p>
<blockquote>
<div class="figure">
<img alt="Smile Logs" src="static/description/smile_logs_user.png" style="width: 600px;" />
</div>
</blockquote>
<dl class="docutils">
<dt>To create the scheduled action:</dt>
<dd><ol class="first last arabic">
<li><p class="first">Go to <code>Settings > Technical > Automation > Scheduled Actions</code> and fill fields as follow:</p>
<blockquote>
<div class="figure">
<img alt="Schedules Action" src="static/description/scheduled_action.png" style="width: 850px;" />
</div>
<p><code>(Make sure that the given folder has a write access!)</code></p>
</blockquote>
</li>
<li><p class="first">After running the action, the extracted logs file in csv format is as shown in next figure:</p>
<blockquote>
<div class="figure">
<img alt="Smile Logs" src="static/description/exported_log.png" style="width: 380px;" />
</div>
</blockquote>
</li>
</ol>
</dd>
</dl>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
<a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues/new?body=module:%20smile_log%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="gdpr-eu-privacy"></a>
<h2><a class="toc-backref" href="#id4">GDPR / EU Privacy</a></h2>
<p>This addons does not collect any data and does not set any browser cookies.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id5">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id6">Authors</a></h3>
<ul class="simple">
<li>Corentin POUHET-BRUNERIE</li>
<li>Xavier FERNANDEZ</li>
<li>Majda EL MARIOULI</li>
</ul>
<a name="maintainer"></a>
<h3><a class="toc-backref" href="#id7">Maintainer</a></h3>
<p>This module is maintained by the Smile SA.</p>
<p>Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.</p>
<a class="reference external image-reference" href="http://smile.fr"><img alt="Smile SA" src="https://avatars0.githubusercontent.com/u/572339?s=200&v=4" /></a>
<p>This module is part of the <a class="reference external" href="https://github.com/Smile-SA/odoo_addons">odoo-addons</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>