You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

81 lines
2.6 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. =================================
  5. Audit Log - Track user operations
  6. =================================
  7. This module allows the administrator to log user operations performed on data
  8. models such as ``create``, ``read``, ``write`` and ``delete``. Furthermore
  9. it allows logging of custom methods.
  10. Usage
  11. =====
  12. Go to `Reporting / Audit / Rules` to subscribe rules. A rule defines which
  13. operations to log for a given data model:
  14. .. image:: /auditlog/static/description/rule.png
  15. Then, check logs in the `Reporting / Audit / Logs` menu. You can group them by
  16. user sessions, date, data model or HTTP requests:
  17. .. image:: /auditlog/static/description/logs.png
  18. Get the details:
  19. .. image:: /auditlog/static/description/log.png
  20. A scheduled action exists to delete logs older than 6 months (180 days)
  21. automatically but is not enabled by default.
  22. To activate it and/or change the delay, go to the
  23. `Configuration / Technical / Automation / Scheduled Actions` menu and edit the
  24. `Auto-vacuum audit logs` entry:
  25. .. image:: /auditlog/static/description/autovacuum.png
  26. During installation, a one-time script will migrate any existing data from the
  27. `audittrail` module (rules and logs).
  28. Known issues / Roadmap
  29. ======================
  30. * log only operations triggered by some users (currently it logs all users)
  31. Bug Tracker
  32. ===========
  33. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  34. In case of trouble, please check there if your issue has already been reported.
  35. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  36. `here <https://github.com/OCA/server-tools/issues/new?body=module:%20auditlog%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  37. Credits
  38. =======
  39. Contributors
  40. ------------
  41. * Sebastien Alix <sebastien.alix@osiell.com>
  42. * Holger Brunn <hbrunn@therp.nl>
  43. Images
  44. ------
  45. * Icon: built with different icons from the `Oxygen theme <https://en.wikipedia.org/wiki/Oxygen_Project>`_ (LGPL)
  46. Maintainer
  47. ----------
  48. .. image:: http://odoo-community.org/logo.png
  49. :alt: Odoo Community Association
  50. :target: http://odoo-community.org
  51. This module is maintained by the OCA.
  52. OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
  53. To contribute to this module, please visit http://odoo-community.org.