API Log
API Log contains records about all requests via Application Programming Interface (API) to the System from external clients or from internal cron procedures. It is possible to use filters to select necessary records.
- Created At
- Date and time of request.
- Request ID
- Unique identifier assigned to each API request, used for correlating log entries with application traces. Can be provided by the client via the
X-Request-IdHTTP header; otherwise generated automatically. - Status
- Status of operation (HTTP-response code).
- Remote IP
- IP address of the client that made the API request.
- Method
- HTTP-request (PUT, GET, POST, DELETE) method that was used for this API-request.
- Path
- Relative path to requested procedure.
- DB Duration
- Duration (in milliseconds) of processing request by Database.
- Page Duration
- Total response time (in milliseconds).
- Controller
- Controller that is contained procedure that was requested.
- Action
- Name of requested procedure.
- Tags
- Static labels attached to every API log entry on this instance, configured via the
api_log_tagsoption inyeti_web.yml. Useful for identifying the source instance when aggregating logs from multiple deployments. - Params
- Parameters that were sent with request.
- Meta
- Additional structured metadata recorded for the request (e.g. matched resource type and ID).
- Request Body
- Body of request in raw format.
- Response Body
- Body of response in raw format.
- Request Headers
- Headers of request in raw format.
- Response Headers
- Headers of response in raw format.
WARNING
Fields Request Body, Response Body, Request Headers, Response Headers not logged by default. To enable writing this data - enable Debug in Api Log Configs configuration menu.