Skip to main content
Skip table of contents

Getting Started with IronTap Configuration

Created , Updated


The basic configuration for Irontap can be divided into three areas:

  1. Mainframe system settings

  2. SMF source (e.g. Apache Kafka, TCP)

  3. Traces and metrics destination (e.g. APM tool, timeseries database)

1: Provide mainframe system settings

The necessary configuration values will be provided by your mainframe team.

The default time zone for all z/OS systems.

irontap.zos.global.time-zone:"Europe/Berlin"

A list of available time zone names can be found here.

To avoid problems with daylight saving time, we recommend using TZ database names.

The EBCDIC encoding of your SMF records.

irontap.zos.smf.ebcdic-codepage:"IBM1047"

A list of supported encodings can be found here.

2: Configure the SMF source

Kafka

The necessary configuration values will be provided by your Apache Kafka team.

The Topic used for z/IRIS SMF record streaming

irontap.sources.kafka.topicPattern:"ziris-smf-prod"

The Kafka consumer config

A minimal consumer config contains the bootstrap servers and a group ID.

irontap.sources.kafka.consumer.bootstrap.servers="kafkabroker1:port1,kafkabroker2:port2"

irontap.sources.kafka.consumer.bootstrap.group.id="ziris-irontap-prod"

3: Configure the Traces and Metrics destination

OpenTelemetry

A GRPC OTLP compatible endpoint (e.g. the OpenTelemetry Collector)

irontap.apm.otel.exporter.otlp.endpoint="172.10.10.1:4317"

Datadog

Events

Environment variable

The event URL

irontap.apm.datadog.events.site:"https://api.datadoghq.com/api/v1/events"

DD_SITE

Example for EU: https://app.datadoghq.eu

Example for US: https://app.datadoghq.com

Note that there are several site options for different regions.

The API key

irontap.apm.datadog.events.apiKey:null

DD_API_KEY

We recommend setting sensitive configuration parameters using environment variables. To enable environment variables, set null (without quotes) as the value of the configuration.

Traces

The agent traces ingestion HTTP endpoint

irontap.apm.datadog.agent.url:"http://localhost:8126/v0.3/traces"

Minimal Irontap configuration for Apache Kafka and OpenTelemetry

CODE
irontap.zos.global.time-zone: "CET"
irontap.zos.smf.ebcdic-codepage: "IBM1047"

irontap.sources.kafka.topicPattern="ziris-smf-prod"
irontap.sources.kafka.consumer.bootstrap.servers="boker1:9092,broker2:9092"
irontap.sources.kafka.consumer.group.id="ziris-irontap-prod"
   
irontap.apm.otel.exporter.otlp.endpoint="collector:4317"

Minimal Irontap configuration for Apache Kafka and Datadog

CODE
# Note: lines starting with a # are ignored
irontap.zos.global.time-zone: "CET"
irontap.zos.smf.ebcdic-codepage: "IBM1047"

irontap.sources.kafka.topicPattern="ziris-smf-prod"
irontap.sources.kafka.consumer.bootstrap.servers="boker1:9092,broker2:9092"
irontap.sources.kafka.consumer.group.id="ziris-irontap-prod"

# Datadog
## Traces
# irontap.apm.datadog.agent.url:"http://localhost:8126/v0.3/traces"
## Events
# Note: site and apiKey must be set to enable events
irontap.apm.datadog.events.site:"https://api.datadoghq.com/api/v1/events"
# recommended: set the DD_API_KEY environment variable before launching Irontap
#irontap.apm.datadog.events.apiKey:null

>> Configure IronTap container

>> Configure IronTap server

>> Configuring IronTap Datadog integration

JavaScript errors detected

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

If this problem persists, please contact our support.