Skip to main content
Skip table of contents

Configure z/IRIS Clients

Created: | Updated:


ziris.comm.config

This file controls the SMF streaming from the z/OS Client. Users must decide whether Kafka or TCP should be used and apply the relevant configuration to the $APP_HOME/lib/ziris.comm.config file as required.

Required properties

Property

Description

Valid Values

Default

mode

The technology that must be used to stream SMF records.

  • kafka
    Stream SMF using a Kafka Producer

  • tcp
    Stream SMF using a TCP Connection

No default.

kafkatopic

An existing Kafka topic to receive SMF records from the z/OS Client.

Required when mode=kafka

An existing Kafka topic.

No default.

host

The host network addresses for SMF record streaming.

A valid network host name and port.

  • If mode=tcp, host is required and refers to the IronTap network address.

  • If mode=kafka , host refers to a comma separated list of Kafka bootstrap servers.

This property overwrites the bootstrap.servers property (if any) in the producer.properties file linked by the kafkaconfig parameter.

No default.

inmem

Defines which active SMF in-memory resources z/IRIS will read SMF records from. Multiple SMF in-memory resources can be specified in a comma separated list.

One or multiple active SMF in-memory resources.

No default.

Example required properties

CODE
mode=kafka
host=kafka.mycompany.com:1337
imem=SMF.INMEM.CICS,SMF.INMEM.ZCON
kafkatopic=ziris


Optional parameters and options

Property

Description

Valid Values

Default

ssl

Enables encrypted TCP communication.

Only applies when mode=tcp.

  • y or yes
    Enable encryption

  • n or no
    Disable encryption

no

kafkaconfig

Links an alternate Kafka producer.properties file.

Only applies when mode=kafka.

A valid absolute path to a producer.properties file

$APP_HOME/kafka/default-ziris-producer.properties

timeout

Defines the number of seconds a TCP request will wait for acknowledgment from the IronTap server.

Only applies when mode=tcp.

A numeric value from 0 to 2147483647

10

reconnect

Defines the number of seconds to wait before reconnecting after a timeout exception occurs.

A numeric value from 0 to 2147483647

7

monitor.thruput.interval

Defines an interval in seconds at which communication metrics will be logged.

Only applies when com.msc.zos.ziris=FINE is specified in $APP_HOME/lib/logging.properties

A numeric value from 5 to 3600

60

Example with optional properties

CODE
mode=kafka
host=kafka.mycompany.com:1337
imem=IFASMF.SYSP.INMEM.CICS,IFASMF.SYSP.INMEM.ZCON
kafkatopic=ziris                                             
timeout=7                                                              
reconnect=7
monitor.thruput.interval=5                                                             
alias=alias_name

Additional considerations when mode=kafka

Default Kafka producer properties 

The installation package contains default properties for z/IRIS clients in the following file:

$APP_HOME/kafka/default-ziris-producer.properties

Custom Kafka producer properties

Avoid customizing default-ziris-producer.properties as this may be overwritten by z/IRIS software updates.

Create a new producer.properties file :

  1. Copy the sample producer properties file in the $KAFKA_HOME/config directory.

  2. Edit the properties as required.

  3. Specify the new producer properties path and file name in the ziris.comm.config file using the kafkaconfig parameter.

For more information about required properties for z/IRIS SMF streaming, see Apache Kafka - Configuration Guide.


Workload manager considerations

The z/IRIS client can be configured as a discretionary workload in WLM. This prevents zIIP workloads from being offloaded to general purpose processors. 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.