配置文件用于服务端http配置,如果通过RPC写入的方式,在客户端也需要配置相应文件。 下面为正文部分。
原文地址:http://opentsdb.net/docs/build/html/user_guide/configuration.html
可以通过本地系统上的文件,命令行参数或组合或两者来配置OpenTSDB。
配置文件符合Java属性规范。配置名称是小写的,没有空格的虚线字符String。每个名称后跟一个等号,然后是属性的值。所有OpenTSDB属性都以tsd.
注释开始,或者非活动配置行被哈希符号阻止#
。例如:
# List of Zookeeper hosts that manage the HBase cluster
tsd.storage.hbase.zk_quorum = 192.168.1.100
将配置TSD连接到Zookeeper 192.168.1.100
。
组合配置文件和命令行参数时,处理顺序如下:
加载默认值
加载配置文件值,覆盖默认值
加载命令行参数,覆盖配置文件和默认值
您可以使用--config
命令行参数指定配置文件的完整路径。否则,如果未指定,OpenTSDB和某些命令行工具将尝试在以下位置搜索有效的配置文件:
./opentsdb.conf
/etc/opentsdb.conf
/etc/opentsdb/opentsdb.conf
/opt/opentsdb/opentsdb.conf
如果找不到有效的配置文件且未设置所需的属性,则TSD将无法启动。请参阅下面的属性表,以获取所需配置设置的列表。
以下是所有工具的配置选项表。适用时,提供相应的命令行覆盖。请注意,各个命令行工具可能有自己的值,因此请参阅其文档以获取详细信息。
属性 | 类型 | 需要 | 描述 | 默认 | CLI |
---|---|---|---|---|---|
tsd.core.auto_create_metrics | bool | 否 | 具有新度量标准的数据点是否将为度量标准分配UID。如果为false,则将拒绝具有不在数据库中的度量标准的数据点,并将抛出异常。 | false | --auto-metric |
tsd.core.auto_create_tagks (2.1) | bool | 否 | 具有新标记名称的数据点是否将为tagk分配UID。如果为false,则将拒绝标记名称不在数据库中的数据点,并抛出异常。 | true | |
tsd.core.auto_create_tagvs (2.1) | bool | 否 | 具有新标记值的数据点是否将为tagv分配UID。如果为false,将拒绝具有不在数据库中的标记值的数据点,并抛出异常。 | true | |
tsd.core.connections.limit (2.3) | int | 否 | 设置TSD将处理的最大连接数,立即关闭其他连接。 | 0 | |
tsd.core.enable_api (2.3) | bool | 否 | 是否允许2.x HTTP API运行。禁用时,调用端点(如/api/query 或/api/suggest 将返回404)。 |
true | --disable-API |
tsd.core.enable_ui (2.3) | bool | 否 | 是否允许内置GUI和旧版HTTP API运行。禁用时,调用根端点或其他诸如/logs 或/suggest 将返回404。 |
true | --disable-UI |
tsd.core.histograms.config (2.4) | JSON /文件路径 | 否 | 直方图编解码器类名称到用于存储多测量数据的数字标识的映射。对于简单配置,该值可以是报价转义的JSON映射,例如。如果值结束,那么它将被视为文件路径,并且将打开和解析给定文件。数字ID必须介于0到255之间。{\"net.opentsdb.core.SimpleHistogramDecoder\":0,\"net.opentsdb.core.CompactQuantilesSketchCodec\":1}``.json |
||
tsd.core.meta.cache.enable (2.3) | bool | 否 | 是否启用了元数据缓存插件。 | false | true |
tsd.core.meta.cache.plugin (2.3) | String | 否 | 实现元缓存接口的插件的类名。 | ||
tsd.core.meta.enable_realtime_ts | bool | 否 | 是否启用实时TSMeta对象创建。请参阅元数据 | false | |
tsd.core.meta.enable_realtime_uid | bool | 否 | 是否启用实时UIDMeta对象创建。请参阅元数据 | false | |
tsd.core.meta.enable_tsuid_incrementing | bool | 否 | 是否通过在每次记录数据点时递增计数器来启用对TSUID的跟踪。请参阅元数据(覆盖“tsd.core.meta.enable_tsuid_tracking”) | false | |
tsd.core.meta.enable_tsuid_tracking | bool | 否 | 是否通过1 在每次记录数据点时使用当前时间戳存储a来启用对TSUID的跟踪。请参阅元数据 |
false | |
tsd.core.plugin_path | String | 否 | TSD启动时搜索插件的路径。如果路径无效,则TSD将无法启动。如果插件位于类路径中,则仍然可以启用插件。 | ||
tsd.core.preload_uid_cache (2.1) | bool | 否 | 启动TSD时启用UID高速缓存的预填充。 | false | |
tsd.core.preload_uid_cache.max_entries (2.1) | int | 否 | 要扫描UID预加载的行数。 | 300000 | |
tsd.core.stats_with_port (2.3) | bool | 否 | 在调用其中一个统计端点时,是否将TSD的侦听网络端口导出为带有统计信息的标记。 | false | true |
tsd.core.storage_exception_handler.enable(2.2) | bool | 否 | 是否启用配置的存储异常处理程序插件。 | false | |
tsd.core.storage_exception_handler.plugin(2.2) | String | 否 | 您要使用的存储异常处理程序插件的完整类名。 | ||
tsd.core.tag.allow_specialchars (2.3) | String | 否 | 度量标准名称,标记名称和标记密钥允许的可选ASCII字符列表,高于TSDB已允许的那些。允许空间。 | !〜/ | |
tsd.core.timezone | String | 否 | 本地化时区标识字符String,用于覆盖在执行查询时将绝对时间转换为UTC时使用的本地系统时区。这不会影响传入的数据时间戳。例如America / Los_Angeles | 系统已配置 | |
tsd.core.tree.enable_processing | bool | 否 | 是否通过树规则集启用处理新的/编辑的TSMeta | false | |
tsd.core.uid.random_metrics (2.2) | bool | 否 | 是否在创建新指标时随机分配UID | false | |
tsd.core.bulk.allow_out_of_order_timestamps*(2.3) | bool | 否 | 从文本文件批量导入数据时是否允许无序值。 | false | |
tsd.core.authentication.enable *(2.4) | bool | 否 | 是否启用指定的身份验证插件 | false | |
tsd.core.authentication.plugin *(2.4) | String | 否 | 要实例化的身份验证插件的类名。如果tsd.core.authentication.enable 设置为false,则忽略此值。 |
||
tsd.http.cachedir | String | 需要 | 可以写入临时文件的位置的完整路径。例如/ tmp / opentsdb | --cachedir | |
tsd.http.query.allow_delete | bool | 否 | 是否允许在查询时间内从存储中删除数据点。 | false | |
tsd.query.enable_fuzzy_filter | bool | 否 | 在使用explicitTags 标志进行查询时是否为模板启用FuzzyRowFilter 。 |
true | |
tsd.http.header_tag (2.4) | String | 否 | 一个否HTTP标头,当传递给HTTP / api / put API时,将被提取并添加到随内容发布的值的标签中。必须完全匹配HTTP标头。 | X-CustomTag | |
tsd.http.request.cors_domains | String | 否 | 逗号分隔的域名列表,允许Origin 在客户端指定标头时访问OpenTSDB 。如果为空,则在未经验证的情况下传递CORS请求。该列表可能不会同时包含公共通配符* 和特定域。 |
||
tsd.http.request.cors_headers (2.1) | String | 否 | 执行CORs请求时发送给客户端的标头的逗号分隔列表。此选项的文字值将传递给客户端。 | 授权,内容类型,接受,来源,用户代理,DNT,缓存控制,X-Mx-ReqToken,Keep-Alive,X-Requested-With,If-Modified-Since | |
tsd.http.request.enable_chunked | bool | 否 | 是否为HTTP RPC启用传入的块支持 | false | |
tsd.http.request.max_chunk | int | 否 | 启用分块时支持传入HTTP请求的最大请求主体大小。 | 4096 | |
tsd.http.rpc.plugins (2.2) | String | 否 | 以逗号分隔的RPC插件列表,在启动TSD时加载。必须包含整个类名。 | ||
tsd.http.show_stack_trace | bool | 否 | 发生异常时是否使用API查询响应返回堆栈跟踪。 | false | |
tsd.http.staticroot | String | 是 | 静态文件(例如Web界面的JavaScript文件)所在的目录的位置。例如/ opt / opentsdb / staticroot | --staticroot | |
tsd.mode (2.1) | String | 否 | TSD是否允许写入数据点。必须是rw 允许写入数据或ro 阻止数据点写入。请注意,仍可以编写/修改诸如UID之类的元数据。 |
RW | |
tsd.network.async_io | bool | 否 | 是否使用NIO或传统阻塞IO | true | --async-IO |
tsd.network.backlog | int | 否 | 连接队列深度,表示已完成或未完成的连接请求,具体取决于操 默认值可能受'somaxconn'内核设置的限制或由Netty设置为3072。 | 见说明 | --backlog |
tsd.network.bind | String | 否 | 要绑定到传入请求的IPv4地址。默认是侦听所有接口。例如127.0.0.1 | 0.0.0.0 | --bind |
tsd.network.keep_alive | bool | 否 | 是否允许保持连接 | true | |
tsd.network.port | int | 是 | 用于接受连接的TCP端口 | --port | |
tsd.network.reuse_address | bool | 否 | 是否允许在Netty中重用绑定端口 | true | |
tsd.network.tcp_no_delay | bool | 否 | 是否在发送数据之前禁用TCP缓冲 | true | |
tsd.network.worker_threads | int | 否 | Netty的异步IO工作线程数 | #CPU核心* 2 | --worker-threads |
tsd.no_diediedie (2.1) | bool | 否 | 启用或禁用diediedie HTML和ASCII命令以关闭TSD。 |
false | |
tsd.query.allow_simultaneous_duplicates(2.2) | bool | 否 | 是否允许来自同一主机的同时重复查询。如果禁用,则匹配已运行的第二个查询将收到异常。 | false | |
tsd.query.filter.expansion_limit (2.2) | int | 否 | 扫描数据期间发送到存储的正则表达式中包含的标记值的最大数量。值越大意味着HBase区域服务器上的计算量越大。 | 4096 | |
tsd.query.limits.bytes.allow_override,(2.4) | bool | 否 | 查询字节限制器是否可以基于每个查询覆盖。 | false | true |
tsd.query.limits.bytes.default (2.4) | int | 否 | 对从存储中提取的字节数的限制。达到此限制时,查询将返回异常。值为0将禁用限制器。 | 0 | 268435456 |
tsd.query.limits.data_points.allow_override(2.4) | bool | 否 | 查询数据点限制器是否可以基于每个查询覆盖。 | false | true |
tsd.query.limits.data_points.default (2.4) | int | 否 | 对从存储中提取的数据点数量的限制。达到此限制时,查询将返回异常。值为0将禁用限制器。 | 0 | 1000000 |
tsd.query.limits.overrides.interval (2.4) | int | 否 | 以毫秒为单位重新加载字节和数据点查询限制器插件配置的频率。 | 60000 | |
tsd.query.limits.overrides.config (2.4) | JSON /文件路径 | 否 | 查询限制配置的路径或完整配置,其中包含与度量标准名称匹配的选项。 | ||
tsd.query.multi_get.enable (2.4) | bool | 否 | 是否与搜索插件一起启用了多次获取查询。 | false | true |
tsd.query.multi_get.batch_size (2.4) | int | 否 | 在单个请求中发送到存储的get请求数。 | 1024 | |
tsd.query.multi_get.concurrent (2.4) | int | 否 | 对于多次获取查询,在任何给定时间未完成的同时批次数。 | 20 | |
tsd.query.multi_get.get_all_salts (2.4) | bool | 否 | 是否针对每个盐桶触发了get请求,或者是否计算了正确的桶。盐渍配置发生变化时使用。 | false | true |
tsd.query.skip_unresolved_tagvs (2.2) | bool | 否 | 当查询包括尚未分配UID且可能不存在的标记值时是否继续查询。 | false | |
tsd.query.timeout (2.2) | int | 否 | 取消正在运行的查询之前的时间(以毫秒为单位)。值为0表示查询不会超时。 | 0 | |
tsd.rollups.config (2.4) | String | 否 | 详细说明可用汇总表和聚合的配置文件的路径。必须设置tsd.rollups.enable 到true 了要分析这个选项。请参阅汇总和预聚合 |
rollup_config.json | |
tsd.rollups.enable (2.4) | bool | 否 | 是否启用汇总和预聚合存储和写入。 | false | |
tsd.rollups.tag_raw (2.4) | bool | 否 | 是否使用配置的标记键tsd.rollups.agg_tag_key 和配置的值来标记非卷起和非预先聚合的值tsd.rollups.raw_agg_tag_value |
false | |
tsd.rollups.agg_tag_key (2.4) | String | 否 | 在写入存储时标记预聚合数据的特殊键 | _ aggregate | |
tsd.rollups.raw_agg_tag_value (2.4) | String | 否 | 写入存储时的非卷积和非预聚合数据的特殊标记值。tsd.rollups.tag_raw 必须设置为true。 |
RAW | |
tsd.rollups.block_derived (2.4) | bool | 否 | 是否阻止存储派生的聚合,例如AVG 和DEV 。 |
true | |
tsd.rpc.plugins | String | 否 | 以逗号分隔的RPC插件列表,在启动TSD时加载。必须包含整个类名。 | ||
tsd.rpc.telnet.return_errors (2.4) | bool | 否 | 是否通过put 或写入数据时将错误返回到Telnet样式套接字rollup |
true | |
tsd.rtpublisher.enable | bool | 否 | 是否启用实时发布插件。如果为true,则必须提供有效的tsd.rtpublisher.plugin 类名 |
false | |
tsd.rtpublisher.plugin | String | 否 | 要实例化的实时发布插件的类名。如果tsd.rtpublisher.enable 设置为false,则忽略此值。例如net.opentsdb.tsd.RabbitMQPublisher |
||
tsd.search.enable | bool | 否 | 是否启用搜索功能。如果为true,则必须提供有效的tsd.search.plugin 类名 |
false | |
tsd.search.plugin | String | 否 | 要实例化的搜索插件的类名。如果tsd.search.enable 设置为false,则忽略此值。例如net.opentsdb.search.ElasticSearch |
||
tsd.stats.canonical | bool | 否 | 是否应返回带有统计信息请求的FQDN。返回默认统计信息host= ,不保证执行查找并返回FQDN。将此设置为true将执行名称查找并返回FQDN(如果找到),否则它可能返回IP。统计数据输出应该是fqdn= |
false | |
tsd.startup.enable (2.3) | bool | 否 | 是否应在TSD之前加载startu插件。 | false | true |
tsd.startup.plugin (2.3) | String | 否 | 实现StartupPlugin接口的插件的名称。 | ||
tsd.storage.compaction.flush_interval (2.2) | int | 否 | 在压缩队列刷新调用之间等待多长时间(以秒为单位) | 10 | |
tsd.storage.compaction.flush_speed (2.2) | int | 否 | 一个乘数,用于确定尝试刷新压缩队列的速度。例如,值为2表示它将尝试在30分钟内刷新整个队列。值1将花费一个小时。 | 2 | |
tsd.storage.compaction.max_concurrent_flushes(2.2) | int | 否 | 在任何给定时间,最大压缩次数都会飞到HBase | 10000 | |
tsd.storage.compaction.min_flush_threshold(2.2) | int | 否 | 触发刷新之前必须超过的压缩队列的大小 | 100 | |
tsd.storage.enable_appends (2.2) | bool | 否 | 是否在写入数据点时将数据附加到列而不是为每个值创建新列。在每小时后避免压缩的需要,但可以在HBase上使用更多资源。 | false | |
tsd.storage.enable_compaction | bool | 否 | 是否启用压缩 | true | |
tsd.storage.fix_duplicates (2.1) | bool | 否 | 解析具有重复时间戳的数据点时是否接受最后写入的值。与压缩一起启用时,将使用最新数据点编写压缩列。 | false | |
tsd.storage.flush_interval | int | 否 | 刷新数据点存储写入缓冲区的频率(以毫秒为单位) | 1000 | --flush-interval |
tsd.storage.get_date_tiered_compaction_start | int | 否 | 在HBase表上启用日期分层压缩时的Unix Epoch时间戳(以毫秒为单位)。这对于转移到DTC的现有OpenTSDB安装很有用。在此时间段之前开始的查询不会在查询上设置时间边界。请参见日期Tierd Compaction。 | 0 | 1514764800000 |
tsd.storage.hbase.data_table | String | 否 | 存储数据点的HBase表的名称 | tsdb | - table |
tsd.storage.hbase.meta_table | String | 否 | 存储元数据的HBase表的名称 | tsdb-meta | |
tsd.storage.hbase.prefetch_meta (2.2) | bool | 否 | 是否在启动网络接口之前预取TSDB表的区域。这可以提高性能。 | false | |
tsd.storage.hbase.scanner.maxNumRows(2.3) | int | 否 | 每次调用扫描器的nextRows()方法从HBase获取的最大行数。 | 128 | 4096 |
tsd.storage.hbase.tree_table | String | 否 | 存储树数据的HBase表的名称 | tsdb-tree | |
tsd.storage.hbase.uid_table | String | 否 | 存储UID信息的HBase表的名称 | tsdb-uid | --uidtable |
tsd.storage.hbase.zk_basedir | String | 否 | -ROOT-区域的znode所在的路径 | / HBase | --zkbasedir |
tsd.storage.hbase.zk_quorum | String | 否 | 逗号分隔的ZooKeeper主机列表,用于连接,有或没有端口说明符。例如192.168.1.1:2181,192.168.1.2:2181 |
本地主机 | --zkquorum |
tsd.storage.repair_appends (2.2) | bool | 否 | 当列包含重复或无序数据时,是否在查询时重写附加数据点列。 | false | |
tsd.storage.max_tags (2.2) | int | 否 | 每个数据点允许的最大标记数。 注意请注意过度使用标签写入的性能权衡 | 8 | |
tsd.storage.salt.buckets (2.2) | int | 否 | 用于在区域之间分配负载的盐桶数量。注意写入数据后更改此值可能会导致基于TSUID的查询失败。 | 20 | |
tsd.storage.salt.width (2.2) | int | 否 | salt前缀的宽度(以字节为单位),用于指示时间序列所属的桶。值为0表示禁用salting。警告在将数据写入HBase后不要更改,否则您将损坏表并且无法再查询。 | 0 | |
tsd.timeseriesfilter.enable (2.3) | bool | 否 | 是否启用了数据写入过滤器插件。 | false | true |
tsd.timeseriesfilter.plugin (2.3) | String | 否 | 实现WriteableDataPointFilterPlugin接口的插件的类路径,用于过滤写入时间序列。 | ||
tsd.storage.uid.width.metric (2.2) | int | 否 | 度量标准UID的宽度(以字节为单位)。警告在将数据写入HBase后不要更改,否则您将损坏表并且无法再查询。 | 3 | |
tsd.storage.uid.width.tagk (2.2) | int | 否 | 标记名称UID的宽度(以字节为单位)。警告在将数据写入HBase后不要更改,否则您将损坏表并且无法再查询。 | 3 | |
tsd.storage.uid.width.tagv (2.2) | int | 否 | 标记值UID的宽度(以字节为单位)。警告在将数据写入HBase后不要更改,否则您将损坏表并且无法再查询。 | 3 | |
tsd.storage.use_max_value (2.4) | bool | 否 | 在找到重复项并且tsd.storage.use_otsdb_timestamp设置为true时,是否在TSDB压缩期间选择较大的数值。 | true | false |
tsd.storage.use_otsdb_timestamp (2.4) | bool | 否 | 使用数据点的时间戳进行存储中的编辑,而不是现在的默认值。请参见日期Tierd Compaction。 | false | true |
tsd.uidfilter.enable (2.3) | bool | 否 | 是否启用了UID分配插件过滤器。 | false | true |
tsd.uidfilter.plugin (2.3) | String | 否 | 一个实现UniqueIdFilterPlugin接口的插件。 | ||
tsd.uid.lru.enable (2.4) | bool | 否 | 将UID缓存从无界映射更改为LRU缓存。 | false | true |
tsd.uid.lru.id.size (2.4) | int | 否 | 反向UID到字符String映射的条目总数。将此值乘以3可获得可用条目总数,每个UID类型一个(度量标准,标记键,标记值)。 | 5000000 | 1000000 |
tsd.uid.lru.name.size (2.4) | int | 否 | 转发字符String到UID映射的条目总数。将此值乘以3可获得可用条目总数,每个UID类型一个(度量标准,标记键,标记值)。 | 5000000 | 1000000 |
tsd.uid.use_mode (2.4) | bool | 否 | 确定是否应根据tsd.mode设置填充名称和/或ID缓存。 | false | true |
某些配置值需要特别考虑:
bool值 - 以下文字将解析为True
:
1
true
yes
任何其他值将导致a False
。解析不区分大小写
字符String - 字符String,即使是带空格的字符String,也不需要引号,但有些注意事项适用:
特殊字符必须用反斜杠转义包括:#
,!
,=
,和:
例如:
Unicode字符必须使用十六进制表示进行转义,例如:
my.property = Hello World \!
Unicode字符必须使用十六进制表示进行转义,例如:
my.property = \u0009
总结目录https://blog.csdn.net/jyj1100/article/details/83450282