Ghi nhật ký API Request
bởi Viindoo
| Số dòng Code | 962 |
| Tên kỹ thuật | viin_api_request_logger |
| Giấy phép | OPL-1 |
| Website | https://viindoo.com/apps/modules/19.0/viin_api_request_logger |
| Đọc mô tả cho | v 17.0 v 18.0 |
| Các mở rộng | Tích hợp Hóa đơn Điện tử Việt Nam Nền tảng định tuyến đa nhà cung cấp Viindoo Tích hợp Zalo OA |
What the API was asked, and what it answered
A log of API requests - method, payload, response status and headers - so an integration can be debugged from the system rather than from a customer's screenshot.
API Request Logger (technical name viin_api_request_logger) is an Odoo 19.0 app for Odoo Community and Odoo Enterprise and Viindoo Cloud, built for integrator, support, developer, administrator.
At a Glance
The facts of API Request Logger, version 0.1.2, in one place. Published by Viindoo.
How It Works
Two screens.
The requests
Endpoint, method and response status - the list a support engineer opens first.
One request
What was sent and what was answered, in full.
What You Get
A central log of API requests and their responses
Method, endpoint, payload, status and response headers
One row for a streamed call too
A mixin so a record can link to the last request that touched it
Readable by administrators, in the back office
Useful for debugging and for settling integration disputes
Nothing changes about how the API behaves
More Screens
Everything below was taken on a database seeded with real business data, on this series - not a mock-up and not a screenshot from an older version.
A request
What This App Does Not Do
Read this before you buy. Everything below is something the app deliberately leaves to another app or to you.
Re-sending a failed call is the integration's job.
Plan a retention policy - a busy API produces a lot of rows.
Restrict access accordingly; the model is administrator-facing on purpose.
It records requests that arrived, not the ones that never did.
Works Well With
Apps from the same stack, built to fit this one:
Who Should Use API Request Logger?
Integrator
Sees the request as it arrived, not as it was described.
Support
Answers whether a call reached the system.
Developer
Debugs from data instead of from a reproduction attempt.
Administrator
Keeps a trail of what external systems are doing.
Frequently Asked Questions
What does API Request Logger do?
A log of API requests - method, payload, response status and headers - so an integration can be debugged from the system rather than from a customer's screenshot.
What does API Request Logger not do?
It logs; it does not replay. Re-sending a failed call is the integration's job. Logs grow. Plan a retention policy - a busy API produces a lot of rows. Payloads may contain personal data. Restrict access accordingly; the model is administrator-facing on purpose. It does not monitor uptime. It records requests that arrived, not the ones that never did.
Who is API Request Logger for?
Integrator: Sees the request as it arrived, not as it was described. Support: Answers whether a call reached the system. Developer: Debugs from data instead of from a reproduction attempt. Administrator: Keeps a trail of what external systems are doing.
Which Odoo version and editions does it support?
Odoo 19.0 - Odoo Community, Odoo Enterprise, Viindoo Cloud. Upgrades to a newer Odoo series are a separate purchase for that series.
What does it depend on?
It installs on top of: base, bus. Odoo installs them with it.
How do I set it up?
Two screens.
What works well with it?
Expiring Tokens (to_token_expiration): The other half of API hygiene. Bank Connector (viin_bank_connector): An integration worth logging. Viindoo Base (to_base): The foundation layer.
Can I try it before buying?
Yes - the Live Preview button at the top of this page opens the module's own screen on a working database.
How do I get support?
Write to apps.support@viindoo.com with your Odoo version and the technical name viin_api_request_logger; pre-sales questions go to sales@viindoo.com.
See API Request Logger in Action
Live demo: v19demo-int.viindoo.com/web#action=viin_api_request_logger.action_api_request_log
Need help with API Request Logger?
For questions, implementation support or a custom feature, contact Viindoo.
Pre-Sales & Partnership
sales@viindoo.comUpgrades to a newer Odoo series are a separate purchase for that series.
All Viindoo apps: apps.odoo.com/apps/modules/browse?author=Viindoo
Technical Requirement
Changes log
0.1.2 - Latest on the 19.0 line
- A call whose answer arrives as a stream leaves exactly one log row, written when the stream ends - the body is handed to the caller chunk by chunk as it arrives instead of being swallowed to be logged, and the row records how many chunks and bytes came back, how the stream ended, and how long it took to the last chunk.
- A viewer mixin lets a record point at the last API request that touched it.
API Request Logger Documentation
Overview
The viin_api_request_logger module provides a framework for logging and monitoring API requests in Odoo. Designed for developers and administrators, it tracks all details of API interactions, including:
- User initiating the request
- Related model and record
- Request parameters, headers, and payload
- API response data and errors
- Request duration
Key Features
- Detailed Logging: Capture all request/response details, including errors.
- Secret-Safe Transport Logs: Sensitive header and query-string secrets are masked before being written to api.request.log.
- Error Monitoring: Automatically logs failed API requests for better debugging.
- Streaming-Aware Logging: A response consumed as a stream is passed through to the caller chunk by chunk and still leaves exactly one log row, written once the drain ends.
- Extensible Integration: Easily integrate with models using the provided mixins.
- User-Friendly API Log Viewer: Quickly access logs related to any model record.
- Customizable: Fully adaptable for specific business needs.
Installation
Install the module via the Odoo Apps interface or the command line:
odoo-bin -c <config_file> -i viin_api_request_logger
Configure user access rights to ensure secure access to logs.
Usage
Logging API Requests
To enable automatic logging for API requests, inherit the api.request.mixin in your model and use the make_request method. Here's an example:
class ExampleIntegration(models.AbstractModel): _name = 'example.integration' _inherit = 'api.request.mixin' def example_api_call(self): response = self.make_request( method="GET", url="https://api.example.com/data", headers={"Authorization": "Bearer <token>"}, params={"key": "value"}, res_model="example.model", res_id=1, ) return response.json()
Viewing API Logs
To allow users to view related logs, inherit the api.log.viewer.mixin in your model. This mixin provides:
- `last_api_request_log_id`: A computed field showing the most recent API log.
- `action_view_api_logs`: An action to display all related logs.
Example:
class ExampleModel(models.Model): _name = 'example.model' _inherit = 'api.log.viewer.mixin'
Logs can also be accessed via the "API Logs" menu in the Odoo interface.
Logging Guarantees
- request_headers always masks default sensitive headers such as Authorization and X-API-Key.
- request_url and name store the effective request URL, including query parameters expanded from params, with sensitive query-string values masked.
- Each outbound API call creates a single api.request.log record, including HTTP 4xx/5xx responses.
- Non-JSON responses fall back to raw response.text so HTML/plain-text vendor error pages still appear in the log.
- A call made with stream_response=True also creates exactly one api.request.log record. The body is never buffered to be logged: iter_lines is wrapped, each line is yielded straight to the caller, and the row is written when the drain finishes - on normal exhaustion, on an exception mid-drain, or on early abandonment.
- For a streamed call, response_data holds a summary rather than the body - how many chunks and how many bytes arrived, and whether the stream ended done, error or aborted - and duration measures time to the last chunk.
- Preparing or writing the row for a streamed call can never cost the caller its answer: a failure there is logged as a warning and never re-raised.
Customizing the Logger
Override _prepare_log_values to include custom fields in the log:
def _prepare_log_values(self, method, url, headers, data, response, duration, res_model=None, res_id=None, error_message=None): values = super()._prepare_log_values(method, url, headers, data, response, duration, res_model, res_id, error_message) values.update({"custom_field": "Custom Value"}) return values
Configuration
The module works out-of-the-box but can be extended for advanced configurations.
Advanced Scenarios
- Custom Headers: Use the headers parameter in make_request to add headers such as authentication tokens.
- Sensitive Query Parameters: Override _get_sensitive_query_param_keys() to mask provider-specific secret query parameters in logged URLs.
- Streamed Responses: Pass stream_response=True to make_request to receive the response un-drained (the requests library's own stream=True) and read it with iter_lines(). Log timing follows the drain, so read the body to completion where you can.
- API Monitoring: Leverage the response_headers and response_data fields to debug or analyze responses.
- Integration with External Tools: Export logs for use with monitoring tools like ELK Stack or Datadog.
Support
For assistance, please contact Viindoo support at https://viindoo.com.
Phần mềm này và các tệp liên kết ("Phần mềm") được sử dụng (chạy, tuỳ biến, chạy sau khi được tuỳ biến) chỉ khi bạn mua được giấy phép có hiệu lực từ tác giả, điển hình như qua các Ứng dụng Odoo, hoặc trong trường hợp bạn nhận được thoả thuận bằng văn bản từ tác giả của Phần mềm (chi tiết tại tệp COPYRIGHT).
Bạn có thể phát triển các phân hệ Odoo có sử dụng Phần mềm như một Thư viện (thường là phụ thuộc vào, nhập vào và sử dụng nguồn của nó) nhưng không sao chéo bất kỳ mã nguồn hay tài liệu nào thuộc Phần mềm. Bạn có thể phân phối những phân hệ này theo giấy phép mà bạn lựa chọn, miễn sao nội dung giấy phép đó tương tích với điều khoản của Giấy phép Phần mềm Độc quyền Odoo (ví dụ: LGPL, MIT hay bất kỳ loại giấy phép phần mềm độc quyền nào tương tự vậy).
Nghiêm cấm phát hành, phân phối, cấp phép lại hoặc bán bản sao của Phần mềm hoặc bản sao Phần mềm đã được sửa đổi.
Thông báo bản quyền và chấp thuận nêu trên buộc phải được bao gồm trong tất cả các bản sao hoặc các phần quan trọng của Phần mềm.
PHẦN MỀM ĐƯỢC CUNG CẤP "NGUYÊN TRẠNG", KHÔNG BẢO ĐẢM DƯỚI BẤT KỲ HÌNH THỨC NÀO, ĐƯỢC THỂ HIỆN RÕ RÀNG HOẶC NGỤ Ý, KHÔNG GIỚI HẠN ĐẢM BẢO VỀ CÁC BẢO ĐẢM NGỤ Ý VỀ KHẢ NĂNG THƯƠNG MẠI, PHÙ HỢP VỚI MỤC ĐÍCH CỤ THỂ VÀ KHÔNG VI PHẠM. TRONG MỌI TRƯỜNG HỢP SẼ KHÔNG CÓ TÁC GIẢ HOẶC CHỦ SỞ HỮU BẢN QUYỀN NÀO CHỊU TRÁCH NHIỆM VỀ BẤT KỲ KHIẾU NẠI, THIỆT HẠI HOẶC TRÁCH NHIỆM PHÁP LÝ KHÁC NÀO TRONG PHẠM VI HỢP ĐỒNG, CÁC THIỆT HẠI HOẶC CÁCH KHÁC, PHÁT SINH TỪ, NGOÀI HOẶC CÓ LIÊN KẾT VỚI PHẦN MỀM HOẶC VIỆC SỬ DỤNG HOẶC KINH DOANH KHÁC TẠI PHẦN MỀM.
