Integration Executor configuration
HTTP server parameters
Section titled “HTTP server parameters”HTTP Server bind address.
HTTP Server bind port.
Kafka parameters
Section titled “Kafka parameters”Poll interval for messages from ‘tbmq.ie.downlink’ topics (in ms).
Poll interval for messages from ‘tbmq.msg.ie’ topics (in ms).
Timeout for processing a pack of messages (in ms).
Processing strategy for ‘tbmq.msg.ie’ topics. Accepted values: SKIP_ALL, RETRY_ALL.
Number of retries. Use 0 for unlimited. Applies to the RETRY_ALL strategy.
Time to wait in the consumer thread before retrying (in s).
List of Kafka bootstrap servers used to establish connection.
Enables or disables deletion of Kafka topics created for Integrations. When true, TBMQ may automatically remove topics during cleanup (e.g., when an Integration is deleted). When false, TBMQ skips topic deletion and simply stops using them, preventing accidental data loss in production environments.
Base Kafka properties applied to admins, all producers and consumers, making it the ideal place for shared connection and security settings. Format is key:value;key:value. If a property value contains a semicolon (common in sasl.jaas.config), escape it with a backslash (e.g., …username=“user”;password=“pass”;).
Additional Kafka properties specific only to consumers, merged with the global defaults — TB_KAFKA_DEFAULT_PRODUCER_CONSUMER_CONFIG (overriding them if keys conflict). Follows the standard key:value;key:value format. Ensure any internal semicolons in values are escaped as ;.
List of partition assignment strategy class names or types, ordered by preference, used to distribute partition ownership amongst consumer instances when group management is used.
Timeout for detecting client failures when using Kafka’s group management facility (in ms).
Maximum delay between invocations of poll() when using consumer group management (in ms).
Maximum number of records returned in a single call to poll().
Maximum amount of data per partition the server will return (in bytes).
Maximum amount of data the server should return for a fetch request (in bytes).
Expected time between heartbeats to the consumer coordinator when using Kafka’s group management facilities. Heartbeats ensure the consumer’s session stays active and facilitate rebalancing when consumers join or leave. Must be set lower than TB_KAFKA_DEFAULT_CONSUMER_SESSION_TIMEOUT_MS, but typically no higher than 1/3 of that value. Can be adjusted lower to control the expected time for normal rebalances (in ms). Defaults to 3 s.
Additional Kafka properties specific only to producers, merged with the global defaults — TB_KAFKA_DEFAULT_PRODUCER_CONSUMER_CONFIG (overriding them if keys conflict). Follows the standard key:value;key:value format. Ensure any internal semicolons in values are escaped as ;.
Number of acknowledgments the producer requires the leader to have received before considering a request complete.
Number of retries for records whose send fails with a potentially transient error.
Batch size for grouping records sent to the same partition (in bytes).
Delay for grouping records arriving between request transmissions into a batched request (in ms).
Total memory the producer can use to buffer records waiting to be sent to the server (in bytes).
Compression type for all data generated by the producer. Accepted values: none, gzip, snappy, lz4, zstd.
Additional configs separated by semicolon for the admin Kafka client, merged with the global defaults — TB_KAFKA_DEFAULT_PRODUCER_CONSUMER_CONFIG (overriding them if keys conflict).
Kafka Admin client command timeout (in s). Applies to operations like describeCluster, listTopics, etc.
Kafka topics cache TTL (in ms). Defines how long the list of topics is kept in memory before reloading from Kafka. Defaults to 5 minutes.
Enables or disables printing of consumer group lag between consumer offsets and the latest Kafka topic offsets.
Print interval for Kafka consumer group statistics (in ms).
Time to wait for stats-loading requests to Kafka to finish (in ms).
Additional configs separated by semicolon for the Kafka stats consumer, merged with the consumer defaults — TB_KAFKA_DEFAULT_CONSUMER_CONFIG (overriding them if keys conflict).
Prefix for topics used to send integration configurations and validation requests from TBMQ to integration executors.
Kafka topic properties separated by semicolon for the tbmq.ie.downlink.http topic.
Additional Kafka consumer configs separated by semicolon for the tbmq.ie.downlink.http topic.
Additional Kafka producer configs separated by semicolon for the tbmq.ie.downlink.http topic.
Kafka topic properties separated by semicolon for the tbmq.ie.downlink.kafka topic.
Additional Kafka consumer configs separated by semicolon for the tbmq.ie.downlink.kafka topic.
Additional Kafka producer configs separated by semicolon for the tbmq.ie.downlink.kafka topic.
Kafka topic properties separated by semicolon for the tbmq.ie.downlink.mqtt topic.
Additional Kafka consumer configs separated by semicolon for the tbmq.ie.downlink.mqtt topic.
Additional Kafka producer configs separated by semicolon for the tbmq.ie.downlink.mqtt topic.
Topic for sending messages and events from integration executors to TBMQ.
Kafka topic properties separated by semicolon for the tbmq.ie.uplink topic.
Additional Kafka consumer configs separated by semicolon for the tbmq.ie.uplink topic.
Additional Kafka producer configs separated by semicolon for the tbmq.ie.uplink topic.
Prefix for topics used to send notifications or replies from integration executors to specific TBMQ nodes.
Kafka topic properties separated by semicolon for the tbmq.ie.uplink.notifications topics.
Additional Kafka consumer configs separated by semicolon for the tbmq.ie.uplink.notifications topic.
Additional Kafka producer configs separated by semicolon for the tbmq.ie.uplink.notifications topic.
Kafka topic properties separated by semicolon for the tbmq.msg.ie topics.
Additional Kafka consumer configs separated by semicolon for the tbmq.msg.ie topics.
Additional Kafka producer configs separated by semicolon for the tbmq.msg.ie topics.
Common prefix for all Kafka topics, producers, consumer groups, and consumers. Defaults to empty string, meaning no prefix is applied.
Service parameters
Section titled “Service parameters”Microservice type. Accepted values: tbmq-integration-executor.
Unique ID for this service. Autogenerated if empty.
Enables or disables specific integration types on this executor. Accepted values: HTTP, KAFKA, MQTT. Defaults to ALL.
List of integration types to exclude from processing on this executor. Accepted values: HTTP, KAFKA, MQTT. Defaults to NONE.
Integration common parameters
Section titled “Integration common parameters”Enables or disables integration statistics.
Persistence frequency for integration statistics (in ms).
Maximum connection timeout allowed for integrations (in s). Any greater user-defined timeout will be reduced to this limit.
Timeout for API connection check requests (in s).
Enables or disables hot reinitialization of integrations in ‘FAILED’ state.
Reinitialization check interval for failed integrations (in ms). Defaults to 5 minutes.
Duration to wait during each graceful shutdown iteration for integrations to terminate properly (in ms). Defaults to 1 s.
Number of graceful shutdown iterations before forcefully stopping the process.
Maximum duration to wait before forcefully stopping the application if graceful shutdown has not started or exceeded the allowed time (in ms).
Enables or disables access to local network hosts from integrations.
Number of threads in the pool to process callbacks of uplink events to TBMQ nodes.
Number of threads in the pool to process lifecycle events (CREATE/UPDATE/DELETE) of integrations.
Number of threads in the pool to process integration validation requests.
Number of threads in the pool dedicated to handling external operations, such as producing messages to Kafka topics.
Number of threads in the Netty shared worker group. Defaults to 0, which sets the count to availableProcessors * 2. Used to send messages to external MQTT brokers using MQTT bridge (integration).
Management parameters
Section titled “Management parameters”Enables or disables disk space health check.
Controls whether the health endpoint shows full component details (e.g., Redis, DB, TBMQ). Accepted values: never: always hide details (default if security is enabled). when-authorized: show details only to authenticated users. always: always include full health details in the response.
Actuator endpoints exposed via HTTP. Use ‘health,info’ to expose only basic health and information endpoints. To expose Prometheus metrics, include ‘prometheus’ in the list (e.g., ‘health,info,prometheus’).
Statistics parameters
Section titled “Statistics parameters”Enables or disables stats printing to the logs.
Print interval for integration executor statistics (in ms). Defaults to 1 minute.
Metrics percentiles returned by actuator for timer metrics. List of comma-separated double values.
Persistence frequency of system info such as CPU and memory usage (in s).
Event configuration parameters
Section titled “Event configuration parameters”Enables or disables event error rate limiting.
No more than 5000 messages per hour or 100 messages per minute for all integrations.
Time to suppress duplicate persistence of rate limit events after the error rate limit is reached (in minutes).