Overview
The logs module is designed for centralized management of local client logs. An application can collect logs on mobile, Web, or desktop clients, upload each file to an accessible object URL, and then register the URL, platform, version, and extension metadata with OpenIM. Support teams can search these records from an administration or issue-reporting workflow.
This module does not expose OpenIM server runtime logs and does not receive log file contents directly. It manages indexes and metadata for client log files.
Capability scope
| Capability | Description |
|---|---|
| Upload logs | Register the URL and client environment metadata of a log file already collected and uploaded by your application. |
| Search logs | Search client log records by keyword, time range, and pagination. |
| Delete logs | Delete client log index records by log ID. |
Common APIs
Integration advice
Use these APIs in administration, customer support, and client issue-reporting workflows. Before registering a log, upload the file through the client or your file service and ensure that the URL is accessible to the OpenIM server.
Local logs can include device details, user environment data, and business context. Control log collection, user consent, retention, and access permissions in your product.
Related pages
Was this page helpful?