Skip to main content

Component-specific settings for tKafkaOutput

The following table describes the Job script functions and parameters that you can define in the setSettings {} function of the component.

Function/parameter Description Mandatory?

USE_EXISTING_CONNECTION

Set this parameter to true and specify the name of the relevant connection component using the CONNECTION parameter to reuse the connection details you already defined.

No

KAFKA_VERSION

Specify the version of the Kafka cluster to be used. Acceptable values:

  • KAFKA_0_10_0_1
  • KAFKA_0_9_0_1
  • KAFKA_0_8_2_0

Yes

BROKER_LIST

Specify the addresses of the broker nodes of the Kafka cluster to be used, in the form of "\"host1:port1,host2:port2,...\"".

Yes

KAFKA_TOPIC

Specify the name of the topic from which this component receives the feed of messages.

Yes

COMPRESS

Set this parameter to true to compress the output data, and specify the compression format using the COMPRESSION parameter:

  • GZIP: Perform Gzip compression on the output.
  • SNAPPY: Perform Snappy compression on the output.

No

USE_HTTPS

Set this parameter to true enable SSL or TLS encryption of the connection, and use the HTTPS_SETTING parameter to specify the tSetKeystore component that you use to define the encryption information.

This parameter works when the Kafka cluster version is Kafka 0.9.2.1 or higher.

No

USE_KRB

If the Kafka cluster to be used is secured with Kerberos, set this parameter to true and use the following parameters to define the related security information:

  • JAAS_CONF: specify the path to the JAAS configuration file to be used by the Job to authenticate as a client to Kafka.

  • KRB_SERVICE_NAME: specify the primary part of the Kerberos principal you defined for the brokers when creating the broker cluster.

    For example, for the principal kafka/kafka1.hostname.com@EXAMPLE.COM, the value of this parameter is kafka.

  • SET_KINIT_PATH: Kerberos uses a default path to its kinit executable. If you have changed this path, set this parameter to true and use the KINIT_PATH parameter to specify the custom access path.

  • SET_KRB5_CONF: Kerberos uses a default path to its configuration file, krb5.conf (or krb5.ini in Windows) for Kerberos 5 for example. If you have changed this path, set this parameter to true and use the KRB5_CONF to specify the custom access path to the Kerberos configuration file.

This parameter works when the Kafka cluster version is Kafka 0.9.2.1 or higher.

No

KAFKA_PRODUCER_PROPERTIES {}

If you need to use custom Kafka producer configuration, include in this function one or more sets of the following parameters to specify the property or properties to be customized. Then at runtime, the customized property or properties will override the corresponding ones used by the Studio.

  • PROPERTY: Type in the name of the property.
  • VALUE: Type in the new value of the property.

No

TSTATCATCHER_STATS

Set this parameter to true to gather the processing metadata at the Job level as well as at each component level.

By default, this parameter is set to false.

No

LABEL

Use this parameter to specify a text label for the component.

No

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here