Report Service Configuration
Server common parameters
Section titled “Server common parameters”Server bind-address
Server bind port
Zookeeper connection parameters
Section titled “Zookeeper connection parameters”Enable/disable zookeeper discovery service.
ZooKeeper connect string
ZooKeeper retry interval in milliseconds
ZooKeeper connection timeout in milliseconds
ZooKeeper session timeout in milliseconds
Name of the directory in zookeeper ‘filesystem’
The recalculate_delay property is recommended in a microservices architecture setup for rule-engine services. This property provides a pause to ensure that when a rule-engine service is restarted, other nodes don’t immediately attempt to recalculate their partitions. The delay is recommended because the initialization of rule chain actors is time-consuming. Avoiding unnecessary recalculations during a restart can enhance system performance and stability.
Queue configuration parameters
Section titled “Queue configuration parameters”kafka (Apache Kafka)
Global queue prefix. If specified, prefix is added before default topic name: ‘prefix.default_topic_name’. Prefix is applied to all topics (and consumer groups for kafka).
Kafka Bootstrap nodes in “host:port” format
Enable/Disable SSL Kafka communication
The location of the trust store file
The password of trust store file if specified
The location of the key store file. This is optional for the client and can be used for two-way authentication for the client
The store password for the key store file. This is optional for the client and only needed if ‘ssl.keystore.location’ is configured. Key store password is not supported for PEM format
The password of the private key in the key store file or the PEM key specified in ‘keystore.key’
The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are allowed:0, 1 and all
Number of retries. Resend any record whose send fails with a potentially transient error
none or gzip
Default batch size. This setting gives the upper bound of the batch size to be sent
This variable creates a small amount of artificial delay—that is, rather than immediately sending out a record
The maximum size of a request in bytes. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests
The maximum number of unacknowledged requests the client will send on a single connection before blocking
The total bytes of memory the producer can use to buffer records waiting to be sent to the server
The multiple copies of data over the multiple brokers of Kafka
The maximum delay between invocations of poll() method when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records
The maximum number of records returned in a single call of poll() method
The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer
The maximum amount of data the server will return. Records are fetched in batches by the consumer
(30 seconds)
(10 seconds)
earliest, latest or none
Enable/Disable using of Confluent Cloud
The endpoint identification algorithm used by clients to validate server hostname. The default value is https
The mechanism used to authenticate Schema Registry requests. SASL/PLAIN should only be used with TLS/SSL as a transport layer to ensure that clear passwords are not transmitted on the wire without encryption
Using JAAS Configuration for specifying multiple SASL mechanisms on a broker
Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL
Max poll records for tasks topics
In this section you can specify custom parameters (semicolon separated) for Kafka consumer/producer/admin
Kafka properties for tasks topics
Prints lag between consumer group offset and last messages offset in Kafka topics
Statistics printing interval for Kafka’s consumer-groups stats
Time to wait for the stats-loading requests to Kafka to finish
Topics cache TTL in milliseconds. 5 minutes by default
Poll interval in milliseconds for tasks topics
Partitions count for tasks queues
Custom partitions count for tasks queues per type. Format: ‘TYPE1:24;TYPE2:36’, e.g. ‘CF_REPROCESSING:24;TENANT_EXPORT:6’
Tasks partitioning strategy: ‘tenant’ or ‘entity’. By default, using ‘tenant’ - tasks of a specific tenant are processed in the same partition. In a single-tenant environment, use ‘entity’ strategy to distribute the tasks among multiple partitions.
TB Report notifications topic name
Poll interval in milliseconds for TB Report queues
murmur3_32, murmur3_128 or sha256
TBEL parameters
Section titled “TBEL parameters”Enable/Disable TBEL feature.
Limit the number of arguments that are passed to the function to execute the script
Maximum allowed symbols in a result after processing a script
Maximum allowed symbols in the script body
Maximum allowed TBEL script execution memory
Maximum allowed TBEL script execution errors before it will be blacklisted
TBEL Eval max request timeout in milliseconds. 0 - no timeout
Maximum time in seconds for black listed function to stay in the list.
Specify thread pool size for javascript executor service
Maximum cache size of TBEL compiled scripts
Enable/Disable stats collection for TBEL engine
Interval of logging for TBEL stats
General service parameters
Section titled “General service parameters”Type of report service
Unique id for this service (autogenerated if empty)
Base URL of the ThingsBoard Core service
Enable/disable SSRF protection for report image resolution. When enabled, blocks file://, private IPs, cloud metadata endpoints, etc.
Comma-separated list of additional blocked hosts/CIDRs for SSRF protection (e.g. “evil.corp,203.0.113.0/24”)
Comma-separated list of allowed destinations that bypass SSRF blocking (IPs, CIDR subnets, or hostnames). Use this when reports need to access resources on private networks (e.g., 192.168.1.0/24). Example: “192.168.1.0/24,10.0.0.0/8,my-internal-service.corp”
Report server endpoint
50MB
Metrics parameters
Section titled “Metrics parameters”Enable/disable actuator metrics.
Metrics percentiles returned by actuator for timer metrics. List of double values (divided by ,).
General management parameters
Section titled “General management parameters”Expose metrics endpoint (use value ‘prometheus’ to enable prometheus metrics).