server-tools/slow_statement_logger/README.rst

=========================
Slow SQL Statement Logger
=========================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
    :target: https://github.com/OCA/server-tools/tree/12.0/slow_statement_logger
    :alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-slow_statement_logger
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
    :target: https://runbot.odoo-community.org/runbot/149/12.0
    :alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5| 

This module lets you log slow SQL statements. It is useful when you don't have
access to the PostgreSQL log or when it is difficult to correlate the
PostgreSQL log with the Odoo log.

.. warning::

    This module may leak confidential data in the log, in a similar way
    to Odoo's ``--log-level=debug_sql`` option. Use with care.

**Table of contents**

.. contents::
   :local:

Usage
=====

Add ``slow_statement_logger`` to Odoo's ``--load`` command line option, or to the
``server_wide_modules`` configuration file entry.

Add a ``log_min_duration_statement`` entry in the ``options`` section of your
Odoo configuration file. Statements running at least this number of
milliseconds will be logged with a *debug* level in the
``odoo.addons.slow_statement_logger`` logger. ``0`` means all statements will be
logged. ``-1`` disables this logging. You can also set an environment variable
``ODOO_LOG_MIN_DURATION_STATEMENT`` which will have priority over the
configuration file entry.

Add ``odoo.addons.slow_statement_logger:DEBUG`` in your ``log_handler``
configuration file entry or ``--log-handler`` command line option.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
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 <https://github.com/OCA/server-tools/issues/new?body=module:%20slow_statement_logger%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* ACSONE SA/NV

Contributors
~~~~~~~~~~~~

* stephane.bidoul@acsone.eu

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/slow_statement_logger>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.