Kafka Log Push Plug-in

Overview

ROMA Connect can collect call logs of open APIs in APIC. This plug-in pushes API call logs to Kafka so that users can easily obtain them.

Constraints

An API can be bound to only one plug-in policy of the same type in the same environment. A plug-in policy that has been bound to an API cannot be deleted.
A maximum of five Kafka log push plug-ins can be created on a ROMA Connect instance.
In the log data to be pushed, the response data does not support Transfer Encoding response header parameters.
By default, a maximum of 4 KB of logs can be pushed. Excess logs will be truncated.
The request body and response body in pushed logs are calculated in UTF-8 bytes.

Parameter Description

**Table 1** Configuration parameters
Parameter	Description
Policy Information
Broker Addresses	Connection addresses of target Kafka brokers to which logs are to be pushed. Use commas (,) to separate multiple addresses.
Topic	Topic of the target Kafka to report logs to.
Key	Enter the key value of a message so that the message will be stored in a specified partition of Kafka. It can be used as an ordered message queue. If this parameter is left empty, messages are stored in different message partitions in a distributed manner.
Retry	Configuration for retrying when logs fail to be pushed to Kafka. Retry Times: the number of retry attempts in case of a failure. Enter 0 to 5. Retry Interval: the interval of retry attempts in case of a failure. Enter 1 to 10 seconds.
SASL Configuration
Security Protocol	Protocol used for connecting to the target Kafka. PLAINTEXT: user authentication protocol of the default access point. SASL_PLAINTEXT: SASL user authentication protocol. SASL_SSL: SSL user authentication protocol.
Message Tx/Rx Mechanism	Message transmission and receiving mechanism of the target Kafka. The default value is PLAIN.
SASL Username	Mandatory for Security Protocol set to SASL_PLAINTEXT or SASL_SSL. Username used for SASL or SSL authentication.
SASL Password	Mandatory for Security Protocol set to SASL_PLAINTEXT or SASL_SSL. Password used for SASL or SSL authentication.
Certificate Content	Available for Security Protocol set to SASL_SSL. CA certificate used for SSL authentication.
Metadata Configuration
System Metadata	System fields that need to be carried in pushed logs. By default, the start_time, request_id, client_ip, request_time, http_status, scheme, request_method, host, uri, upstream_addr, upstream_status, upstream_response_time, http_x_forwarded_for, http_user_agent, and error_type fields are carried in logs. You can also specify other system fields that need to be included.
Request Data	API request information that needs to be carried in the pushed logs. The log contains the request header: Specify a header that needs to be included. Use commas (,) to separate multiple fields. The asterisk () can be used as a wildcard. The log contains the request QueryString: Specify a query string that needs to be included. Use commas (,) to separate multiple fields. The asterisk () can be used as a wildcard. The log contains the request body: If this option is selected, logs will contain the body of API requests.
Response Data	API response information that needs to be included in pushed logs. The log contains the response header: Specify a header that needs to be included. Use commas (,) to separate multiple fields. The asterisk () can be used as a wildcard. The log contains the response body*: If this option is selected, logs will contain the body of API request responses.
Custom Authentication	Custom authentication information that needs to be included in pushed logs. Frontend: Enter a response field of frontend authentication that needs to be included. Separate multiple fields with commas (,). Backend: Enter a response field of backend authentication that needs to be included. Separate multiple fields with commas (,).