Transfer of Traffic Logs to Syslog
API traffic logs are configured here, on the Gateway environment's log connectors — they are not part of the SIEM streams. Audit, session, token and application events are forwarded from the SIEM & Log Forwarding page instead. Forwarding API traffic through the SIEM streams is planned for a later release.
You can provide centralized log management by transferring Apinizer traffic logs to a syslog server.
Overview
Syslog Connector configuration must be made from Gateway Environment settings for Apinizer traffic logs to be transferred to syslog.
Configuration
1. Syslog Connection Definition
Go to Administration > Connection Configurations > Syslog page and create a Syslog connection definition.
2. Gateway Environment Settings
Go to Gateway Environment settings and select Syslog Connector for traffic logs.
Select the Syslog connection definition created earlier.
Log Format
The data structure for traffic logs to be sent will be in JSON format and will include the following fields:
- id: Unique identifier of the log record
- timestamp: Timestamp when the request occurred
- apinizerCorrelationId: Correlation ID for the request
- environmentId: Environment identifier
- projectId: Project identifier
- apiProxyId: API Proxy identifier
- apiProxyName: API Proxy name
- httpRequestMethod: HTTP method
- httpRequestUrl: Request URL
- httpRequestRemoteAddress: Client IP address
- httpResponseStatusCode: Response status code
- timeTotal: Total processing time (ms)
Related Resources
- Syslog Integration
- System Logs Syslog Transfer
- Traffic Log Syslog Transfer — operations guide: Buffer byte ceiling, length-prefixed framing and rsyslog server-side settings for large records (request/response bodies in the hundreds of KB) and high volume.