API Log

api_log · OCA/rest-framework

    Repository
    OCA/rest-framework · module folder · Try on Runboat
    Module version
    1.0.1
    Category
    Tools
    Folder size
    0.06 MB
    License
    AGPL-3
    Application
    No
    Auto-installable
    No
    Website
    https://github.com/OCA/rest-framework
    Last tracking update
    2026-08-07 08:42:49
    Authors
    Akretion, Odoo Community Association (OCA)
    Maintainers
    Akretion, Odoo Community Association (OCA)
    Committers
    Weblate, Florian Mounier, OCA-git-bot, oca-ci, Alessandro Pecchini
    Odoo dependencies
    odoo/odoo:
    - web
    - base
    Python dependencies
    None
    System dependencies
    None
    Required by
    api_log_mail, fastapi_log
    Description
    This module allows to store request and response logs for any API.

When a response is logged, the header `API_LOG_ENTRY_ID` is injected in the response header.
This header stores the identifier of the log record produced from the response.

    Code Analysis ⓘ

    Views touched (3)
    XML IDNameModelTypeStatus
    api_log_view_form api.log.form api.log form New
    api_log_view_search api.log.search api.log search New
    api_log_view_tree api.log.list api.log list New
    HTTP endpoints (0)

    No HTTP endpoints found for this module.

    Models touched (2)

    New fields (28)
    • collection_id Integer
      compute='_compute_collection' index=True store=True
    • collection_model Char
      compute='_compute_collection' index=True store=True
    • collection_ref Reference
      selection='_selection_collection_ref'
    • name Char
      compute='_compute_name' store=True
    • referrer Char
      compute='_compute_request_headers_derived' store=True
    • request_b64 Binary
      compute='_compute_request_b64' string='Request Content'
    • request_body Binary
      attachment=False
    • request_content_length Integer
      compute='_compute_request_headers_derived' store=True
    • request_content_type Char
      compute='_compute_request_headers_derived' store=True
    • request_date Datetime
      index=True
    • request_headers Json
    • request_headers_preview Text
      compute='_compute_headers_preview'
    • request_method Char
    • request_preview Text
      compute='_compute_request_preview'
    • request_time Float
    • request_url Char
    • response_b64 Binary
      compute='_compute_response_b64' string='Response Content'
    • response_body Binary
      attachment=False
    • response_content_length Integer
      compute='_compute_response_headers_derived' store=True
    • response_content_type Char
      compute='_compute_response_headers_derived' store=True
    • response_date Datetime
    • response_headers Json
    • response_headers_preview Text
      compute='_compute_headers_preview'
    • response_preview Text
      compute='_compute_response_preview'
    • response_status_code Integer
      index=True
    • response_time Float
    • stack_trace Text
    • time Float
      compute='_compute_time' store=True
    Public methods (3)
    • log_exception(self, exception)
    • log_request(self, request, override_log_values=None)
      @api.model
    • log_response(self, response)

    New fields (2)
    • log_ids One2many → api.log
      comodel_name='api.log' compute='_compute_log_ids' string='Logs'
    • log_requests Boolean
      help='Log requests in database.'
    Public methods (1)
    • action_logs(self)

    Loading…

    Loading…