Child pages
  • KIP-721: Enable connector log contexts in Connect Log4j configuration
Skip to end of metadata
Go to start of metadata

Status

Current state: Approved

Discussion thread: here

Vote thread: here

JIRA: KAFKA-12484 - Getting issue details... STATUS

Release: 3.0.0

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

KIP-449 added connector contexts to the Connect worker's logs, but it did not enable this by default. Instead, added a comment to the Connect Log4J configuration file with instructions on how users can enable this feature. Since the next release of AK will be 3.0.0 and will be a major release, now is an appropriate time to enable this feature by default by change the connect-log4j.properties configuration file. 

Public Interfaces

The connect-log4j.properties configuration file shipped in the AK distribution currently includes the following lines:

Relevant section from the current connect-log4J.properties
# The `%X{connector.context}` parameter in the layout includes connector-specific and task-specific information
# in the log message, where appropriate. This makes it easier to identify those log messages that apply to a
# specific connector. Simply add this parameter to the log layout configuration below to include the contextual information.
#
connect.log.pattern=[%d] %p %m (%c:%L)%n
#connect.log.pattern=[%d] %p %X{connector.context}%m (%c:%L)%n

These lines will be changed to the following:

Proposed modified section from connect-log4J.properties
# The `%X{connector.context}` parameter in the layout includes connector-specific and task-specific information
# in the log messages, where appropriate. This makes it easier to identify those log messages that apply to a
# specific connector.
#
connect.log.pattern=[%d] %p %X{connector.context}%m (%c:%L)%n


Proposed Changes

No other changes are proposed.

Compatibility, Deprecation, and Migration Plan

KIP-449 did not make this change to the connect-log4j.properties file because it might cause unexpected and breaking changes to the format of the Connect worker logs. AK 3.0.0 is a major release and thus a good time to make this change. This will not affect users that fully define their own Log4J configuration.

Rejected Alternatives

None

  • No labels