Initial commit: OCA Technical packages (595 packages)

This commit is contained in:
Ernad Husremovic 2025-08-29 15:43:03 +02:00
commit 2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions

View file

@ -0,0 +1,46 @@
# Server Action Logging
Odoo addon: server_action_logging
## Installation
```bash
pip install odoo-bringout-oca-server-tools-server_action_logging
```
## Dependencies
This addon depends on:
- base
## Manifest Information
- **Name**: Server Action Logging
- **Version**: 16.0.1.0.0
- **Category**: Hidden
- **License**: LGPL-3
- **Installable**: True
## Source
Based on [OCA/server-tools](https://github.com/OCA/server-tools) branch 16.0, addon `server_action_logging`.
## License
This package maintains the original LGPL-3 license from the upstream Odoo project.
## Documentation
- Overview: doc/OVERVIEW.md
- Architecture: doc/ARCHITECTURE.md
- Models: doc/MODELS.md
- Controllers: doc/CONTROLLERS.md
- Wizards: doc/WIZARDS.md
- Reports: doc/REPORTS.md
- Security: doc/SECURITY.md
- Install: doc/INSTALL.md
- Usage: doc/USAGE.md
- Configuration: doc/CONFIGURATION.md
- Dependencies: doc/DEPENDENCIES.md
- Troubleshooting: doc/TROUBLESHOOTING.md
- FAQ: doc/FAQ.md

View file

@ -0,0 +1,32 @@
# Architecture
```mermaid
flowchart TD
U[Users] -->|HTTP| V[Views and QWeb Templates]
V --> C[Controllers]
V --> W[Wizards Transient Models]
C --> M[Models and ORM]
W --> M
M --> R[Reports]
DX[Data XML] --> M
S[Security ACLs and Groups] -. enforces .-> M
subgraph Server_action_logging Module - server_action_logging
direction LR
M:::layer
W:::layer
C:::layer
V:::layer
R:::layer
S:::layer
DX:::layer
end
classDef layer fill:#eef8ff,stroke:#6ea8fe,stroke-width:1px
```
Notes
- Views include tree/form/kanban templates and report templates.
- Controllers provide website/portal routes when present.
- Wizards are UI flows implemented with `models.TransientModel`.
- Data XML loads data/demo records; Security defines groups and access.

View file

@ -0,0 +1,3 @@
# Configuration
Refer to Odoo settings for server_action_logging. Configure related models, access rights, and options as needed.

View file

@ -0,0 +1,3 @@
# Controllers
This module does not define custom HTTP controllers.

View file

@ -0,0 +1,5 @@
# Dependencies
This addon depends on:
- base

View file

@ -0,0 +1,4 @@
# FAQ
- Q: Which Odoo version? A: 16.0 (OCA/OCB packaged).
- Q: How to enable? A: Start server with --addon server_action_logging or install in UI.

View file

@ -0,0 +1,7 @@
# Install
```bash
pip install odoo-bringout-oca-server-tools-server_action_logging"
# or
uv pip install odoo-bringout-oca-server-tools-server_action_logging"
```

View file

@ -0,0 +1,12 @@
# Models
Detected core models and extensions in server_action_logging.
```mermaid
classDiagram
class ir_actions_server
```
Notes
- Classes show model technical names; fields omitted for brevity.
- Items listed under _inherit are extensions of existing models.

View file

@ -0,0 +1,6 @@
# Overview
Packaged Odoo addon: server_action_logging. Provides features documented in upstream Odoo 16 under this addon.
- Source: OCA/OCB 16.0, addon server_action_logging
- License: LGPL-3

View file

@ -0,0 +1,3 @@
# Reports
This module does not define custom reports.

View file

@ -0,0 +1,8 @@
# Security
This module does not define custom security rules or access controls beyond Odoo defaults.
Default Odoo security applies:
- Base user access through standard groups
- Model access inherited from dependencies
- No custom row-level security rules

View file

@ -0,0 +1,5 @@
# Troubleshooting
- Ensure Python and Odoo environment matches repo guidance.
- Check database connectivity and logs if startup fails.
- Validate that dependent addons listed in DEPENDENCIES.md are installed.

View file

@ -0,0 +1,7 @@
# Usage
Start Odoo including this addon (from repo root):
```bash
python3 scripts/nix_odoo_web_server.py --db-name mydb --addon server_action_logging
```

View file

@ -0,0 +1,3 @@
# Wizards
This module does not include UI wizards.

View file

@ -0,0 +1,42 @@
[project]
name = "odoo-bringout-oca-server-tools-server_action_logging"
version = "16.0.0"
description = "Server Action Logging - Module that provides a logging mechanism for server actions"
authors = [
{ name = "Ernad Husremovic", email = "hernad@bring.out.ba" }
]
dependencies = [
"odoo-bringout-oca-ocb-base>=16.0.0",
"requests>=2.25.1"
]
readme = "README.md"
requires-python = ">= 3.11"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Office/Business",
]
[project.urls]
homepage = "https://github.com/bringout/0"
repository = "https://github.com/bringout/0"
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[tool.hatch.metadata]
allow-direct-references = true
[tool.hatch.build.targets.wheel]
packages = ["server_action_logging"]
[tool.rye]
managed = true
dev-dependencies = [
"pytest>=8.4.1",
]

View file

@ -0,0 +1,89 @@
=====================
Server Action Logging
=====================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:2254942a035ac006528607919a5c1da6f646f101a7751a29dfd98dc3bbfeaadc
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/16.0/server_action_logging
: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-16-0/server-tools-16-0-server_action_logging
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module allows displaying logs when server actions are executed:
1. a log is generated as soon as an action starts
2. a log is generated if the action is completed without any exception being raised, and the log displays the duration (in seconds) of the action itself
3. if action's field ``Enable SQL Debug`` is set, queries are logged too during the action's execution
**Table of contents**
.. contents::
:local:
Usage
=====
To enable Odoo logs tracking the actions start and duration, you just need to install this module.
To track SQL queries during an action's execution, open the action form view and check field ``Enable SQL Debug``.
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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20server_action_logging%0Aversion:%2016.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
~~~~~~~
* Camptocamp
Contributors
~~~~~~~~~~~~
* Italo LOPES <italo.lopes@camptocamp.com>
* Silvio Gregorini <silvio.gregorini@camptocamp.com>
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/16.0/server_action_logging>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

View file

@ -0,0 +1 @@
from . import models

View file

@ -0,0 +1,15 @@
# Copyright 2024 Camptocamp (https://www.camptocamp.com).
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html)
{
"name": "Server Action Logging",
"summary": "Module that provides a logging mechanism for server actions",
"version": "16.0.1.0.0",
"category": "Hidden",
"website": "https://github.com/OCA/server-tools",
"author": "Camptocamp, Odoo Community Association (OCA)",
"license": "LGPL-3",
"data": ["views/ir_actions_server.xml"],
"installable": True,
"depends": ["base"],
}

View file

@ -0,0 +1,38 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * server_action_logging
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug"
msgstr "Enable SQL Debug"
#. module: server_action_logging
#: model:ir.model.fields,help:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug for this action"
msgstr "Enable SQL Debug for this action"
#. module: server_action_logging
#: model:ir.model,name:server_action_logging.model_ir_actions_server
msgid "Server Action"
msgstr "Serverska akcija"
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__smart_search
msgid "Smart Search"
msgstr "Pametna pretraga"

View file

@ -0,0 +1,41 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * server_action_logging
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-04-30 18:33+0000\n"
"PO-Revision-Date: 2024-04-30 18:33+0000\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug"
msgstr "Activer le débogage SQL"
#. module: server_action_logging
#: model:ir.model.fields,help:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug for this action"
msgstr "Activer le débogage SQL pour cette action"
#. module: server_action_logging
#: model:ir.model,name:server_action_logging.model_ir_actions_server
msgid "Server Action"
msgstr ""
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__smart_search
msgid "Smart Search"
msgstr ""

View file

@ -0,0 +1,41 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * server_action_logging
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2024-06-15 19:37+0000\n"
"Last-Translator: mymage <stefano.consolaro@mymage.it>\n"
"Language-Team: none\n"
"Language: it\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: Weblate 4.17\n"
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug"
msgstr "Abilita debug SQL"
#. module: server_action_logging
#: model:ir.model.fields,help:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug for this action"
msgstr "Abilita debug SQL per questa azione"
#. module: server_action_logging
#: model:ir.model,name:server_action_logging.model_ir_actions_server
msgid "Server Action"
msgstr "Azione server"
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__smart_search
msgid "Smart Search"
msgstr "Ricerca intelligente"

View file

@ -0,0 +1,41 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * server_action_logging
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-04-30 18:33+0000\n"
"PO-Revision-Date: 2024-04-30 18:33+0000\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug"
msgstr "Ativar depuração SQL"
#. module: server_action_logging
#: model:ir.model.fields,help:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug for this action"
msgstr "Ativar depuração SQL para esta ação"
#. module: server_action_logging
#: model:ir.model,name:server_action_logging.model_ir_actions_server
msgid "Server Action"
msgstr ""
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__smart_search
msgid "Smart Search"
msgstr ""

View file

@ -0,0 +1,38 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * server_action_logging
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,field_description:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug"
msgstr ""
#. module: server_action_logging
#: model:ir.model.fields,help:server_action_logging.field_ir_actions_server__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_ir_cron__enable_sql_debug
#: model:ir.model.fields,help:server_action_logging.field_nsca_check__enable_sql_debug
msgid "Enable SQL Debug for this action"
msgstr ""
#. module: server_action_logging
#: model:ir.model,name:server_action_logging.model_ir_actions_server
msgid "Server Action"
msgstr ""
#. module: server_action_logging
#: model:ir.model.fields,field_description:server_action_logging.field_ir_actions_server__smart_search
msgid "Smart Search"
msgstr ""

View file

@ -0,0 +1 @@
from . import ir_actions_server

View file

@ -0,0 +1,41 @@
# Copyright 2024 Camptocamp (https://www.camptocamp.com).
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html)
import logging
from odoo import fields, models
_logger = logging.getLogger(__name__)
class IrActionsServer(models.Model):
_inherit = "ir.actions.server"
enable_sql_debug = fields.Boolean(
string="Enable SQL Debug",
help="Enable SQL Debug for this action",
default=False, # Avoid too much log pollution
)
def run(self):
if self.env.context.get("server_action_run_with_logs"): # Avoid recursion
return super().run()
actions = self.with_context(server_action_run_with_logs=True)
odoo_sql_db_logger = logging.getLogger("odoo.sql_db")
odoo_sql_db_logger_level = odoo_sql_db_logger.level
odoo_sql_db_logger_has_debug = odoo_sql_db_logger.isEnabledFor(logging.DEBUG)
res = False
for act in actions:
force_sql_debug = not odoo_sql_db_logger_has_debug and act.enable_sql_debug
if force_sql_debug:
odoo_sql_db_logger.setLevel(logging.DEBUG)
subject = f"Action {act.display_name} ({act})"
_logger.info(f"{subject} started")
start = fields.Datetime.now()
res = act.run()
delta = (fields.Datetime.now() - start).total_seconds()
_logger.info(f"{subject} completed in {delta:.3f} seconds")
if force_sql_debug:
odoo_sql_db_logger.setLevel(odoo_sql_db_logger_level)
return res or False

View file

@ -0,0 +1,2 @@
* Italo LOPES <italo.lopes@camptocamp.com>
* Silvio Gregorini <silvio.gregorini@camptocamp.com>

View file

@ -0,0 +1,7 @@
This module allows displaying logs when server actions are executed:
1. a log is generated as soon as an action starts
2. a log is generated if the action is completed without any exception being raised, and the log displays the duration (in seconds) of the action itself
3. if action's field ``Enable SQL Debug`` is set, queries are logged too during the action's execution

View file

@ -0,0 +1,2 @@
To enable Odoo logs tracking the actions start and duration, you just need to install this module.
To track SQL queries during an action's execution, open the action form view and check field ``Enable SQL Debug``.

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View file

@ -0,0 +1,436 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>Server Action Logging</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
Despite the name, some widely supported CSS2 features are used.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: gray; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic, pre.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="server-action-logging">
<h1 class="title">Server Action Logging</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:2254942a035ac006528607919a5c1da6f646f101a7751a29dfd98dc3bbfeaadc
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/16.0/server_action_logging"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-server_action_logging"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-tools&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module allows displaying logs when server actions are executed:</p>
<ol class="arabic simple">
<li>a log is generated as soon as an action starts</li>
<li>a log is generated if the action is completed without any exception being raised, and the log displays the duration (in seconds) of the action itself</li>
<li>if actions field <tt class="docutils literal">Enable SQL Debug</tt> is set, queries are logged too during the actions execution</li>
</ol>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
<p>To enable Odoo logs tracking the actions start and duration, you just need to install this module.
To track SQL queries during an actions execution, open the action form view and check field <tt class="docutils literal">Enable SQL Debug</tt>.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<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.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20server_action_logging%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
<ul class="simple">
<li>Camptocamp</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
<ul class="simple">
<li>Italo LOPES &lt;<a class="reference external" href="mailto:italo.lopes&#64;camptocamp.com">italo.lopes&#64;camptocamp.com</a>&gt;</li>
<li>Silvio Gregorini &lt;<a class="reference external" href="mailto:silvio.gregorini&#64;camptocamp.com">silvio.gregorini&#64;camptocamp.com</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
<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>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/16.0/server_action_logging">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</body>
</html>

View file

@ -0,0 +1 @@
from . import test_server_action_logging

View file

@ -0,0 +1,101 @@
import logging
from odoo.tests.common import TransactionCase
class TestServerActionLogging(TransactionCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True))
cls.action_no_sql_log = cls.env["ir.actions.server"].create(
{
"name": "Test Action w/o SQL Logging",
"enable_sql_debug": False,
"state": "code",
"model_id": cls.env.ref("base.model_res_users").id,
"model_name": "res.users",
"code": "model.sudo().search([]).read(['name', 'login'])",
}
)
cls.action_with_sql_log = cls.env["ir.actions.server"].create(
{
"name": "Test Action w/ SQL Logging",
"enable_sql_debug": True,
"state": "code",
"model_id": cls.env.ref("base.model_res_users").id,
"model_name": "res.users",
"code": "model.sudo().search([]).read(['name', 'login'])",
}
)
cls.action_with_error = cls.env["ir.actions.server"].create(
{
"name": "Test Action w/ Error",
"enable_sql_debug": False,
"state": "code",
"model_id": cls.env.ref("base.model_res_users").id,
"model_name": "res.users",
"code": "model.sudo().search([]).read(['invalid_field'])",
}
)
cls.log_action = logging.getLogger(
"odoo.addons.server_action_logging.models.ir_actions_server"
)
cls.log_sql_db = logging.getLogger("odoo.sql_db")
def setUp(self):
super().setUp()
# Odoo logger may be disabled for level ``logging.INFO`` when running tests
if not self.log_action.isEnabledFor(logging.INFO):
self.log_action.setLevel(logging.INFO)
def test_00_log_action_timing(self):
"""Tests Odoo logs while running an action"""
self.assertTrue(self.log_action.isEnabledFor(logging.INFO))
self.assertFalse(self.log_sql_db.isEnabledFor(logging.DEBUG))
with self.assertLogs(self.log_action, logging.INFO) as log_action_watcher:
self.action_no_sql_log.run()
self.assertFalse(self.log_sql_db.isEnabledFor(logging.DEBUG))
logs = log_action_watcher.output
self.assertEqual(len(logs), 2)
self.assertEqual(
f"INFO:{self.log_action.name}:Action {self.action_no_sql_log.display_name}"
f" ({self.action_no_sql_log}) started",
logs[0],
)
self.assertIn(
f"INFO:{self.log_action.name}:Action {self.action_no_sql_log.display_name}"
f" ({self.action_no_sql_log}) completed in",
logs[1],
)
def test_01_log_action_sql_db(self):
"""Tests SQL logs while running an action"""
self.assertTrue(self.log_action.isEnabledFor(logging.INFO))
self.assertFalse(self.log_sql_db.isEnabledFor(logging.DEBUG))
with self.assertLogs(self.log_sql_db, logging.DEBUG) as log_sql_db_watcher:
# NB: ``self.assertLogs`` will automatically enable the ``logging.DEBUG``
# level for the ``odoo.sql_db`` logger, which would make it impossible to
# check whether the logging is dynamically enabled for actions which
# require it; therefore, we manually disable the logger before executing
# the action itself
self.log_sql_db.setLevel(logging.NOTSET)
self.action_with_sql_log.run()
self.assertFalse(self.log_sql_db.isEnabledFor(logging.DEBUG))
self.assertGreaterEqual(len(log_sql_db_watcher.output), 1)
def test_02_log_action_failure(self):
"""Tests Odoo logs while running an action that fails"""
self.assertTrue(self.log_action.isEnabledFor(logging.INFO))
self.assertFalse(self.log_sql_db.isEnabledFor(logging.DEBUG))
with self.assertLogs(self.log_action, logging.INFO) as log_action_watcher:
with self.assertRaises(ValueError):
self.action_with_error.run()
self.assertFalse(self.log_sql_db.isEnabledFor(logging.DEBUG))
logs = log_action_watcher.output
self.assertEqual(len(logs), 1)
self.assertEqual(
f"INFO:{self.log_action.name}:Action {self.action_with_error.display_name}"
f" ({self.action_with_error}) started",
logs[0],
)

View file

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<record id="ir_actions_server_form_inherit" model="ir.ui.view">
<field name="name">ir.actions.server.form.inherit</field>
<field name="model">ir.actions.server</field>
<field name="inherit_id" ref="base.view_server_action_form" />
<field name="arch" type="xml">
<xpath expr="//field[@name='state']" position="after">
<field name="enable_sql_debug" />
</xpath>
</field>
</record>
</odoo>