Skip to main content

Log Record Regions

Message information coming to and going from API Proxies defined on Apinizer is logged in Elasticsearch database according to message elements (header, parameter, body). These log record regions:

Request from Client

Request information coming from client to API Proxy

Request to Target

Request information sent from API Proxy to Backend API

Response from Target

Response information given from Backend API to API Proxy

Response to Client

Response information sent from API Proxy to client
By default, logging of fields in all message regions of the project is active. Logged fields can be restricted based on need or log server resource consumption. Log settings are managed on a project and environment (environment) basis through this screen.
For production environment, it is recommended to disable logging of elements belonging to the following regions.
  • From API Proxy to Backend API (Request to Target)
  • From Backend API to API Proxy (Response from Target)
If an API Proxy is running in production environment, it means that all policy settings and tests in the API Proxy are completed and no more development will be done.Therefore, to prevent excessive growth of data in the database, it is recommended not to write header, parameter, and body data in these two regions.
Even if all logging fields are closed, if an error occurs in the request, all log fields are recorded to detect the error. This feature can be opened and closed in general settings.
Due to variable data sizes and data formats, file parts of formdata requests are never logged. Only other metadata fields are logged.
Since WebSocket and gRPC requests are stored as data coming to Apinizer and data going out from Apinizer, there are only 2 regions in these types of API Proxies.
API Traffic Log Settings API Proxy-based log settings can be made on this screen. Additionally, if integration settings have been made, which API Proxies’ traffic records can be sent to these integration targets can also be configured. Log Settings Editing Dialog

Log Settings Fields

Fields used for log settings are shown in the table below.
FieldDescription
HeaderManages whether header information in the message is logged or not.
BodyManages whether body information in the message is logged or not.
ParameterManages whether parameter information in the message is logged or not.