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.

121 lines
4.0 KiB

7 years ago
7 years ago
  1. =========
  2. Audit Log
  3. =========
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/12.0/auditlog
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-auditlog
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module allows the administrator to log user operations performed on data
  25. models such as ``create``, ``read``, ``write`` and ``delete``.
  26. **Table of contents**
  27. .. contents::
  28. :local:
  29. Configuration
  30. =============
  31. Rules
  32. ~~~~~
  33. Go to `Settings / Technical / Audit / Rules` to subscribe rules. A rule defines
  34. which operations to log for a given data model.
  35. .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/rule.png
  36. Cleanup
  37. ~~~~~~~
  38. A scheduled action exists to delete logs older than 6 months (180 days)
  39. automatically but is not enabled by default.
  40. To activate it and/or change the delay, go to the
  41. `Configuration / Technical / Automation / Scheduled Actions` menu and edit the
  42. `Auto-vacuum audit logs` entry:
  43. .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/autovacuum.png
  44. Usage
  45. =====
  46. Check logs in the `Settings / Technical / Audit / Logs` menu. You can
  47. group them by user sessions, date, data model or HTTP requests:
  48. .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/logs.png
  49. Get the details:
  50. .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/auditlog/static/description/log.png
  51. Known issues / Roadmap
  52. ======================
  53. * Log only operations triggered by some users. Currently it logs all users.
  54. * Logging read operations does not work on all data models. Need investigation.
  55. Bug Tracker
  56. ===========
  57. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  58. In case of trouble, please check there if your issue has already been reported.
  59. If you spotted it first, help us smashing it by providing a detailed and welcomed
  60. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20auditlog%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  61. Do not contact contributors directly about support or help with technical issues.
  62. Credits
  63. =======
  64. Authors
  65. ~~~~~~~
  66. * ABF OSIELL
  67. Contributors
  68. ~~~~~~~~~~~~
  69. * Sebastien Alix <sebastien.alix@camptocamp.com>
  70. * Holger Brunn <hbrunn@therp.nl>
  71. * Holden Rehg <holdenrehg@gmail.com>
  72. Other credits
  73. ~~~~~~~~~~~~~
  74. * Icon: built with different icons from the `Oxygen theme <https://en.wikipedia.org/wiki/Oxygen_Project>`_ (LGPL)
  75. Maintainers
  76. ~~~~~~~~~~~
  77. This module is maintained by the OCA.
  78. .. image:: https://odoo-community.org/logo.png
  79. :alt: Odoo Community Association
  80. :target: https://odoo-community.org
  81. OCA, or the Odoo Community Association, is a nonprofit organization whose
  82. mission is to support the collaborative development of Odoo features and
  83. promote its widespread use.
  84. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/auditlog>`_ project on GitHub.
  85. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.