产品定价 立即试用
专业版
安装 > 配置 > 报表服务参数
入门 文档 指南
架构 API 常见问题
目录

报告服务

服务端通用参数

参数环境变量默认值描述
server.address HTTP_BIND_ADDRESS 0.0.0.0 服务器绑定地址
server.port HTTP_BIND_PORT 8081 服务器绑定端口

应用信息参数

参数环境变量默认值描述
app.version "@project.version@" 应用版本

Zookeeper连接参数

参数环境变量默认值描述
zk.enabled ZOOKEEPER_ENABLED true 启用/禁用Zookeeper服务发现。用于ThingsBoard集群
zk.url ZOOKEEPER_URL localhost:2181 Zookeeper连接字符串
zk.retry_interval_ms ZOOKEEPER_RETRY_INTERVAL_MS 3000 Zookeeper重试间隔(毫秒)
zk.connection_timeout_ms ZOOKEEPER_CONNECTION_TIMEOUT_MS 3000 Zookeeper连接超时(毫秒)
zk.session_timeout_ms ZOOKEEPER_SESSION_TIMEOUT_MS 3000 Zookeeper会话超时(毫秒)
zk.zk_dir ZOOKEEPER_NODES_DIR /thingsboard Zookeeper'文件系统'中的目录名
zk.recalculate_delay ZOOKEEPER_RECALCULATE_DELAY_MS 0 建议在规则引擎服务的微服务架构设置中使用recalculate_delay属性。此属性提供暂停,以确保重新启动规则引擎服务时,其他节点不会立即尝试重新计算其分区。建议延迟,因为规则链参与者的初始化非常耗时。避免重新启动期间不必要的重新计算可以增强系统性能和稳定性。
spring.main.allow-circular-references "true" Spring Boot配置属性控制是否允许bean之间的循环依赖。

队列配置参数

参数环境变量默认值描述
queue.type TB_QUEUE_TYPE kafka 卡夫卡(阿帕奇·卡夫卡)
queue.prefix TB_QUEUE_PREFIX 全局队列前缀。若指定,则在默认topic名前添加:'prefix.default_topic_name'。应用于所有topic(及kafka consumer group)。
queue.kafka.bootstrap.servers TB_KAFKA_SERVERS localhost:9092 Kafka Bootstrap服务器
queue.kafka.ssl.enabled TB_KAFKA_SSL_ENABLED false 启用/禁用Kafka SSL通信
queue.kafka.ssl.truststore.location TB_KAFKA_SSL_TRUSTSTORE_LOCATION truststore文件路径
queue.kafka.ssl.truststore.password TB_KAFKA_SSL_TRUSTSTORE_PASSWORD 若指定了truststore则为其密码
queue.kafka.ssl.keystore.location TB_KAFKA_SSL_KEYSTORE_LOCATION keystore文件路径。客户端可选,用于客户端双向认证
queue.kafka.ssl.keystore.password TB_KAFKA_SSL_KEYSTORE_PASSWORD 密钥存储文件的存储密码。这对于客户端来说是可选的,并且仅在配置了“ssl.keystore.location”时才需要。PEM格式不支持密钥存储密码
queue.kafka.ssl.key.password TB_KAFKA_SSL_KEY_PASSWORD 密钥库文件中私钥的密码或“keystore.key”中指定的PEM密钥的密码
queue.kafka.acks TB_KAFKA_ACKS all 生产者认为请求完成前要求leader收到的确认数。控制发送记录的持久性。允许值:0、1、all
queue.kafka.retries TB_KAFKA_RETRIES 1 重试次数。重发因瞬时错误发送失败的记录
queue.kafka.compression.type TB_KAFKA_COMPRESSION_TYPE none none或gzip
queue.kafka.batch.size TB_KAFKA_BATCH_SIZE 16384 默认批量大小。为待发送批量的上限
queue.kafka.linger.ms TB_KAFKA_LINGER_MS 1 创建少许人工延迟,即不立即发送记录
queue.kafka.max.request.size TB_KAFKA_MAX_REQUEST_SIZE 1048576 单次请求最大字节数。限制生产者单次请求发送的批次数以避免发送过大请求
queue.kafka.max.in.flight.requests.per.connection TB_KAFKA_MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION 5 客户端在单连接上阻塞前可发送的未确认请求最大数
queue.kafka.buffer.memory TB_BUFFER_MEMORY 33554432 生产者用于缓冲待发送记录的内存总字节数
queue.kafka.replication_factor TB_QUEUE_KAFKA_REPLICATION_FACTOR 1 Kafka多broker上的数据副本数
queue.kafka.max_poll_interval_ms TB_QUEUE_KAFKA_MAX_POLL_INTERVAL_MS 300000 使用consumer group管理时两次poll()调用间的最大延迟。限制消费者在获取更多记录前可空闲的最长时间
queue.kafka.max_poll_records TB_QUEUE_KAFKA_MAX_POLL_RECORDS 8192 单次poll()调用返回的最大记录数
queue.kafka.max_partition_fetch_bytes TB_QUEUE_KAFKA_MAX_PARTITION_FETCH_BYTES 16777216 服务器每分区返回的最大数据量。消费者按批获取记录
queue.kafka.fetch_max_bytes TB_QUEUE_KAFKA_FETCH_MAX_BYTES 134217728 服务器返回的最大数据量。消费者按批获取记录
queue.kafka.request.timeout.ms TB_QUEUE_KAFKA_REQUEST_TIMEOUT_MS 30000 (30秒)
queue.kafka.session.timeout.ms TB_QUEUE_KAFKA_SESSION_TIMEOUT_MS 10000 (10秒)
queue.kafka.auto_offset_reset TB_QUEUE_KAFKA_AUTO_OFFSET_RESET earliest earliest、latest或none
queue.kafka.use_confluent_cloud TB_QUEUE_KAFKA_USE_CONFLUENT_CLOUD false 启用/禁用Confluent Cloud
queue.kafka.confluent.ssl.algorithm TB_QUEUE_KAFKA_CONFLUENT_SSL_ALGORITHM https 客户端验证服务器主机名的端点标识算法。默认https
queue.kafka.confluent.sasl.mechanism TB_QUEUE_KAFKA_CONFLUENT_SASL_MECHANISM PLAIN 认证Schema Registry请求的机制。SASL/PLAIN应仅与TLS/SSL传输层配合使用以确保明文密码不未加密传输
queue.kafka.confluent.sasl.config TB_QUEUE_KAFKA_CONFLUENT_SASL_JAAS_CONFIG org.apache.kafka.common.security.plain.PlainLoginModule required username=\"CLUSTER_API_KEY\" password=\"CLUSTER_API_SECRET\"; 使用JAAS配置指定broker上的多个SASL机制
queue.kafka.confluent.security.protocol TB_QUEUE_KAFKA_CONFLUENT_SECURITY_PROTOCOL SASL_SSL 与broker通信的协议。有效值:PLAINTEXT、SSL、SASL_PLAINTEXT、SASL_SSL
queue.kafka.consumer-properties-per-topic.tasks.key max.poll.records 任务主题的Kafka使用者的键值属性
queue.kafka.consumer-properties-per-topic.tasks.key.value TB_QUEUE_KAFKA_TASKS_MAX_POLL_RECORDS 1 任务主题的最大轮询记录
queue.kafka.other-inline TB_QUEUE_KAFKA_OTHER_PROPERTIES 在本节中,您可以为Kafka消费者/生产者/管理员指定自定义参数(分号分隔)
queue.kafka.topic-properties.tasks TB_QUEUE_KAFKA_TASKS_TOPIC_PROPERTIES retention.ms:604800000;segment.bytes:52428800;retention.bytes:104857600;partitions:1;min.insync.replicas:1 任务主题的Kafka属性
queue.kafka.consumer-stats.enabled TB_QUEUE_KAFKA_CONSUMER_STATS_ENABLED true 打印Kafka主题中消费者组偏移量和最后消息偏移量之间的滞后
queue.kafka.consumer-stats.print-interval-ms TB_QUEUE_KAFKA_CONSUMER_STATS_MIN_PRINT_INTERVAL_MS 60000 Kafka消费者组统计数据的统计打印间隔
queue.kafka.consumer-stats.kafka-response-timeout-ms TB_QUEUE_KAFKA_CONSUMER_STATS_RESPONSE_TIMEOUT_MS 1000 等待Kafka的统计数据加载请求完成的时间
queue.kafka.topics_cache_ttl_ms TB_QUEUE_KAFKA_TOPICS_CACHE_TTL_MS 300000 topic缓存TTL(毫秒)。默认5分钟
queue.tasks.poll_interval TB_QUEUE_TASKS_POLL_INTERVAL_MS 500 任务主题的轮询间隔(以毫秒为单位)
queue.tasks.partitions TB_QUEUE_TASKS_PARTITIONS 12 任务队列的分区计数
queue.tasks.partitions_per_type TB_QUEUE_TASKS_PARTITIONS_PER_TYPE 每种类型的任务队列的自定义分区计数。格式:'TYPE1:24;TYPE2:36',例如'CF_REPROCESSING:24;TENANT_EXPORT:6'
queue.tasks.partitioning_strategy TB_QUEUE_TASKS_PARTITIONING_STRATEGY tenant 任务分区策略:“租户”或“实体”。默认情况下,使用“租户” - 特定租户的任务在同一分区中处理。在单租户环境中,使用“实体”策略在多个分区之间分配任务。
queue.report.notifications_topic TB_QUEUE_REPORT_NOTIFICATIONS_TOPIC tb_report.notifications TB Report通知主题名称
queue.report.poll_interval TB_QUEUE_REPORT_POLL_INTERVAL_MS 125 TB Report队列轮询间隔(毫秒)
queue.partitions.hash_function_name TB_QUEUE_PARTITIONS_HASH_FUNCTION_NAME murmur3_128 murmur3_32、murmur3_128或sha256

TBEL参数

参数环境变量默认值描述
tbel.enabled TBEL_ENABLED true 启用/禁用TBEL功能。
tbel.max_total_args_size TBEL_MAX_TOTAL_ARGS_SIZE 100000 限制传递给函数以执行脚本的参数数量
tbel.max_result_size TBEL_MAX_RESULT_SIZE 300000 处理脚本后结果中允许的最大符号数
tbel.max_script_body_size TBEL_MAX_SCRIPT_BODY_SIZE 50000 脚本主体中允许的最大符号数
tbel.max_memory_limit_mb TBEL_MAX_MEMORY_LIMIT_MB 8 允许的最大TBEL脚本执行内存
tbel.max_errors TBEL_MAX_ERRORS 3 TBEL脚本被列入黑名单之前允许的最大执行错误数
tbel.max_requests_timeout TBEL_MAX_REQUEST_TIMEOUT 500 TBEL Eval最大请求超时(以毫秒为单位)。0 - 无超时
tbel.max_black_list_duration_sec TBEL_MAX_BLACKLIST_DURATION_SEC 60 黑名单功能在列表中停留的最长时间(以秒为单位)。
tbel.thread_pool_size TBEL_THREAD_POOL_SIZE 50 指定javascript执行器服务的线程池大小
tbel.compiled_scripts_cache_size TBEL_COMPILED_SCRIPTS_CACHE_SIZE 1000 TBEL编译脚本的最大缓存大小
tbel.stats.enabled TB_TBEL_STATS_ENABLED false 启用/禁用TBEL引擎的统计信息收集
tbel.stats.print_interval_ms TB_TBEL_STATS_PRINT_INTERVAL_MS 10000 TBEL统计数据的记录间隔

通用服务参数

参数环境变量默认值描述
service.type TB_SERVICE_TYPE tb-report 服务类型
service.id TB_SERVICE_ID 本服务的唯一ID(空则自动生成)
service.tb_core.base_url TB_CORE_BASE_URL http://localhost:8080 Base URL of the ThingsBoard Core service
reports.web_report.base_url REPORTS_SERVER_ENDPOINT_URL http://localhost:8383 Report server endpoint
reports.web_report.max_response_size MAX_RESPONSE_SIZE 52428800 50MB

指标参数

参数环境变量默认值描述
metrics.enabled METRICS_ENABLED false 启用/禁用actuator指标。
metrics.timer.percentiles METRICS_TIMER_PERCENTILES 0.5 计时器指标的执行器返回的指标百分位数。双精度值列表(除以,)。

通用管理参数

参数环境变量默认值描述
management.endpoints.web.exposure.include METRICS_ENDPOINTS_EXPOSE info 暴露指标端点(使用'prometheus'启用prometheus指标)。