OCA
/
server-tools
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

[UPD] README.rst

12.0-mig-module_prototyper_last
OCA-git-bot 4 years ago
parent
7920473e26
commit
2e38043f27
2 changed files with 63 additions and 42 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 37
      auditlog/README.rst
  2. 68
      auditlog/static/description/index.html

37
auditlog/README.rst
View File

@ -33,22 +33,19 @@ models such as ``create``, ``read``, ``write`` and ``delete``.
.. contents:: .. contents::
:local: :local:
Usage
=====
Configuration
=============
Rules
~~~~~
Go to `Settings / Technical / Audit / Rules` to subscribe rules. A rule defines Go to `Settings / Technical / Audit / Rules` to subscribe rules. A rule defines
which operations to log for a given data model. which operations to log for a given data model.
.. image:: https://raw.githubusercontent.com/auditlog/static/description/rule.png
Then, check logs in the `Settings / Technical / Audit / Logs` menu. You can
group them by user sessions, date, data model or HTTP requests:
.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/rule.png
.. image:: https://raw.githubusercontent.com/auditlog/static/description/logs.png
Get the details:
.. image:: https://raw.githubusercontent.com/auditlog/static/description/log.png
Cleanup
~~~~~~~
A scheduled action exists to delete logs older than 6 months (180 days) A scheduled action exists to delete logs older than 6 months (180 days)
automatically but is not enabled by default. automatically but is not enabled by default.
@ -56,13 +53,25 @@ To activate it and/or change the delay, go to the
`Configuration / Technical / Automation / Scheduled Actions` menu and edit the `Configuration / Technical / Automation / Scheduled Actions` menu and edit the
`Auto-vacuum audit logs` entry: `Auto-vacuum audit logs` entry:
.. image:: https://raw.githubusercontent.com/auditlog/static/description/autovacuum.png
.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/autovacuum.png
Usage
=====
Check logs in the `Settings / Technical / Audit / Logs` menu. You can
group them by user sessions, date, data model or HTTP requests:
.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/logs.png
Get the details:
.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/log.png
Known issues / Roadmap Known issues / Roadmap
====================== ======================
* log only operations triggered by some users (currently it logs all users)
* log read operations does not work on all data models, need investigation
* Log only operations triggered by some users. Currently it logs all users.
* Logging read operations does not work on all data models. Need investigation.
Bug Tracker Bug Tracker
=========== ===========

68
auditlog/static/description/index.html
View File

@ -373,46 +373,58 @@ models such as <tt class="docutils literal">create</tt>, <tt class="docutils lit
<p><strong>Table of contents</strong></p> <p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents"> <div class="contents local topic" id="contents">
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id7">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a><ul>
<li><a class="reference internal" href="#rules" id="id2">Rules</a></li>
<li><a class="reference internal" href="#cleanup" id="id3">Cleanup</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id4">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id5">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id8">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id10">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="id11">Maintainers</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<div class="section" id="rules">
<h2><a class="toc-backref" href="#id2">Rules</a></h2>
<p>Go to <cite>Settings / Technical / Audit / Rules</cite> to subscribe rules. A rule defines <p>Go to <cite>Settings / Technical / Audit / Rules</cite> to subscribe rules. A rule defines
which operations to log for a given data model.</p> which operations to log for a given data model.</p>
<img alt="https://raw.githubusercontent.com/auditlog/static/description/rule.png" src="https://raw.githubusercontent.com/auditlog/static/description/rule.png" />
<p>Then, check logs in the <cite>Settings / Technical / Audit / Logs</cite> menu. You can
group them by user sessions, date, data model or HTTP requests:</p>
<img alt="https://raw.githubusercontent.com/auditlog/static/description/logs.png" src="https://raw.githubusercontent.com/auditlog/static/description/logs.png" />
<p>Get the details:</p>
<img alt="https://raw.githubusercontent.com/auditlog/static/description/log.png" src="https://raw.githubusercontent.com/auditlog/static/description/log.png" />
<img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/rule.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/rule.png" />
</div>
<div class="section" id="cleanup">
<h2><a class="toc-backref" href="#id3">Cleanup</a></h2>
<p>A scheduled action exists to delete logs older than 6 months (180 days) <p>A scheduled action exists to delete logs older than 6 months (180 days)
automatically but is not enabled by default. automatically but is not enabled by default.
To activate it and/or change the delay, go to the To activate it and/or change the delay, go to the
<cite>Configuration / Technical / Automation / Scheduled Actions</cite> menu and edit the <cite>Configuration / Technical / Automation / Scheduled Actions</cite> menu and edit the
<cite>Auto-vacuum audit logs</cite> entry:</p> <cite>Auto-vacuum audit logs</cite> entry:</p>
<img alt="https://raw.githubusercontent.com/auditlog/static/description/autovacuum.png" src="https://raw.githubusercontent.com/auditlog/static/description/autovacuum.png" />
<img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/autovacuum.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/autovacuum.png" />
</div>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id4">Usage</a></h1>
<p>Check logs in the <cite>Settings / Technical / Audit / Logs</cite> menu. You can
group them by user sessions, date, data model or HTTP requests:</p>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/logs.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/logs.png" />
<p>Get the details:</p>
<img alt="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/log.png" src="https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/log.png" />
</div> </div>
<div class="section" id="known-issues-roadmap"> <div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
<blockquote>
<h1><a class="toc-backref" href="#id5">Known issues / Roadmap</a></h1>
<ul class="simple"> <ul class="simple">
<li>log only operations triggered by some users (currently it logs all users)</li>
<li>log read operations does not work on all data models, need investigation</li>
<li>Log only operations triggered by some users. Currently it logs all users.</li>
<li>Logging read operations does not work on all data models. Need investigation.</li>
</ul> </ul>
</blockquote>
</div> </div>
<div class="section" id="bug-tracker"> <div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id6">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
@ -420,15 +432,15 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<p>Do not contact contributors directly about support or help with technical issues.</p> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<h1><a class="toc-backref" href="#id7">Credits</a></h1>
<div class="section" id="authors"> <div class="section" id="authors">
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<h2><a class="toc-backref" href="#id8">Authors</a></h2>
<ul class="simple"> <ul class="simple">
<li>ABF OSIELL</li> <li>ABF OSIELL</li>
</ul> </ul>
</div> </div>
<div class="section" id="contributors"> <div class="section" id="contributors">
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<h2><a class="toc-backref" href="#id9">Contributors</a></h2>
<ul class="simple"> <ul class="simple">
<li>Sebastien Alix &lt;<a class="reference external" href="mailto:sebastien.alix&#64;camptocamp.com">sebastien.alix&#64;camptocamp.com</a>&gt;</li> <li>Sebastien Alix &lt;<a class="reference external" href="mailto:sebastien.alix&#64;camptocamp.com">sebastien.alix&#64;camptocamp.com</a>&gt;</li>
<li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li> <li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li>
@ -436,13 +448,13 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</ul> </ul>
</div> </div>
<div class="section" id="other-credits"> <div class="section" id="other-credits">
<h2><a class="toc-backref" href="#id7">Other credits</a></h2>
<h2><a class="toc-backref" href="#id10">Other credits</a></h2>
<ul class="simple"> <ul class="simple">
<li>Icon: built with different icons from the <a class="reference external" href="https://en.wikipedia.org/wiki/Oxygen_Project">Oxygen theme</a> (LGPL)</li> <li>Icon: built with different icons from the <a class="reference external" href="https://en.wikipedia.org/wiki/Oxygen_Project">Oxygen theme</a> (LGPL)</li>
</ul> </ul>
</div> </div>
<div class="section" id="maintainers"> <div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
<h2><a class="toc-backref" href="#id11">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p> <p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose <p>OCA, or the Odoo Community Association, is a nonprofit organization whose

Write Preview
Loading…
Cancel
Save