Red Hat SummitChapter 128. KafkaBridgeSpec schema reference
Used in: KafkaBridge
Full list of KafkaBridgeSpec schema properties
Configures a Kafka Bridge cluster.
Configuration options relate to:
- Kafka cluster bootstrap address
- Security (encryption, authentication, and authorization)
- Consumer configuration
- Producer configuration
- HTTP configuration
128.1. Logging
Kafka Bridge has its own preconfigured loggers:
| Logger | Description | Default Level |
|---|---|---|
|
| Default logger for all classes | INFO |
|
|
All classes in the | INFO |
|
|
Uses | WARN |
|
|
Uses | WARN |
You can configure log levels directly for these loggers. For example:
apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
spec:
# ...
logging:
type: inline
loggers:
rootLogger.level: INFO
logger.ready.level: DEBUG
# ...You can also specify custom loggers for other operations:
-
createConsumer -
deleteConsumer -
subscribe -
unsubscribe -
poll -
assign -
commit -
send -
sendToPartition -
seekToBeginning -
seekToEnd -
seek -
openapi
Each operation maps to an API endpoint, defined according to the OpenAPI specification, and supports fine-grained logging via http.openapi.operation.<operation_id>.
For example, to set the logging level for the send operation logger:
apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
spec:
# ...
logging:
type: inline
loggers:
logger.send.name: http.openapi.operation.send
logger.send.level: DEBUG
# ...
Kafka Bridge uses the Apache log4j2 logger implementation. Use the logging property to configure loggers and logger levels.
You can set log levels using either the inline or external logging configuration types.
Specify loggers and levels directly in the custom resource for inline configuration:
Example inline logging configuration
apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
spec:
# ...
logging:
type: inline
loggers:
rootLogger.level: INFO
# enabling DEBUG for send operation
logger.send.name: http.openapi.operation.send
logger.send.level: DEBUG
# ...
Alternatively, you can reference an external ConfigMap containing a complete log4j2.properties file that defines your own log4j2 configuration, including loggers, appenders, and layout configuration:
Example external logging configuration
apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaBridge
spec:
# ...
logging:
type: external
valueFrom:
configMapKeyRef:
# name and key are mandatory
name: customConfigMap
key: log4j2.properties
# ...Garbage collector (GC)
Garbage collector logging can also be enabled (or disabled) using the jvmOptions property.
128.2. KafkaBridgeSpec schema properties
| Property | Property type | Description |
|---|---|---|
| replicas | integer |
The number of pods in the |
| image | string | The container image used for Kafka Bridge pods. If no image name is explicitly specified, the image name corresponds to the image specified in the Cluster Operator configuration. If an image name is not defined in the Cluster Operator configuration, a default value is used. |
| bootstrapServers | string | A list of host:port pairs for establishing the initial connection to the Kafka cluster. |
| tls | TLS configuration for connecting Kafka Bridge to the cluster. | |
| authentication |
| Authentication configuration for connecting to the cluster. |
| http | The HTTP related configuration. | |
| adminClient | Kafka AdminClient related configuration. | |
| consumer | Kafka consumer related configuration. | |
| producer | Kafka producer related configuration. | |
| resources | CPU and memory resources to reserve. | |
| jvmOptions | Currently not supported JVM Options for pods. | |
| logging | Logging configuration for Kafka Bridge. | |
| clientRackInitImage | string |
The image of the init container used for initializing the |
| rack | Configuration of the node label which will be used as the client.rack consumer configuration. | |
| enableMetrics | boolean | Enable the metrics for the Kafka Bridge. Default is false. |
| livenessProbe | Pod liveness checking. | |
| readinessProbe | Pod readiness checking. | |
| template |
Template for Kafka Bridge resources. The template allows users to specify how a | |
| tracing | The configuration of tracing in Kafka Bridge. |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}