跳至主要內容

监控告警

大约 22 分钟

监控告警

在 IoTDB 的运行过程中,我们希望对 IoTDB 的状态进行观测,以便于排查系统问题或者及时发现系统潜在的风险,能够反映系统运行状态的一系列指标就是系统监控指标。

1. 什么场景下会使用到监控?

那么什么时候会用到监控框架呢?下面列举一些常见的场景。

  1. 系统变慢了

    系统变慢几乎是最常见也最头疼的问题,这时候我们需要尽可能多的信息来帮助我们找到系统变慢的原因,比如:

    • JVM信息:是不是有FGC?GC耗时多少?GC后内存有没有恢复?是不是有大量的线程?
    • 系统信息:CPU使用率是不是太高了?磁盘IO是不是很频繁?
    • 连接数:当前连接是不是太多?
    • 接口:当前TPS是多少?各个接口耗时有没有变化?
    • 线程池:系统中各种任务是否有积压?
    • 缓存命中率
  2. 磁盘快满了

    这时候我们迫切想知道最近一段时间数据文件的增长情况,看看是不是某种文件有突增。

  3. 系统运行是否正常

    此时我们可能需要通过错误日志的数量、集群节点的状态等指标来判断系统是否在正常运行。

2. 什么人需要使用监控?

所有关注系统状态的人员都可以使用,包括但不限于研发、测试、运维、DBA等等

3. 什么是监控指标?

3.1. 监控指标名词解释

在 IoTDB 的监控模块,每个监控指标被 Metric NameTags 唯一标识。

  • Metric Name:指标类型名称,比如logback_events表示日志事件。
  • Tags:指标分类,形式为Key-Value对,每个指标下面可以有0到多个分类,常见的Key-Value对:
    • name = xxx:被监控对象的名称,是对业务逻辑的说明。比如对于Metric Name = entry_seconds_count
      类型的监控项,name的含义是指被监控的业务接口。
    • type = xxx:监控指标类型细分,是对监控指标本身的说明。比如对于Metric Name = point
      类型的监控项,type的含义是指监控具体是什么类型的点数。
    • status = xxx:被监控对象的状态,是对业务逻辑的说明。比如对于Metric Name = Task类型的监控项可以通过该参数,从而区分被监控对象的状态。
    • user = xxx:被监控对象的相关用户,是对业务逻辑的说明。比如统计root用户的写入总点数。
    • 根据具体情况自定义:比如logback_events_total下有一个level的分类,用来表示特定级别下的日志数量。
  • Metric Level指标管理级别,默认启动级别为Core级别,建议启动级别为Important级别
    ,审核严格程度Core > Important > Normal > All
    • Core:系统的核心指标,供系统内核和运维人员使用,关乎系统的性能、稳定性、安全性,比如实例的状况,系统的负载等。
    • Important:模块的重要指标,供运维和测试人员使用,直接关乎每个模块的运行状态,比如合并文件个数、执行情况等。
    • Normal:模块的一般指标,供开发人员使用,方便在出现问题时定位模块,比如合并中的特定关键操作情况。
    • All:模块的全部指标,供模块开发人员使用,往往在复现问题的时候使用,从而快速解决问题。

3.2. 监控指标对外获取数据格式

  • IoTDB 对外提供 JMX、 Prometheus 和 IoTDB 格式的监控指标:
    • 对于 JMX ,可以通过org.apache.iotdb.metrics获取系统监控指标指标。
    • 对于 Prometheus ,可以通过对外暴露的端口获取监控指标的值
    • 对于 IoTDB 方式对外暴露:可以通过执行 IoTDB 的查询来获取监控指标

4. 监控指标有哪些?

目前,IoTDB 对外提供一些主要模块的监控指标,并且随着新功能的开发以及系统优化或者重构,监控指标也会同步添加和更新。如果想自己在
IoTDB
中添加更多系统监控指标埋点,可以参考IoTDB Metrics Frameworkopen in new window使用说明。

4.1. Core 级别监控指标

Core 级别的监控指标在系统运行中默认开启,每一个 Core 级别的监控指标的添加都需要经过谨慎的评估,目前 Core 级别的监控指标如下所述:

4.1.1. 集群运行状态

MetricTagsTypeDescription
up_time-AutoGaugeIoTDB 启动的运行时间
config_nodename="total",status="Registered/Online/Unknown"AutoGauge已注册/在线/离线 confignode 的节点数量
data_nodename="total",status="Registered/Online/Unknown"AutoGauge已注册/在线/离线 datanode 的节点数量
cluster_node_leader_countname="{ip}:{port}"Gauge节点上共识组Leader的数量
cluster_node_statusname="{ip}:{port}",type="ConfigNode/DataNode"Gauge节点的状态,0=Unkonwn 1=online
entryname="{interface}"TimerClient 建立的 Thrift 的耗时情况
memname="IoTConsensus"AutoGaugeIoT共识协议的内存占用,单位为byte

4.1.2. 接口层统计

MetricTagsTypeDescription
thrift_connectionsname="ConfigNodeRPC"AutoGaugeConfigNode 的内部 Thrift 连接数
thrift_connectionsname="InternalRPC"AutoGaugeDataNode 的内部 Thrift 连接数
thrift_connectionsname="MPPDataExchangeRPC"AutoGaugeMPP 框架的内部 Thrift 连接数
thrift_connectionsname="ClientRPC"AutoGaugeClient 建立的 Thrift 连接数
thrift_active_threadsname="ConfigNodeRPC-Service"AutoGaugeConfigNode 的内部活跃 Thrift 连接数
thrift_active_threadsname="DataNodeInternalRPC-Service"AutoGaugeDataNode 的内部活跃 Thrift 连接数
thrift_active_threadsname="MPPDataExchangeRPC-Service"AutoGaugeMPP 框架的内部活跃 Thrift 连接数
thrift_active_threadsname="ClientRPC-Service"AutoGaugeClient 建立的活跃 Thrift 连接数
session_idle_timename = "sessionId"Histogram不同 Session 的空闲时间分布情况

4.1.3. 节点统计

MetricTagsTypeDescription
quantityname="database"AutoGauge系统数据库数量
quantityname="timeSeries"AutoGauge系统时间序列数量
quantityname="pointsIn"Counter系统累计写入点数
pointsdatabase="{database}", type="flush"Gauge最新一个刷盘的memtale的点数

4.1.4. 集群全链路

MetricTagsTypeDescription
performance_overviewinterface="{interface}", type="{statement_type}"Timer客户端执行的操作的耗时情况
performance_overview_detailstage="authority"Timer权限认证总耗时
performance_overview_detailstage="parser"Timer解析构造总耗时
performance_overview_detailstage="analyzer"Timer语句分析总耗时
performance_overview_detailstage="planner"Timer请求规划总耗时
performance_overview_detailstage="scheduler"Timer请求执行总耗时
performance_overview_schedule_detailstage="local_scheduler"Timer本地请求执行总耗时
performance_overview_schedule_detailstage="remote_scheduler"Timer远程请求执行总耗时
performance_overview_local_detailstage="schema_validate"Timer元数据验证总耗时
performance_overview_local_detailstage="trigger"TimerTrigger 触发总耗时
performance_overview_local_detailstage="storage"Timer共识层总耗时
performance_overview_storage_detailstage="engine"TimerDataRegion 抢锁总耗时
performance_overview_engine_detailstage="lock"TimerDataRegion 抢锁总耗时
performance_overview_engine_detailstage="create_memtable_block"Timer创建新的 Memtable 耗时
performance_overview_engine_detailstage="memory_block"Timer内存控制阻塞总耗时
performance_overview_engine_detailstage="wal"Timer写入 Wal 总耗时
performance_overview_engine_detailstage="memtable"Timer写入 Memtable 总耗时
performance_overview_engine_detailstage="last_cache"Timer更新 LastCache 总耗时

4.1.5. 任务统计

MetricTagsTypeDescription
queuename="compaction_inner", status="running/waiting"Gauge空间内合并任务数
queuename="compaction_cross", status="running/waiting"Gauge跨空间合并任务数
queuename="flush",status="running/waiting"AutoGauge刷盘任务数
cost_taskname="inner_compaction/cross_compaction/flush"Gauge任务耗时情况

4.1.6. IoTDB 进程运行状态

MetricTagsTypeDescription
process_cpu_loadname="process"AutoGaugeIoTDB 进程的 CPU 占用率,单位为%
process_cpu_timename="process"AutoGaugeIoTDB 进程占用的 CPU 时间,单位为ns
process_max_memname="memory"AutoGaugeIoTDB 进程最大可用内存
process_total_memname="memory"AutoGaugeIoTDB 进程当前已申请内存
process_free_memname="memory"AutoGaugeIoTDB 进程当前剩余可用内存

4.1.7. 系统运行状态

MetricTagsTypeDescription
sys_cpu_loadname="system"AutoGauge系统的 CPU 占用率,单位为%
sys_cpu_coresname="system"Gauge系统的可用处理器数
sys_total_physical_memory_sizename="memory"Gauge系统的最大物理内存
sys_free_physical_memory_sizename="memory"AutoGauge系统的剩余可用内存
sys_total_swap_space_sizename="memory"AutoGauge系统的交换区最大空间
sys_free_swap_space_sizename="memory"AutoGauge系统的交换区剩余可用空间
sys_committed_vm_sizename="memory"AutoGauge系统保证可用于正在运行的进程的虚拟内存量
sys_disk_total_spacename="disk"AutoGauge系统磁盘总大小
sys_disk_free_spacename="disk"AutoGauge系统磁盘可用大小

4.1.8. IoTDB 日志统计

MetricTagsTypeDescription
logback_eventslevel="trace/debug/info/warn/error"Counter不同类型的日志个数

4.1.9. 文件统计信息

MetricTagsTypeDescription
file_sizename="wal"AutoGauge写前日志总大小,单位为byte
file_sizename="seq"AutoGauge顺序TsFile总大小,单位为byte
file_sizename="unseq"AutoGauge乱序TsFile总大小,单位为byte
file_sizename="inner-seq-temp"AutoGauge顺序空间内合并临时文件大小,单位为byte
file_sizename="inner-unseq-temp"AutoGauge乱序空间内合并临时文件大小,单位为byte
file_sizename="cross-temp"AutoGauge跨空间合并临时文件大小,单位为byte
file_sizename="mods"AutoGaugeModification 文件的大小
file_countname="wal"AutoGauge写前日志文件个数
file_countname="seq"AutoGauge顺序TsFile文件个数
file_countname="unseq"AutoGauge乱序TsFile文件个数
file_countname="inner-seq-temp"AutoGauge顺序空间内合并临时文件个数
file_countname="inner-unseq-temp"AutoGauge乱序空间内合并临时文件个数
file_countname="cross-temp"AutoGauge跨空间合并临时文件个数
file_countname="open_file_handlers"AutoGaugeIoTDB 进程打开文件数,仅支持Linux和MacOS
file_countname="modsAutoGaugeModification 文件的数目

4.1.10. JVM 内存统计

MetricTagsTypeDescription
jvm_buffer_memory_used_bytesid="direct/mapped"AutoGauge已经使用的缓冲区大小
jvm_buffer_total_capacity_bytesid="direct/mapped"AutoGauge最大缓冲区大小
jvm_buffer_count_buffersid="direct/mapped"AutoGauge当前缓冲区数量
jvm_memory_committed_bytesAutoGauge当前申请的内存大小
jvm_memory_max_bytesAutoGauge最大内存
jvm_memory_used_bytesAutoGauge已使用内存大小

4.1.11. JVM 线程统计

MetricTagsTypeDescription
jvm_threads_live_threadsAutoGauge当前线程数
jvm_threads_daemon_threadsAutoGauge当前 Daemon 线程数
jvm_threads_peak_threadsAutoGauge峰值线程数
jvm_threads_states_threadsstate="runnable/blocked/waiting/timed-waiting/new/terminated"AutoGauge当前处于各种状态的线程数

4.1.12. JVM GC 统计

MetricTagsTypeDescription
jvm_gc_pauseaction="end of major GC/end of minor GC",cause="xxxx"Timer不同原因的Young GC/Full GC的次数与耗时
jvm_gc_concurrent_phase_timeaction="{action}",cause="{cause}"Timer不同原因的Young GC/Full GC的次数与耗时
jvm_gc_max_data_size_bytesAutoGauge老年代内存的历史最大值
jvm_gc_live_data_size_bytesAutoGauge老年代内存的使用值
jvm_gc_memory_promoted_bytesCounter老年代内存正向增长累计值
jvm_gc_memory_allocated_bytesCounterGC分配内存正向增长累计值

4.2. Important 级别监控指标

目前 Important 级别的监控指标如下所述:

4.2.1. 节点统计

MetricTagsTypeDescription
regionname="total",type="SchemaRegion"AutoGauge分区表中 SchemaRegion 总数量
regionname="total",type="DataRegion"AutoGauge分区表中 DataRegion 总数量
regionname="{ip}:{port}",type="SchemaRegion"Gauge分区表中对应节点上 DataRegion 总数量
regionname="{ip}:{port}",type="DataRegion"Gauge分区表中对应节点上 DataRegion 总数量

4.2.2. Ratis共识协议统计

MetricTagsTypeDescription
ratis_consensus_writestage="writeLocally"Timer本地写入阶段的时间
ratis_consensus_writestage="writeRemotely"Timer远程写入阶段的时间
ratis_consensus_writestage="writeStateMachine"Timer写入状态机阶段的时间
ratis_serverclientWriteRequestTimer处理来自客户端写请求的时间
ratis_serverfollowerAppendEntryLatencyTimer跟随者追加日志条目的总时间
ratis_log_workerappendEntryLatencyTimer领导者追加日志条目的总时间
ratis_log_workerqueueingDelayTimer一个 Raft 日志操作被请求后进入队列的时间,等待队列未满
ratis_log_workerenqueuedTimeTimer一个 Raft 日志操作在队列中的时间
ratis_log_workerwritelogExecutionTimeTimer一个 Raft 日志写入操作完成执行的时间
ratis_log_workerflushTimeTimer刷新日志的时间
ratis_log_workerclosedSegmentsSizeInBytesGauge关闭的 Raft 日志段的总大小
ratis_log_workeropenSegmentSizeInBytesGauge打开的 Raft 日志段的总大小

4.2.3. IoT共识协议统计

MetricTagsTypeDescription
iot_consensusname="logDispatcher-{IP}:{Port}", region="{region}", type="currentSyncIndex"AutoGauge副本组同步线程的当前同步进度
iot_consensusname="logDispatcher-{IP}:{Port}", region="{region}", type="cachedRequestInMemoryQueue"AutoGauge副本组同步线程缓存队列请求总大小
iot_consensusname="IoTConsensusServerImpl", region="{region}", type="searchIndex"AutoGauge副本组主流程写入进度
iot_consensusname="IoTConsensusServerImpl", region="{region}", type="safeIndex"AutoGauge副本组同步进度
iot_consensusname="IoTConsensusServerImpl", region="{region}", type="syncLag"AutoGauge副本组写入进度与同步进度差
iot_consensusname="IoTConsensusServerImpl", region="{region}", type="LogEntriesFromWAL"AutoGauge副本组Batch中来自WAL的日志项数量
iot_consensusname="IoTConsensusServerImpl", region="{region}", type="LogEntriesFromQueue"AutoGauge副本组Batch中来自队列的日志项数量
stagename="iot_consensus", region="{region}", type="getStateMachineLock"Histogram主流程获取状态机锁耗时
stagename="iot_consensus", region="{region}", type="checkingBeforeWrite"Histogram主流程写入状态机检查耗时
stagename="iot_consensus", region="{region}", type="writeStateMachine"Histogram主流程写入状态机耗时
stagename="iot_consensus", region="{region}", type="offerRequestToQueue"Histogram主流程尝试添加队列耗时
stagename="iot_consensus", region="{region}", type="consensusWrite"Histogram主流程全写入耗时
stagename="iot_consensus", region="{region}", type="constructBatch"Histogram同步线程构造 Batch 耗时
stagename="iot_consensus", region="{region}", type="syncLogTimePerRequest"Histogram异步回调流程同步日志耗时

4.2.4. 缓存统计

MetricTagsTypeDescription
cache_hitname="chunk"AutoGaugeChunkCache的命中率,单位为%
cache_hitname="schema"AutoGaugeSchemaCache的命中率,单位为%
cache_hitname="timeSeriesMeta"AutoGaugeTimeseriesMetadataCache的命中率,单位为%
cache_hitname="bloomFilter"AutoGaugeTimeseriesMetadataCache中的bloomFilter的拦截率,单位为%
cachename="Database", type="hit"CounterDatabase Cache 的命中次数
cachename="Database", type="all"CounterDatabase Cache 的访问次数
cachename="SchemaPartition", type="hit"CounterSchemaPartition Cache 的命中次数
cachename="SchemaPartition", type="all"CounterSchemaPartition Cache 的访问次数
cachename="DataPartition", type="hit"CounterDataPartition Cache 的命中次数
cachename="DataPartition", type="all"CounterDataPartition Cache 的访问次数
cachename="SchemaCache", type="hit"CounterSchemaCache 的命中次数
cachename="SchemaCache", type="all"CounterSchemaCache 的访问次数

4.2.5. 内存统计

MetricTagsTypeDescription
memname="database_{name}"AutoGaugeDataNode内对应DataRegion的内存占用,单位为byte
memname="chunkMetaData_{name}"AutoGauge写入TsFile时的ChunkMetaData的内存占用,单位为byte
memname="IoTConsensus"AutoGaugeIoT共识协议的内存占用,单位为byte
memname="IoTConsensusQueue"AutoGaugeIoT共识协议用于队列的内存占用,单位为byte
memname="IoTConsensusSync"AutoGaugeIoT共识协议用于同步的内存占用,单位为byte
memname="schema_region_total_usage"AutoGauge所有SchemaRegion的总内存占用,单位为byte

4.2.6. 合并统计

MetricTagsTypeDescription
data_writtenname="compaction", type="aligned/not-aligned/total"Counter合并时写入量
data_readname="compaction"Counter合并时的读取量
compaction_task_countname = "inner_compaction", type="sequence"Counter顺序空间内合并次数
compaction_task_countname = "inner_compaction", type="unsequence"Counter乱序空间内合并次数
compaction_task_countname = "cross_compaction", type="cross"Counter跨空间合并次数

4.2.7. IoTDB 进程统计

MetricTagsTypeDescription
process_used_memname="memory"AutoGaugeIoTDB 进程当前使用内存
process_mem_rationame="memory"AutoGaugeIoTDB 进程的内存占用比例
process_threads_countname="process"AutoGaugeIoTDB 进程当前线程数
process_statusname="process"AutoGaugeIoTDB 进程存活状态,1为存活,0为终止

4.2.8. JVM 类加载统计

MetricTagsTypeDescription
jvm_classes_unloaded_classesAutoGauge累计卸载的class数量
jvm_classes_loaded_classesAutoGauge累计加载的class数量

4.2.9. JVM 编译时间统计

MetricTagsTypeDescription
jvm_compilation_time_msAutoGauge耗费在编译上的时间

4.2.10. 查询规划耗时统计

MetricTagsTypeDescription
query_plan_coststage="analyzer"Timer查询语句分析耗时
query_plan_coststage="logical_planner"Timer查询逻辑计划规划耗时
query_plan_coststage="distribution_planner"Timer查询分布式执行计划规划耗时
query_plan_coststage="partition_fetcher"Timer分区信息拉取耗时
query_plan_coststage="schema_fetcher"Timer元数据信息拉取耗时

4.2.11. 执行计划分发耗时统计

MetricTagsTypeDescription
dispatcherstage="wait_for_dispatch"Timer分发执行计划耗时
dispatcherstage="dispatch_read"Timer查询执行计划发送耗时

4.2.12. 查询资源访问统计

MetricTagsTypeDescription
query_resourcetype="sequence_tsfile"Rate顺序文件访问频率
query_resourcetype="unsequence_tsfile"Rate乱序文件访问频率
query_resourcetype="flushing_memtable"Rateflushing memtable 访问频率
query_resourcetype="working_memtable"Rateworking memtable 访问频率

4.2.13. 数据传输模块统计

MetricTagsTypeDescription
data_exchange_costoperation="source_handle_get_tsblock", type="local/remote"Timersource handle 接收 TsBlock 耗时
data_exchange_costoperation="source_handle_deserialize_tsblock", type="local/remote"Timersource handle 反序列化 TsBlock 耗时
data_exchange_costoperation="sink_handle_send_tsblock", type="local/remote"Timersink handle 发送 TsBlock 耗时
data_exchange_costoperation="send_new_data_block_event_task", type="server/caller"Timersink handle 发送 TsBlock RPC 耗时
data_exchange_costoperation="get_data_block_task", type="server/caller"Timersource handle 接收 TsBlock RPC 耗时
data_exchange_costoperation="on_acknowledge_data_block_event_task", type="server/caller"Timersource handle 确认接收 TsBlock RPC 耗时
data_exchange_countname="send_new_data_block_num", type="server/caller"Histogramsink handle 发送 TsBlock数量
data_exchange_countname="get_data_block_num", type="server/caller"Histogramsource handle 接收 TsBlock 数量
data_exchange_countname="on_acknowledge_data_block_num", type="server/caller"Histogramsource handle 确认接收 TsBlock 数量
data_exchange_countname="shuffle_sink_handle_size"AutoGaugesink handle 数量
data_exchange_countname="source_handle_size"AutoGaugesource handle 数量

4.2.14. 查询任务调度统计

MetricTagsTypeDescription
driver_schedulername="ready_queued_time"Timer就绪队列排队时间
driver_schedulername="block_queued_time"Timer阻塞队列排队时间
driver_schedulername="ready_queue_task_count"AutoGauge就绪队列排队任务数
driver_schedulername="block_queued_task_count"AutoGauge阻塞队列排队任务数
driver_schedulername="timeout_queued_task_count"AutoGauge超时队列排队任务数
driver_schedulername="query_map_size"AutoGauge记录在查询调度器中的查询数

4.2.15. 查询执行耗时统计

MetricTagsTypeDescription
query_executionstage="local_execution_planner"Timer算子树构造耗时
query_executionstage="query_resource_init"Timer查询资源初始化耗时
query_executionstage="get_query_resource_from_mem"Timer查询资源内存查询与构造耗时
query_executionstage="driver_internal_process"TimerDriver 执行耗时
query_executionstage="wait_for_result"Timer从resultHandle 获取一次查询结果的耗时
operator_execution_costname="{operator_name}"Timer算子执行耗时
operator_execution_countname="{operator_name}"Counter算子调用次数(以 next 方法调用次数计算)
aggregationfrom="raw_data"Timer从一批原始数据进行一次聚合计算的耗时
aggregationfrom="statistics"Timer使用统计信息更新一次聚合值的耗时
series_scan_coststage="load_timeseries_metadata", type="aligned/non_aligned", from="mem/disk"Timer加载 TimeseriesMetadata 耗时
series_scan_coststage="read_timeseries_metadata", type="", from="cache/file"Timer读取一个文件的 Metadata 耗时
series_scan_coststage="timeseries_metadata_modification", type="aligned/non_aligned", from="null"Timer过滤删除的 TimeseriesMetadata 耗时
series_scan_coststage="load_chunk_metadata_list", type="aligned/non_aligned", from="mem/disk"Timer加载 ChunkMetadata 列表耗时
series_scan_coststage="chunk_metadata_modification", type="aligned/non_aligned", from="mem/disk"Timer过滤删除的 ChunkMetadata 耗时
series_scan_coststage="chunk_metadata_filter", type="aligned/non_aligned", from="mem/disk"Timer根据查询过滤条件过滤 ChunkMetadata 耗时
series_scan_coststage="construct_chunk_reader", type="aligned/non_aligned", from="mem/disk"Timer构造 ChunkReader 耗时
series_scan_coststage="read_chunk", type="", from="cache/file"Timer读取 Chunk 的耗时
series_scan_coststage="init_chunk_reader", type="aligned/non_aligned", from="mem/disk"Timer初始化 ChunkReader(构造 PageReader) 耗时
series_scan_coststage="build_tsblock_from_page_reader", type="aligned/non_aligned", from="mem/disk"Timer从 PageReader 构造 Tsblock 耗时
series_scan_coststage="build_tsblock_from_merge_reader", type="aligned/non_aligned", from="null"Timer从 MergeReader 构造 Tsblock (解乱序数据)耗时

4.2.16. 协调模块统计

MetricTagsTypeDescription
coordinatorname="query_execution_map_size"AutoGauge当前DataNode上记录的查询数

4.2.17. 查询实例管理模块统计

MetricTagsTypeDescription
fragment_instance_managername="instance_context_size"AutoGauge当前 DataNode 上的查询分片 context 数
fragment_instance_managername="instance_execution_size"AutoGauge当前 DataNode 上的查询分片数

4.2.18. 内存池统计

MetricTagsTypeDescription
memory_poolname="max_bytes"Gauge用于数据交换的最大内存
memory_poolname="remaining_bytes"AutoGauge用于数据交换的剩余内存
memory_poolname="query_memory_reservation_size"AutoGauge申请内存的查询数
memory_poolname="memory_reservation_size"AutoGauge申请内存的 sink handle 和 source handle 数

4.2.19. 本地查询分片调度模块统计

MetricTagsTypeDescription
local_execution_plannername="free_memory_for_operators"AutoGauge可分配给operator执行的剩余内存

4.2.20. 元数据引擎统计

MetricTagsTypeDescription
schema_enginename="schema_region_total_mem_usage"AutoGaugeSchemaRegion 全局内存使用量
schema_enginename="schema_region_mem_capacity"AutoGaugeSchemaRegion 全局可用内存
schema_enginename="schema_engine_mode"GaugeSchemaEngine 模式
schema_enginename="schema_region_consensus"Gauge元数据管理引擎共识协议
schema_enginename="schema_region_number"AutoGaugeSchemaRegion 个数
quantityname="template_series_cnt"AutoGauge模板序列数
schema_regionname="schema_region_mem_usage", region="SchemaRegion[{regionId}]"AutoGauge每个 SchemaRegion 分别的内存使用量
schema_regionname="schema_region_series_cnt", region="SchemaRegion[{regionId}]"AutoGauge每个 SchemaRegion 分别的时间序列数
schema_regionname="activated_template_cnt", region="SchemaRegion[{regionId}]"AutoGauge每个 SchemaRegion 激活的模板数
schema_regionname="template_series_cnt", region="SchemaRegion[{regionId}]"AutoGauge每个 SchemaRegion 的模板序列数

4.2.21. 写入指标统计

MetricTagsTypeDescription
wal_node_numname="wal_nodes_num"AutoGaugeWALNode数量
wal_coststage="make_checkpoint" type="<checkpoint_type>"Timer创建各种类型的Checkpoint耗时
wal_costtype="serialize_one_wal_info_entry"Timer对每个WALInfoEntry serialize耗时
wal_coststage="sync_wal_buffer" type="<force_flag>"TimerWAL flush SyncBuffer耗时
wal_buffername="used_ratio"HistogramWALBuffer利用率
wal_buffername="entries_count"HistogramWALBuffer条目数量
wal_coststage="serialize_wal_entry" type="serialize_wal_entry_total"TimerWALBuffer serialize任务耗时
wal_node_infoname="effective_info_ratio" type="<wal_node_id>"HistogramWALNode有效信息占比
wal_node_infoname="oldest_mem_table_ram_when_cause_snapshot" type="<wal_node_id>"HistogramWAL触发oldest MemTable snapshot时MemTable大小
wal_node_infoname="oldest_mem_table_ram_when_cause_flush" type="<wal_node_id>"HistogramWAL触发oldest MemTable flush时MemTable大小
flush_sub_task_costtype="sort_task"Timer排序阶段中的每个series排序耗时
flush_sub_task_costtype="encoding_task"Timer编码阶段中处理每个encodingTask耗时
flush_sub_task_costtype="io_task"TimerIO阶段中处理每个ioTask耗时
flush_coststage="write_plan_indices"TimerwritePlanIndices耗时
flush_coststage="sort"Timer排序阶段总耗时
flush_coststage="encoding"Timer编码阶段总耗时
flush_coststage="io"TimerIO阶段总耗时
pending_flush_tasktype="pending_task_num"AutoGauge阻塞的Task数
pending_flush_tasktype="pending_sub_task_num"AutoGauge阻塞的SubTask数
flushing_mem_table_statusname="mem_table_size" region="DataRegion[<data_region_id>]"HistogramFlush时MemTable大小
flushing_mem_table_statusname="total_point_num" region="DataRegion[<data_region_id>]"HistogramFlush时MemTable中point数量
flushing_mem_table_statusname="series_num" region="DataRegion[<data_region_id>]"HistogramFlush时MemTable中series数量
flushing_mem_table_statusname="avg_series_points_num" region="DataRegion[<data_region_id>]"HistogramFlush时该memTable内平均每个Memchunk中的point数量
flushing_mem_table_statusname="tsfile_compression_ratio" region="DataRegion[<data_region_id>]"HistogramFlush MemTable时对应的TsFile的压缩率
flushing_mem_table_statusname="flush_tsfile_size" region="DataRegion[<data_region_id>]"HistogramFlush的MemTable对应的TsFile大小
data_region_mem_costname="data_region_mem_cost"AutoGaugeDataRegion内存占用

4.3. Normal 级别监控指标

4.3.1. 集群

MetricTagsTypeDescription
regionname="{DatabaseName}",type="SchemaRegion/DataRegion"AutoGauge特定节点上不同 Database 的 DataRegion/SchemaRegion 个数
slotname="{DatabaseName}",type="schemaSlotNumber/dataSlotNumber"AutoGauge特定节点上不同 Database 的 DataSlot/SchemaSlot 个数

4.4. All 级别监控指标

目前还没有All级别的监控指标,后续会持续添加。

5. 怎样获取这些系统监控?

  • 监控模块的相关配置均在conf/iotdb-{datanode/confignode}.properties中,所有配置项支持通过load configuration命令热加载。

5.1. 使用 JMX 方式

对于使用 JMX 对外暴露的指标,可以通过 Jconsole 来进行查看。在进入 Jconsole 监控页面后,首先会看到 IoTDB
的各类运行情况的概览。在这里,您可以看到堆内存信息、线程信息、类信息以及服务器的 CPU 使用情况。

5.1.1. 获取监控指标数据

连接到 JMX 后,您可以通过 "MBeans" 标签找到名为 "org.apache.iotdb.metrics" 的 "MBean",可以在侧边栏中查看所有监控指标的具体值。

metric-jmx

5.1.2. 获取其他相关数据

连接到 JMX 后,您可以通过 "MBeans" 标签找到名为 "org.apache.iotdb.service" 的 "MBean",如下图所示,了解服务的基本状态


为了提高查询性能,IOTDB 对 ChunkMetaData 和 TsFileMetaData 进行了缓存。用户可以使用 MXBean
,展开侧边栏org.apache.iotdb.db.service查看缓存命中率:

5.2. 使用 Prometheus 方式

5.2.1. 监控指标的 Prometheus 映射关系

对于 Metric Name 为 name, Tags 为 K1=V1, ..., Kn=Vn 的监控指标有如下映射,其中 value 为具体值

监控指标类型映射关系
Countername_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
AutoGauge、Gaugename{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
Histogramname_max{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_sum{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_count{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.5"} value
name{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.99"} value
Ratename_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m1"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m5"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="m15"} value
name_total{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", rate="mean"} value
Timername_seconds_max{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_sum{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds_count{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn"} value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.5"} value value
name_seconds{cluster="clusterName", nodeType="nodeType", nodeId="nodeId",k1="V1" , ..., Kn="Vn", quantile="0.99"} value

5.2.2. 修改配置文件

  1. 以 DataNode 为例,修改 iotdb-datanode.properties 配置文件如下:
dn_metric_reporter_list=PROMETHEUS
dn_metric_level=CORE
dn_metric_prometheus_reporter_port=9091
  1. 启动 IoTDB DataNode

  2. 打开浏览器或者用curl 访问 http://servier_ip:9091/metrics, 就能得到如下 metric 数据:

...
# HELP file_count
# TYPE file_count gauge
file_count{name="wal",} 0.0
file_count{name="unseq",} 0.0
file_count{name="seq",} 2.0
...

5.2.3. Prometheus + Grafana

如上所示,IoTDB 对外暴露出标准的 Prometheus 格式的监控指标数据,可以使用 Prometheus 采集并存储监控指标,使用 Grafana
可视化监控指标。

IoTDB、Prometheus、Grafana三者的关系如下图所示:

iotdb_prometheus_grafana
iotdb_prometheus_grafana
  1. IoTDB在运行过程中持续收集监控指标数据。
  2. Prometheus以固定的间隔(可配置)从IoTDB的HTTP接口拉取监控指标数据。
  3. Prometheus将拉取到的监控指标数据存储到自己的TSDB中。
  4. Grafana以固定的间隔(可配置)从Prometheus查询监控指标数据并绘图展示。

从交互流程可以看出,我们需要做一些额外的工作来部署和配置Prometheus和Grafana。

比如,你可以对Prometheus进行如下的配置(部分参数可以自行调整)来从IoTDB获取监控数据

job_name: pull-metrics
honor_labels: true
honor_timestamps: true
scrape_interval: 15s
scrape_timeout: 10s
metrics_path: /metrics
scheme: http
follow_redirects: true
static_configs:
  - targets:
      - localhost:9091

更多细节可以参考下面的文档:

Prometheus安装使用文档open in new window

Prometheus从HTTP接口拉取metrics数据的配置说明open in new window

Grafana安装使用文档open in new window

Grafana从Prometheus查询数据并绘图的文档open in new window

5.2.4. Apache IoTDB Dashboard

我们提供了Apache IoTDB Dashboard,在Grafana中显示的效果图如下所示:

Apache IoTDB Dashboard
Apache IoTDB Dashboard

你可以在企业版中获取到 Dashboard 的 Json文件。

5.3. 使用 IoTDB 方式

5.3.1. 监控指标的 IoTDB 映射关系

对于 Metric Name 为 name, Tags 为 K1=V1, ..., Kn=Vn 的监控指标有如下映射,以默认写到 root.__system.metric.clusterName.nodeType.nodeId 为例

监控指标类型映射关系
Counterroot.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.value
AutoGauge、Gaugeroot.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.value
Histogramroot.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.count
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.max
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.sum
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p0
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p50
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p75
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p99
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p999
Rateroot.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.count
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.mean
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.m1
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.m5
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.m15
Timerroot.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.count
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.max
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.mean
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.sum
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p0
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p50
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p75
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p99
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.p999
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.m1
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.m5
root.__system.metric.clusterName.nodeType.nodeId.name.K1=V1...Kn=Vn.m15

5.3.2. 获取监控指标

根据如上的映射关系,可以构成相关的 IoTDB 查询语句获取监控指标

Copyright © 2024 The Apache Software Foundation.
Apache and the Apache feather logo are trademarks of The Apache Software Foundation

Have a question? Connect with us on QQ, WeChat, or Slack. Join the community now.

We use Google Analytics to collect anonymous, aggregated usage information.