Populating inputs
Following are the required and optional variables for the inputs.ev file that you use to configure the distributed gateway with OpenTelemetry.
Required Common Variables
| Parameter | Description | Options |
|---|---|---|
| ZAPM_LOG_LEVEL | The log level for the DG components | OFF FATAL ERROR WARN INFO DEBUG TRACE ALL |
| ZAPM_VERSION | The version of the DG components | Pre-filled with version of fix pack downloaded |
| KAFKA_VERSION | The version of the Kafka component | Pre-filled with version of fix pack downloaded |
| REDIS_VERSION | The version of the Redis component | Pre-filled with version of fix pack downloaded |
| DG_HOSTNAME | The hostname (Fully Qualified Domain Name) or IP address of the machine you are deploying the DG on | Example: mymachine.ibm.com |
| KAFKA_CLUSTER_ID | The ID used by the Kafka cluster | Defaults to 1 |
Required OTEL Variables
| Parameter | Description | Options |
|---|---|---|
| OTEL | Set to true if using an OTel collector | true or false |
| ZAPM_GRPC_COLLECTOR_ENDPOINT | The endpoint of your OTel collector | user input |
| ZAPM_HTTP_COLLECTOR_ENDPOINT | Enables HTTP or HTTPS connections to an OTel collector. | true or false |
Optional Security Variables
OTEL
| Parameter | Description | Options |
|---|---|---|
| ZAPM_OTEL_COLLECTOR_CERT_NAME | Name of the certificate used to connect to otel backend | example: certificate1.pem |
| ZAPM_OTEL_COLLECTOR_CERT_PATH | Local path of the certificate file | example: /root/certs |
Redis
| Parameter | Description | Options |
|---|---|---|
| ZAPM_REDIS_PASSWORD | Set if using a password for Redis | user input |
DG TLS
| Parameter | Description | Options |
|---|---|---|
| TLS | True if using TLS from zOS to DG. Fill out tls.yml | true or false |
| KAFKA_TRUSTSTORE_PATH | File path to kafka truststore | user input |
| KAFKA_TRUSTSTORE_PASSWORD | Password for kafka truststore | user input |
| KAFKA_KEYSTORE_PATH | File path to kafka keystore | user input |
| KAFKA_KEYSTORE_PASSWORD | Password for kafka keystore | user input |
| CONNECTION_MANAGER_TRUSTSTORE_LOCATION | File path to connection manager truststore | user input |
| CONNECTION_MANAGER_TRUSTSTORE_PASSWORD | Password for connection manager truststore | user input |
| CONNECTION_MANAGER_KEYSTORE_LOCATION | File path to connection manager keystore | user input |
| CONNECTION_MANAGER_KEYSTORE_PASSWORD | Password for connection manager keystore | user input |