监控告警

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

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

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

1. 系统变慢了

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

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

这时候我们迫切想知道最近一段时间数据文件的增长情况，看看是不是某种文件有突增。 3. 系统运行是否正常

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

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

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

3. 什么是监控指标？

3.1. 监控指标名词解释

在 IoTDB 的监控模块，每个监控指标被 Metric Name 和 Tags 唯一标识。

• 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. 集群运行状态

4.1.2. 接口层统计

4.1.3. 节点统计

4.1.4. 集群全链路

4.1.5. 任务统计

4.1.6. IoTDB 进程运行状态

4.1.7. 系统运行状态

4.1.8. IoTDB 日志统计

4.1.9. 文件统计信息

4.1.10. JVM 内存统计

4.1.11. JVM 线程统计

4.1.12. JVM GC 统计

4.2. Important 级别监控指标

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

4.2.1. 节点统计

4.2.2. Ratis共识协议统计

4.2.3. IoT共识协议统计

4.2.4. 缓存统计

4.2.5. 内存统计

4.2.6. 合并统计

4.2.7. IoTDB 进程统计

4.2.8. JVM 类加载统计

4.2.9. JVM 编译时间统计

4.2.10. 查询规划耗时统计

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

4.2.12. 查询资源访问统计

4.2.13. 数据传输模块统计

4.2.14. 查询任务调度统计

4.2.15. 查询执行耗时统计

4.2.16 元数据引擎统计

4.3. Normal 级别监控指标

4.3.1. 集群

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”，可以在侧边栏中查看所有监控指标的具体值。

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 为具体值

5.2.2. 修改配置文件

1. 以 DataNode 为例，修改 iotdb-datanode.properties 配置文件如下：

1. dn_metric_reporter_list=PROMETHEUS
2. dn_metric_level=CORE
3. dn_metric_prometheus_reporter_port=9091

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

1. ...
2. # HELP file_count
3. # TYPE file_count gauge
4. file_count{name="wal",} 0.0
5. file_count{name="unseq",} 0.0
6. file_count{name="seq",} 2.0
7. ...

5.2.3. Prometheus + Grafana

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

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

iotdb_prometheus_grafana

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

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

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

1. job_name: pull-metrics
2. honor_labels: true
3. honor_timestamps: true
4. scrape_interval: 15s
5. scrape_timeout: 10s
6. metrics_path: /metrics
7. scheme: http
8. follow_redirects: true
9. static_configs:
10. - targets:
11. - 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

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

5.3. 使用 IoTDB 方式

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

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

5.3.2. 获取监控指标

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