Transfer of Apinizer System Logs with Syslog
Go to Administration > Connection Configurations > Syslog page and create a Syslog connection definition. See Syslog Connection Management for detailed information.Transfer of Application Logs with Syslog
Go to Administration > System Settings > General Settings page and select Syslog Connector for application logs.
- id: Unique identifier of the log record.
- date: Date and time when the log occurred.
- level: Importance level of the log (e.g., “INFO”, “WARN”, “ERROR”, “DEBUG”).
- message: Main message of the log, text describing the event.
- stackTrace: In error situations, detailed stack trace showing the code path where the error occurred. Usually very long and critical for troubleshooting.
- hostName: Name of the machine where the Apinizer component producing the log runs.
- enumApplicationLog: Specifies which Apinizer module the log comes from (e.g., “MANAGER”, “GATEWAY”).
Transfer of Token Logs with Syslog
Go to Administration > System Settings > General Settings page and select Syslog Connector for token logs.
- id: Unique identifier of the log record.
- timestamp: Timestamp when the token event occurred.
- apinizerCorrelationId: Unique correlation ID used to track all operations related to this token request within Apinizer.
- environmentId: Unique identifier of the environment where the request was made.
- projectId: Unique identifier of the project to which the request belongs.
- applicationName: Name of the application related to the request (e.g., “Swagger Petstore Documentation”).
- apiProxyId: Unique identifier of the API Proxy associated with the token request.
- apiProxyName: Name of the associated API Proxy.
- httpRequestRemoteAddress: IP address of the client making the token request.
- httpRequestHttpMethod: HTTP method of the token request (usually “POST”).
- httpRequestContentType: Content type of the request (e.g., “application/x-www-form-urlencoded”).
- usernameOrKey: Username or client key requesting the token.
- timeTotal: Total duration of the token operation (ms).
- statusCode: HTTP status code of the token request (e.g., 200 Successful).
- resultType: Result of the token operation (e.g., “SUCCESS”, “ERROR”).
- audience: Target audience or resource for which the token is valid.
- clientInfo: Additional information about the client requesting the token (usually similar to usernameOrKey).
- issuedAt: Timestamp when the token was issued.
- refreshTokenAllowed: Whether refresh token is allowed for this operation (boolean).
- refreshTokenIssuedAt: Timestamp when the refresh token was issued.
- refreshCount: How many times the refresh token was used.
Transfer of Audit Logs to Syslog
Go to Administration > System Settings > General Settings page and select Syslog Connector for application logs.
- id: Unique identifier of the audit event.
- principal: Name of the user who performed the operation (e.g., “admin”).
- auditEventDate: Date and time when the audit event occurred.
- state: Type of operation performed (e.g., “CREATED”, “UPDATED”, “DELETED”).
- objectId: Unique identifier of the object (API, Policy, etc.) affected by the operation.
- objectName: Name of the object affected by the operation (e.g., “Swagger Petstore Documentation”).
- referenceObjectJson: Complete detailed JSON representation of the object after the operation. This field fully reflects the new state of the object and can usually be very long.
- projectId: Unique identifier of the project to which the relevant object belongs.
- className: Class/type name of the object affected by the operation within Apinizer (e.g., “ApiProxy”).