VC Executor Configuration
Spring common parameters
Section titled “Spring common parameters”If you enabled process metrics you should also enable ‘web-environment’.
If you enabled process metrics you should set ‘web-application-type’ to ‘servlet’ value.
Server common parameters
Section titled “Server common parameters”Server bind address (has no effect if web-environment is disabled).
Server bind port (has no effect if web-environment is disabled).
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).
For debug lvl
Kafka Bootstrap Servers
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() 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 to poll()
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
Example of specific consumer properties value per topic
Example of specific consumer properties value per topic for VC
tb_rule_engine.sq: - key: max.poll.records value: ”${TB_QUEUE_KAFKA_SQ_MAX_POLL_RECORDS:1024}” If you override any default Kafka topic name using environment variables, you must also specify the related consumer properties for the new topic in consumer-properties-per-topic-inline. Otherwise, the topic will not inherit its expected configuration (e.g., max.poll.records, timeouts, etc). Format: “topic1:key1=value1,key2=value2;topic2:key=value” Example: “tb_core_modified.notifications:max.poll.records=10;tb_edge_modified:max.poll.records=10,enable.auto.commit=true”
In this section you can specify custom parameters (semicolon separated) for Kafka consumer/producer/admin
Kafka properties for Core topics
Kafka properties for Notifications topics
Kafka properties for Core topics
Kafka properties for Housekeeper tasks topic
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 finis
Topics cache TTL in milliseconds. 5 minutes by default
murmur3_32, murmur3_128 or sha256
Default topic name
For high-priority notifications that require minimum latency and processing time
Interval in milliseconds to poll messages by Core microservices
Amount of partitions used by Core microservices
Timeout for processing a message pack by Core microservices
Default topic name for OTA updates
The interval of processing the OTA updates for devices. Used to avoid any harm to the network due to many parallel OTA updates
The size of OTA updates notifications fetched from the queue. The queue stores pairs of firmware and device ids
Stats topic name
Enable/disable statistics for Core microservices
Statistics printing interval for Core microservices
Topic name for Housekeeper tasks
Default topic name
Number of partitions to associate with this queue. Used for scaling the number of messages that can be processed in parallel
Interval in milliseconds between polling of the messages if no new messages arrive
Timeout before retrying all failed and timed-out messages from the processing pack
Limit for single queue message size
Version control parameters
Section titled “Version control parameters”Pool size for handling export tasks
Pool size for handling the git IO operations
Default storing repository path
Usage statistics parameters
Section titled “Usage statistics parameters”Enable/Disable the collection of statistics about API usage. Collected on a system and tenant level by default
Enable/Disable collection of statistics about API usage on a customer level
Interval of reporting the statistics. By default, the summarized statistics are sent every 10 seconds
Reporting interval for urgent keys (e.g. SMS, Email) that require quicker usage state updates
Amount of statistic messages in pack
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).
Service common properties
Section titled “Service common properties”service type
Unique id for this service (autogenerated if empty)
Notification system parameters
Section titled “Notification system parameters”Semicolon-separated deduplication durations (in millis) for trigger types. Format: ‘NotificationRuleTriggerType1:123;NotificationRuleTriggerType2:456’