Configure IronTap server
Created: | Updated:
application.conf parameters and syntax
Properties are customizable to meet your environment requirements.
Module | Property | Description | Default value | Notes |
---|---|---|---|---|
irontap.zos | ||||
smf.ebcdic-codepage | The default EBCDIC encoding. | IBM1047 | ||
systems | An array of system ids and time zones. | Example of system specific timezone configuration
CODE
| ||
irontap.zos.global | ||||
time-zone | The default time zone for all z/OS systems. | CET | ||
clock.skew | Add the provided time skew offset to the timestamps of all created spans. | 0ms | Valid entry examples: 850ms, -2s | |
irontap.core | ||||
worker-threads | The number of threads for parallel SMF processing. | -1 | Choose the number of threads. A negative value will always result in using #cores -1 threads (at least 1). | |
logSmfDataOnError | An SMF parsing error will be logged including the whole SMF record. | true | ||
config.render-regex-mask | A regular expression used to remove secrets from the configuration log. | (?i).*?(token|password|secret|passphrase|keystore|truststore|jaas).*? | ||
irontap.sources.tcp | ||||
port | The listener port which the z/IRIS client uses to connect to z/IRIS IronTap. | |||
irontap.sources.kafka | ||||
topicPattern | A pattern describing the topics z/IRIS IronTap should consume. | smf | ||
consumer | Contains the Apache Kafka Consumer configuration provided by your Apache Kafka administrator. | default consumer config | ||
irontap.storage.metrics.influxdb2 | ||||
bucket | The InfluxDB bucket to be used for z/IRIS metrics | |||
org | The InfluxDB organization | |||
url | The url to your InfluxDB or InfluxDB receiver | |||
authenticateToken | A token with write permissions within the organization |
Configuration can also be customized via the command-line. | ||
Example configuration
JSON
| ||||
irontap.db2.telemetry | ||||
datadog.trace.id.format | Specifies if the Datadog trace ID format should be used for DB2 telemetry. Enable to make trace ID searchable in Datadog. | false | false = 128 bit hexadecimal number true = 64 bit decimal number | |
irontap.zos.connect.telemetry | ||||
measurement.prefix | The prefix used for z/OS Connect measurements. | zos.connect | ||
irontap.zos.rmf.telemetry | ||||
measurement.prefix | The prefix used for RMF measurements. | zos.rmf | ||
irontap.zos.mq.telemetry | ||||
measurement.prefix | The prefix used for MQ measurements. | zos.mq | ||
irontap.correlation | ||||
mode | To enable correlation set this value to SINGLE. | NONE | SINGLE, CLUSTER or NONE | |
correlator-storage-size | The maximum amount of correlation information kept in memory. | 100000 |
| |
max-active-correlations | The maximum amount of active correlations. | 4096 |
| |
irontap.cluster.kcache | ||||
| ||||
db2.to.zcon.forwarded | Any KCache configuration property can be specified after forwarded. It will be passed to the KCache instance for the DB2 to z/OS Connect correlation. | |||
db2.to.zcon.forwarded.kafkacache.bootstrap.servers | A list of host and port pairs that is forwarded to KCache for establishing a connection to Kafka. This Kafka cache instance is used to correlate DB2 with z/OS Connect spans. | localhost:9092 | Examples for two servers: "IP:PORT,IP:PORT" | |
db2.to.zcon.forwarded.kafkacache.topic | A compacted Kafka topic used for the DB2 to z/OS Connect correlation. | ziris-cluster-db2-to-zcon | ||
db2.to.zcon.batch.size | The maximum number of cache entries batched together for the DB2 to z/OS Connect correlation. | 200 | ||
db2.to.zcon.drain.millis | The maximum number of milliseconds that is waited before a batch of entries is sent to Kafka while correlating DB2 to z/OS Connect spans. | 2000 | ||
sdsf.forwarded | Any KCache configuration property can be specified after forwarded. It will be passed to the KCache instance for the z/OS Work batch job correlation. | |||
sdsf.forwarded.kafkacache.bootstrap.servers | A list of host and port pairs that is forwarded to KCache for establishing a connection to Kafka. This Kafka cache instance is used to correlate z/OS Work batch job steps. | localhost:9092 | Examples for two servers: "IP:PORT,IP:PORT" | |
sdsf.forwarded.kafkacache.topic | A compacted Kafka topic used for the z/OS Work batch job correlation. | ziris-cluster-sdsf | ||
sdsf.batch.size | The maximum number of cache entries batched together for the z/OS Work batch job correlation. | 200 | ||
sdsf.drain.millis | The maximum number of milliseconds that is waited before a batch of entries is sent to Kafka while correlating z/OS Work batch job spans. | 2000 | ||
mq.to.cics.forwarded | Any KCache configuration property can be specified after forwarded. It will be passed to the KCache instance for the MQ to CICS correlation. | |||
mq.to.cics.forwarded.kafkacache.bootstrap.servers | A list of host and port pairs that is forwarded to KCache for establishing a connection to Kafka. This Kafka cache instance is used to correlate MQ with CICS spans. | localhost:9092 | Examples for two servers: "IP:PORT,IP:PORT" | |
mq.to.cics.forwarded.kafkacache.topic | A compacted Kafka topic used for the MQ to CICS correlation. | ziris-cluster-mq-to-cics | ||
mq.to.cics.batch.size | The maximum number of cache entries batched together for the MQ to CICS correlation. | 200 | ||
mq.to.cics.drain.millis | The maximum number of milliseconds that is waited before a batch of entries is sent to Kafka while correlating MQ to CICS spans. | 2000 | ||
distmq.to.mq.forwarded | Any KCache configuration property can be specified after forwarded. It will be passed to the KCache instance for the distributed MQ to MQ for z/OS correlation. | |||
distmq.to.mq.forwarded.kafkacache.bootstrap.servers | A list of host and port pairs that is forwarded to KCache for establishing a connection to Kafka. This Kafka cache instance is used to correlate distributed MQ with MQ for z/OS spans. | localhost:9092 | Examples for two servers: "IP:PORT,IP:PORT" | |
distmq.to.mq.forwarded.kafkacache.topic | A compacted Kafka topic used for the distributed MQ to MQ for z/OS correlation. | ziris-cluster-distmq-to-mq | ||
distmq.to.mq.batch.size | The maximum number of cache entries batched together for the distributed MQ to MQ for z/OS correlation. | 200 | ||
distmq.to.mq.drain.millis | The maximum number of milliseconds that is waited before a batch of entries is sent to Kafka while correlating distributed MQ to MQ for z/OS spans. | 2000 |
Example configuration
The example below overrides the default EBCDIC code page with IBM01140.
application.conf dot notation
irontap.zos.smf.ebcdic-codepage: "IBM01140"
application.conf JSON notation
irontap{
zos{
smf{
ebcdic-codepage: "IBM01140"
}
}
}