嘉为蓝鲸WeOps 4.17 内容说明

1、资源模型内置说明

操作系统、数据库、中间件、容器等对象进行资源模型内置，具体模型、字段、自动发现和采集能力详见列表

查看资产和模型字段的具体信息，点击可下载WeOps内置的模型说明表格，包括WeOps初始化内置的资产模型和字段，以及自动发现和采集能力。

1.1 操作系统模型内置情况

类型	纳管对象	内置模型字段	自动发现采集情况
操作系统	Windows Server	详见表格【WeOps内置的模型说明表格】	使用Agent采集配置数据
操作系统	linux	详见表格【WeOps内置的模型说明表格】	使用Agent采集配置数据

1.2 数据库模型内置情况

类型	纳管对象	内置模型字段	自动发现采集情况
数据库	Oracle	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
数据库	MySQL	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
数据库	MSSQL	详见表格【WeOps内置的模型说明表格】
数据库	REDIS	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
数据库	MongoDB	详见表格【WeOps内置的模型说明表格】
数据库	ElasticSearch	详见表格【WeOps内置的模型说明表格】
数据库	PostgreSQL	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
数据库	DB2	详见表格【WeOps内置的模型说明表格】
数据库	TiDB	详见表格【WeOps内置的模型说明表格】
数据库	达梦	详见表格【WeOps内置的模型说明表格】
数据库	openGauss	详见表格【WeOps内置的模型说明表格】
数据库	Gbase8a	详见表格【WeOps内置的模型说明表格】
数据库	HANA	详见表格【WeOps内置的模型说明表格】
数据库	HBase	详见表格【WeOps内置的模型说明表格】
数据库	数据库集群	详见表格【WeOps内置的模型说明表格】

1.3 中间件模型内置情况

类型	纳管对象	内置模型字段	自动发现采集情况
中间件	Apache	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	Tomcat	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	Nginx	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	IIS	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	RabbitMQ	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	WebLogic	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	Kafka	详见表格【WeOps内置的模型说明表格】
中间件	IBM MQ	详见表格【WeOps内置的模型说明表格】
中间件	ZooKeeper	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	Minio	详见表格【WeOps内置的模型说明表格】
中间件	Nacos	详见表格【WeOps内置的模型说明表格】
中间件	WebLogic	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	Websphere	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	ActiveMQ	详见表格【WeOps内置的模型说明表格】
中间件	jetty	详见表格【WeOps内置的模型说明表格】
中间件	MemCache	详见表格【WeOps内置的模型说明表格】
中间件	JBoss	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	etcd	详见表格【WeOps内置的模型说明表格】	支持自动发现
中间件	Consul	详见表格【WeOps内置的模型说明表格】
中间件	RocketMQ	详见表格【WeOps内置的模型说明表格】
中间件	Keepalived	详见表格【WeOps内置的模型说明表格】
中间件	Spark	详见表格【WeOps内置的模型说明表格】
中间件	HAProxy	详见表格【WeOps内置的模型说明表格】
中间件	Ceph	详见表格【WeOps内置的模型说明表格】

1.4 K8S模型内置情况

类型	纳管对象	内置模型字段	自动发现采集情况
K8S	K8S集群	详见表格【WeOps内置的模型说明表格】
K8S	K8S命名空间	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
K8S	K8S工作负载	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
K8S	Pod	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
K8S	Node	详见表格【WeOps内置的模型说明表格】	支持自动发现采集

1.5 云平台模型内置情况

类型	纳管对象	内置模型字段	自动发现采集情况
VMware	Vcenter	详见表格【WeOps内置的模型说明表格】
VMware	VMware虚拟机	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
VMware	ESXI	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
VMware	数据存储	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云账号	详见表格【WeOps内置的模型说明表格】
阿里云	ECS	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云域名	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云解析记录	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云CDN	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云Web应用防火墙	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云SSL证书	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云对象存储Bucket	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云MySQL	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云Redis	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云MongoDB	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云Kafka实例	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云Kafka消费组	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云Kafka主题	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云CLB	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云K8S集群	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云EIP	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云MSE集群	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云MSE服务	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
阿里云	阿里云MSE实例	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
腾讯云	腾讯云账号	详见表格【WeOps内置的模型说明表格】
腾讯云	CVM	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
华为云	ManageOne平台	详见表格【WeOps内置的模型说明表格】
华为云	ManageOne云服务器	详见表格【WeOps内置的模型说明表格】	支持自动发现采集
华为云	ManageOne宿主机	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
华为云	ManageOne数据存储	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
华为云	ManageOne云平台	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
华为云	华为云账号	详见表格【WeOps内置的模型说明表格】
华为云	华为云ECS	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
深信服超融合（SangforHCI）	SangforHCI平台	详见表格【WeOps内置的模型说明表格】
深信服超融合（SangforHCI）	SangforHCI虚拟机	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
华为大数据平台	FusionInsight平台	详见表格【WeOps内置的模型说明表格】
华为大数据平台	FusionInsight集群	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
华为大数据平台	FusionInsight主机	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI集群	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI物理机	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI虚拟机	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI存储池	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI存储容器	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI卷组	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI虚拟磁盘	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
路坦力超融合（NutanixHCI）	NutanixHCI磁盘	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
OpenStack	OpenStack平台	见表格【WeOps内置的模型说明表格】
OpenStack	OpenStack节点	见表格【WeOps内置的模型说明表格】	支持自动发现和采集
OpenStack	OpenStack虚拟机	见表格【WeOps内置的模型说明表格】	支持自动发现和采集
OpenStack	OpenStack卷组	见表格【WeOps内置的模型说明表格】	支持自动发现和采集
OpenStack	OpenStack存储池	见表格【WeOps内置的模型说明表格】	支持自动发现和采集
SmartX	SmartX平台	详见表格【WeOps内置的模型说明表格】
SmartX	SmartX集群	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
SmartX	SmartX物理机	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
SmartX	SmartX虚拟机	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
SmartX	SmartX虚拟卷	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS账号	详见表格【WeOps内置的模型说明表格】
AWS	AWS EC2	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS RDS	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS MSK集群	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS ElastiCache	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS EKS集群	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS CloudFront分配	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS ELB	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集
AWS	AWS S3 Bucket	详见表格【WeOps内置的模型说明表格】	支持自动发现和采集

1.6 基础设备模型内置情况

类型	纳管对象	内置模型字段	自动发现采集情况
基础设备	交换机	实例名、管理IP、管理端口、型号、SNMP版本、品牌	支持自动发现采集，自动发现采集字段如下: 实例名、管理IP、管理端口、型号、SNMP版本、品牌
基础设备	路由器	实例名、管理IP、管理端口、SNMP版本、型号、品牌	支持自动发现采集，自动发现采集字段如下: 实例名、管理IP、管理端口、SNMP版本、型号、品牌
基础设备	防火墙设备	实例名、管理IP、管理端口、型号、SNMP版本、品牌	支持自动发现采集，自动发现采集字段如下: 实例名、管理IP、管理端口、型号、SNMP版本、品牌
基础设备	负载均衡设备	实例名、管理IP、管理端口、SNMP版本、型号、品牌	支持自动发现采集，自动发现采集字段如下: 实例名、管理IP、管理端口、型号、SNMP版本、品牌
基础设备	物理机	实例名、IP地址、型号、类型、硬盘大小、CPU型号、型号、品牌、sn设备序列号、网卡数量、内存大小、MAC地址、维护人、过保日期、存放地点、资产编号
基础设备	网络设备端口	实例名、品牌

1.7 硬件设备模型内置情况

类型	纳管对象	内置模型字段
硬件设备	硬件服务器	详见表格【WeOps内置的模型说明表格】
硬件设备	存储	详见表格【WeOps内置的模型说明表格】
硬件设备	安全设备	详见表格【WeOps内置的模型说明表格】

1.8 Docker

类型	纳管对象	内置模型字段
Docker	Docker	详见表格【WeOps内置的模型说明表格】
Docker	Docker容器	详见表格【WeOps内置的模型说明表格】
Docker	Docker镜像	详见表格【WeOps内置的模型说明表格】
Docker	Docker网络	详见表格【WeOps内置的模型说明表格】
Docker	Docker卷	详见表格【WeOps内置的模型说明表格】

1.9 其他模型内置情况

类型	纳管对象	内置模型字段
目录服务	AD	详见表格【WeOps内置的模型说明表格】
邮件服务	Exchange Server	详见表格【WeOps内置的模型说明表格】
证书	SSL证书	详见表格【WeOps内置的模型说明表格】

2、监控指标说明

2.1 各对象支持监控方式汇总

对象类型	对象名称	支持的监控方式
操作系统	linux、Windows等	1、Agent采集 2、自定义脚本监控插件（shell、powershell）
数据库	Oracle、MySQL、MSSQL	1、内置监控插件 2、自定义脚本监控插件（shell、powershell） 3、SQL监控插件
	MongoDB、Redis、PGSQL、其他扩展数据库	1、内置监控插件 2、自定义脚本监控插件（shell、powershell）
中间件	Apache、Nginx、Tomcat...	1、内置监控插件 2、自定义脚本监控插件（shell、powershell、BK-pull）
云平台	阿里云、腾讯云、华为公有云......	1、内置监控插件
K8S	node、pod	1、内置监控插件
网络设备snmp	交换机、路由器、防火墙、负载均衡	1、内置监控插件 2、自定义SNMP监控模板
硬件设备IPMI	硬件服务器.....	1、内置IPMI监控插件 2、自定义SNMP监控模板

操作系统、数据库、中间件等对象内置监控插件的监控指标，具体如下表。（部分对象已经内置监控插件、内置关键指标、内置监控策略详见列表）

点击可下载WeOps内置的监控指标说明表格，包括WeOps初始化内置的资产指标、指标说明和推荐阈值等信息

2.2 各对象监控说明

1 操作系统监控指标

序号	对象类型	指标数量	指标/事件	内置监控插件	内置监控策略
1	操作系统-Windows	97	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
2	操作系统-Linux	97	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】

2 数据库监控指标

序号	对象类型	指标数量	指标/事件	内置监控插件	内置监控策略
1	数据库-MySQL	21	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
2	数据库-MSSQL	20	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
3	数据库-Oracle	25	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
4	数据库-MongoDB	27	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
5	数据库-Redis	30	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
6	数据库-PGSQL	74	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
7	数据库-MongoDB	74	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
8	数据库-ElasticSearch		详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
9	数据库-TiDB		详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
10	数据库-达梦数据库		详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
11	数据库-openGauss		详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
12	数据库-Gbase8a		详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
13	数据库-HANA		详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】

3 中间件监控指标

序号	对象类型	指标数量	指标/事件	内置关键指标	内置监控插件	内置监控策略
1	中间件-Tomcat		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
2	中间件-Nginx	8	详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
3	中间件-Apache		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
4	中间件-IIS		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
5	中间件-Kafka		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
6	中间件-RabbitMQ		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
7	中间件-IBM MQ		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
8	中间件-ZooKeeper		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
9	中间件-WebLogic		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
10	中间件-Websphere		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
11	中间件-Nacos		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
12	中间件-Minio		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
13	中间件-JBoss		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】
14	中间件-etcd		详见【WeOps内置的监控指标说明表格】	详见【WeOps内置的监控指标说明表格】	已内置监控插件	详见【WeOps内置的监控指标说明表格】

4 K8S监控指标

序号	对象类型	指标数量	指标
1	K8S-Pod	17	详见【WeOps内置的监控指标说明表格】
2	K8S-Node	14	详见【WeOps内置的监控指标说明表格】
3	K8S-K8S集群	/	详见【WeOps内置的监控指标说明表格】

5 云平台监控指标

序号	云平台	类型	指指标
1	VMware	数据存储、ESXI、虚拟机	详见【WeOps内置的监控指标说明表格】
2	阿里云	ECS、CDN、Web应用防火墙、对象存储Bucket、MySQL、Redis、MongoDB、Kafka、EIP	详见【WeOps内置的监控指标说明表格】
3	腾讯云	CVM、MySQL、RocketMQ、TKEServerless	详见【WeOps内置的监控指标说明表格】
4	华为云-manageone	云服务器、云平台、宿主机、存储、弹性IP、负载均衡	详见【WeOps内置的监控指标说明表格】
5	华为公有云	华为云ECS	详见【WeOps内置的监控指标说明表格】
6	深信服超融合	SangforHCI虚拟机	详见【WeOps内置的监控指标说明表格】
7	NutanixHCI（路坦力）	虚拟机、物理机、磁盘、虚拟磁盘、存储容器、存储池、卷组	详见【WeOps内置的监控指标说明表格】
8	华为FusionInsight	集群、云服务器	详见【WeOps内置的监控指标说明表格】
9	OPenStack	节点、虚拟机、存储池	详见【WeOps内置的监控指标说明表格】
10	SmartX	物理机、虚拟机、虚拟卷	详见【WeOps内置的监控指标说明表格】
11	AWS	EC2、RDS、Elasticache	详见【WeOps内置的监控指标说明表格】

6 网络设备监控指标

以下展示的是内置的网络设备指标模板，WeOps提供拓展能力，可支持不同品牌和型号的设备（通过自定义监控模板的方式进行能力拓展）。

序号	对象类型	模板数量	指标
1	防火墙	12	详见【WeOps内置的监控指标说明表格】
2	交换机	58	详见【WeOps内置的监控指标说明表格】
3	路由器	10	详见【WeOps内置的监控指标说明表格】
4	负载均衡	5	详见【WeOps内置的监控指标说明表格】

7 硬件设备监控指标

序号	对象类型	模板数量	指标
1	硬件服务器	10	详见【WeOps内置的监控指标说明表格】
2	存储	14	详见【WeOps内置的监控指标说明表格】
3	安全设备	4	详见【WeOps内置的监控指标说明表格】

8 Docker监控指标

序号	对象类型	指标数量	指标
1	Docker	/	详见【WeOps内置的监控指标说明表格】

9 其他监控指标

序号	对象类型	指标数量	指标/事件	内置监控插件
1	进程	15	详见【WeOps内置的监控指标说明表格】	已内置监控指标
2	拨测	12	详见【WeOps内置的监控指标说明表格】	已内置监控指标
3	Active Directory活动目录		详见【WeOps内置的监控指标说明表格】	已内置监控指标
4	Exchange邮件系统		详见【WeOps内置的监控指标说明表格】	已内置监控插件

3、监控插件参数和权限说明

WeOps监控插件使用的参数和授予权限说明如下

3.1 MSSQL

使用说明

插件功能

基于配置连接数据库并从中收集指标，其收集的指标及其采集、生成方式均由配置文件定义。

插件版本

适用于插件版本V3.1.2，其他版本插件说明详见： sql-exporter

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

主版本号	次版本号	指标支持
2008	10.x	-
2008 R2	10.5	-
2012	11.x	-
2014	12.x	-
2016	13.x	✔
2017	14.x	✔
2019	15.x	✔
2022	16.x	✔

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
-host	数据库主机IP	是	127.0.0.1
-port	数据库服务端口	是	1433
SQLSERVERUSER	数据库用户名(环境变量)	是	SA
SQLSERVERPASSWORD	数据库密码(环境变量)	是
-config.file	sql_exporter.yml 采集器全局配置文件, 包含超时设置、最大连接数、目标配置、采集指标配置文件名等	是	默认已有采集器全局配置文件
-log.level	日志级别	否	info
-web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
collector.file.content	mssql_standard.collector.yml 采集指标配置文件, 包含指标名、维度、sql等内容。注意！该参数为文件参数，非探针执行文件参数！	是	默认已有标准采集指标配置文件

采集器全局配置文件说明(sql_exporter.yml)

# 全局配置
global:
  # sql语句的超时时间，这个值需要比prometheus的 `scrape_timeout` 值要小。如果配置了下方的 scrape_timeout_offset 值，那么最终的超时时间为， min(scrape_timeout, X-Prometheus-Scrape-Timeout-Seconds - scrape_timeout_offset)
  # X-Prometheus-Scrape-Timeout-Seconds 为 prometheus 的超时时间
  scrape_timeout: 10s
  # 从 prometheus 的超时时间中减去一个偏移量，防止 prometheus 先超时。
  scrape_timeout_offset: 500ms
  # 各个sql收集器之间运行间隔的秒数
  min_interval: 0s
  # 允许获取到的数据库最大的连接数， <=0 表示不限制。
  max_connections: 3
  # 允许空闲连接数的个数，<=0 不做限制
  max_idle_connections: 3

# 配置监控的数据库和抓取信息
target:
  # 配置数据库链接信息
  # sqlserver://user(用户名):password(密码)@127.0.0.1(数据库服务域名或者IP):1433(数据库服务端口号)
  data_source_name: "sqlserver://user:password@127.0.0.1:1433"
  # 收集器的名字, 对应下方 collector_files 中文件的 collector_name 的值
  collectors: [mssql_*]
collector_files: 
  - "*.collector.yml"

采集指标配置文件(mssql_standard.collector.yml)

# 收集器的名字
collector_name: mssql_standard

metrics:
  - metric_name: mssql_version # 指标ID
    type: counter # 类型
    help: 'Fetched version of instance.' # 描述
    key_labels: # 维度值
      - ProductVersion
    values: [value] # 值
    query: | # sql语句
      SELECT CONVERT(VARCHAR(128), SERVERPROPERTY ('productversion')) AS ProductVersion, 1 AS value

使用指引

以下是在SQL Server中使用命令行创建监控用户的教程：

方式一:

连接到 MSSQL 数据库服务器，并使用具有足够权限的管理员用户帐户登录。
在 SQL Server Management Studio 中，右键单击 Security，然后选择 "New Login"。
在 "Login - New" 对话框中，输入监控用户的用户名，选择 "SQL Server authentication" 作为登录类型，并设置一个强密码。
在 "Default database" 下拉菜单中，选择用户需要访问的数据库，一般默认master即可。
在 "Server Roles" 选项卡中，选择 "public" 角色。
在 "User Mapping" 选项卡中，将需要访问的数据库分配给该用户。
单击 "OK" 按钮以创建该用户。

在 MSSQL exporter 的配置文件中，使用此监控用户的凭据访问数据库。

方式二: 通过终端与数据库交互

打开命令提示符或PowerShell，使用sqlcmd命令连接到SQL Server，如下所示：
```
sqlcmd -S server_address -U sa -P your_password
```
其中，server_address是SQL Server的访问地址，sa是具有足够权限的SQL Server管理员的登录名，your_password是对应的密码。
使用以下命令创建监控用户，该用户只具有读取权限，允许用户查看所有对象的定义：
```
CREATE LOGIN monitoring_user WITH PASSWORD = 'your_password';
GRANT VIEW SERVER STATE TO monitoring_user;
GRANT VIEW ANY DEFINITION TO monitoring_user;
GO
```
其中，monitoring_user是监控用户的名称，your_password是对应的密码。
如果需要在特定的数据库中监控，请使用以下命令授予监控用户对该数据库的访问权限：
```
USE database_name;
CREATE USER monitoring_user FOR LOGIN monitoring_user;
ALTER ROLE db_datareader ADD MEMBER monitoring_user;
GO
```
其中，database_name是要监控的数据库的名称，一般默认使用master。

3.2 MySQL

使用说明

插件功能

采集器会定期执行SQL查询语句，例如 show global status 和 show slave status 等，获取相应的指标数据。

插件版本

适用于插件版本V4.2.4，其他版本插件说明详见： mysql-exporter

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本

MySQL >= 5.6

MariaDB >= 10.3

是否支持远程采集

是

参数说明

参数名	含义	是否必填	使用举例
MYSQL_USER	mysql登录账户名(环境变量)	是	monitor
MYSQL_PASSWORD	mysql登录账户名的密码(环境变量)	是	Monitor123!
--mysqld.host	mysql服务地址	是	127.0.0.1
--mysqld.port	mysql服务端口号	是	3306
--log.level	日志级别	否	info
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601

使用指引

连接MySQL

mysql -u[username] -p[password] -h[host] -P[port]

创建账户及授权

CREATE USER '[username]'@'%' IDENTIFIED BY '[password]'; GRANT PROCESS, SELECT, REPLICATION CLIENT ON *.* TO '[username]'@'%';

在 MariaDB 10.5+ 版本中，为了支持增量备份，引入了一种新的权限 REPLICA MONITOR。该权限允许用户监视复制进程，并查询与备份有关的信息。

当 mysql exporter 用于监控 MariaDB 10.5+ 版本的数据库时，它需要使用 REPLICA MONITOR 权限来获取与备份有关的信息。如果没有授予监控用户 REPLICA MONITOR 权限，则无法获取这些信息，导致监控数据不完整或无法正常工作。因此，在 MariaDB 10.5+ 版本中，需要使用 GRANT 命令为监控用户授予 REPLICA MONITOR 权限。

GRANT REPLICA MONITOR ON *.* TO '[username]'@'%';

3.3 Oracle

使用说明

插件功能

采集器连接oracle数据库，执行SQL查询语句，将结果解析到prometheus数据格式的监控指标。实际收集的指标取决于数据库的配置和版本。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

Oracle Database: 11g, 12c, 18c, 19c, 21c

部署模式支持: standalone(单点), RAC(集群), dataGuard(DG)

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
--host	数据库主机IP	是	127.0.0.1
--port	数据库服务端口	是	1521
USER	数据库用户名(环境变量)	是
PASSWORD	数据库密码(环境变量)	是
SERVICE_NAME	数据库服务名(环境变量)	是	ORCLCDB
--isRAC	是否为rac集群架构(开关参数), 默认不开启	否
--isASM	是否有ASM磁盘组(开关参数), 默认不开启	否
--isDataGuard	是否为DataGuard(开关参数), 默认不开启	否
--isArchiveLog	是否采集归档日志指标, 默认不开启	否
--query.timeout	查询超时秒数，默认使用5s	否	5
--log.level	日志级别	否	info
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601

使用指引

查看Oracle数据库服务名和域名注意！对于oracle数据库12版本，DSN中数据库名后必须加入域名，其他版本一般不需要ORCLCDB是Oracle数据库的一个服务名称（Service Name），它用于唯一标识数据库实例中的一个服务。例: "oracle://system:Weops123!@db12c-oracle-db.oracle:1521/ORCLCDB.localdomain"
- 查看当前数据库实例的 SERVICE_NAME 参数的值。
```
SELECT value FROM v$parameter WHERE name = 'service_names';
```
- 查看当前数据库实例的 DB_DOMAIN 参数的值。如果返回结果为空，表示未设置特定的域名。
```
SELECT value FROM v$parameter WHERE name = 'db_domain';
```
若出现unknown service error
- 需检查监听器的当前状态，确保监听器正在运行并监听正确的端口，运行命令 lsnrctl status。
- 确认监听器配置文件（lsnrctl status会输出监听器配置状态等信息，寻找配置文件，通常是 listener.ora）中是否正确定义了服务名称，并与您尝试连接的服务名称匹配。
- lsnrctl 在oracle数据库12版本中，此命令一般存放于 /u01/app/oracle/product/12.2.0/dbhome_1/ ；在oracle数据库19版本中，一般存放于 /opt/oracle/product/19c/dbhome_1/bin
连接Oracle数据库使用操作系统的身份认证（通常是超级用户或管理员），直接以 sysdba 角色登录到数据库
```
sqlplus / as sysdba
```
使用指定账户登录
```
sqlplus username/password@host:port/service_name
```
创建账户及授权
注意！创建账户时必须使用管理员账户
创建账户类型有区别:
a) 在Oracle数据库中，使用C##前缀是为了创建一个包含大写字母和特殊字符的用户名，这样可以确保在创建和使用这些用户时不会发生命名冲突。C##前缀表示"Container Database"，用于标识这个用户是一个全局共享的用户，而不是只属于某个具体的Pluggable Database (PDB)。
b) 要决定是否在用户名前使用C##，主要取决于数据库的架构。在Oracle 12c及更高版本中，数据库被分为一个容器数据库（CDB）和一个或多个可插拔数据库（PDB）。如果你在CDB层面创建用户，可以选择使用C##前缀，表示这个用户是一个全局共享的用户。如果在PDB层面创建用户，通常不需要使用C##前缀，因为PDB内的用户空间是相互隔离的。
c) 在创建用户时是否使用C##前缀取决于你的特定需求和数据库架构。如果你的用户需要在不同的PDB之间共享，并且你希望避免命名冲突，那么可以考虑使用C##前缀。如果用户只在特定的PDB中使用，可能不需要这个前缀。
d) 使用 C## 前缀的情况：
CREATE USER C##GlobalUser IDENTIFIED BY password CONTAINER = ALL;
e) 不使用 C## 前缀的情况：
CREATE USER LocalUser IDENTIFIED BY password;

# 新建用户
CREATE USER [user] IDENTIFIED BY [password];

# 修改用户的密码，密码若含特殊字符需使用双引号将密码括起来
ALTER USER [user] IDENTIFIED BY [password];

# 允许用户建立数据库会话
GRANT CREATE SESSION TO [user];

# uptime指标授权
GRANT SELECT ON V_$instance to [user];

# rac指标授权
GRANT SELECT ON GV_$instance to [user];

# sessions类指标授权
GRANT SELECT ON V_$session to [user];

# resource类指标授权
GRANT SELECT ON V_$resource_limit to [user];

# asm_diskgroup类指标授权
GRANT SELECT ON V_$datafile to [user];
GRANT SELECT ON V_$asm_diskgroup_stat to [user];

# activity类指标授权
GRANT SELECT ON V_$sysstat to [user];

# process类指标授权
GRANT SELECT ON V_$process to [user];

# wait_time类指标授权
GRANT SELECT ON V_$waitclassmetric to [user];
GRANT SELECT ON V_$system_wait_class to [user];

# tablespace类指标授权
GRANT SELECT ON dba_tablespace_usage_metrics to [user];
GRANT SELECT ON dba_tablespaces to [user];

# asm_disk_stat类指标授权
GRANT SELECT ON V_$asm_disk_stat to [user];
GRANT SELECT ON V_$asm_diskgroup_stat to [user];
GRANT SELECT ON V_$instance to [user];

# asm_space_consumers类指标授权
GRANT SELECT ON V_$asm_alias to [user];
GRANT SELECT ON V_$asm_diskgroup to [user];
GRANT SELECT ON V_$asm_file to [user];

# sga类指标授权
GRANT SELECT ON V_$sga TO [user];
GRANT SELECT ON V_$sgastat TO [user];

# pga类指标授权
GRANT SELECT ON V_$pgastat TO [user];

# dataguard类指标授权
GRANT SELECT ON V_$dataguard_stats TO [user];

# archived_log类指标授权
GRANT SELECT ON V_$database to [user];
GRANT SELECT ON V_$archive_dest to [user];
GRANT SELECT ON V_$parameter to [user];
GRANT SELECT ON V_$asm_diskgroup to [user];

3.4 postgres

使用说明

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

PostgreSQL: 9.4, 9.5, 9.6, 10, 11, 12, 13, 14, 15

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
DATA_SOURCE_HOST	数据库主机IP(环境变量)	是	127.0.0.1
DATA_SOURCE_PORT	数据库服务端口(环境变量)	是	5432
DATA_SOURCE_USER	数据库用户名(环境变量)	是	postgres
DATA_SOURCE_PASS	数据库密码(环境变量)	是
DATA_SOURCE_DB	数据库库名(环境变量)	是	postgres
--collector.postmaster	postmaster采集器开关(开关参数)，默认关闭	否
--collector.stat_statements	stat_statements采集器开关(开关参数)，默认关闭	否
--collector.stat_statements	stat_statements采集器开关(开关参数)，默认关闭	否
--collector.xlog_location	xlog_location采集器开关(开关参数)，默认关闭	否
--log.level	日志级别	否	info
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
additional	额外参数，可留空内容	否	--disable-default-metrics

注意一般连接的数据库名都需要填写为 postgres

额外参数说明

额外参数(additional)不需要赋值，只需要填写对应内容，作为采集器的功能或者采集指标的开关，postgreSQL插件支持的额外参数如下:

不采集默认指标，只保留自定义指标采集文件中的指标 --disable-default-metrics
不采集配置(Setting)类，pg_settings前缀开头的指标 --disable-settings-metrics
不采集后台写入器(Bgwriter)类，pg_stat_bgwriter前缀开头的指标 --no-collector.bgwriter
不采集复制槽信息，replication_slot前缀开头的指标 --no-collector.replication_slot

使用指引

连接Postgres数据库输入连接指令后输入对应的密码即可进入数据库。
```
psql -U [user] -h [host] -p [port] -d [database]
```

创建账户及授权执行下方sql可以创建具有监控权限的账户，用户名 weops，密码 Weops123!。 注意! 数据库版本 >= 10才需要执行 GRANT pg_monitor TO weops; ，9.x版本无法执行该授权。

CREATE OR REPLACE FUNCTION __tmp_create_user() returns void as $$
BEGIN
  IF NOT EXISTS (
          SELECT                       -- SELECT list can stay empty for this
          FROM   pg_catalog.pg_user
          WHERE  usename = 'weops') THEN
    CREATE USER weops;
  END IF;
END;
$$ language plpgsql;

SELECT __tmp_create_user();
DROP FUNCTION __tmp_create_user();

ALTER USER weops WITH PASSWORD 'Weops123!';
ALTER USER weops SET SEARCH_PATH TO weops,pg_catalog;

GRANT CONNECT ON DATABASE postgres TO weops;

GRANT pg_monitor TO weops;  -- 数据库版本 >= 10 才需要执行这条sql

CREATE SCHEMA IF NOT EXISTS weops;
GRANT USAGE ON SCHEMA weops TO weops;

CREATE OR REPLACE FUNCTION get_pg_stat_activity() RETURNS SETOF pg_stat_activity AS
$$ SELECT * FROM pg_catalog.pg_stat_activity; $$
LANGUAGE sql
VOLATILE
SECURITY DEFINER;

CREATE OR REPLACE VIEW weops.pg_stat_activity
AS
  SELECT * from get_pg_stat_activity();

GRANT SELECT ON weops.pg_stat_activity TO weops;

CREATE OR REPLACE FUNCTION get_pg_stat_replication() RETURNS SETOF pg_stat_replication AS
$$ SELECT * FROM pg_catalog.pg_stat_replication; $$
LANGUAGE sql
VOLATILE
SECURITY DEFINER;

CREATE OR REPLACE VIEW weops.pg_stat_replication
AS
  SELECT * FROM get_pg_stat_replication();

GRANT SELECT ON weops.pg_stat_replication TO weops;

CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
CREATE OR REPLACE FUNCTION get_pg_stat_statements() RETURNS SETOF pg_stat_statements AS
$$ SELECT * FROM public.pg_stat_statements; $$
LANGUAGE sql
VOLATILE
SECURITY DEFINER;

CREATE OR REPLACE VIEW weops.pg_stat_statements
AS
  SELECT * FROM get_pg_stat_statements();

GRANT SELECT ON weops.pg_stat_statements TO weops; 

3.5 Redis

使用说明

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

Redis版本支持: 2.x, 3.x, 4.x, 5.x, 6.x, 7.x

部署模式支持: 单机模式(Standalone), 主从复制模式(Master-Slave Replication), 集群(Cluster), 哨兵模式(Sentinel)

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
REDIS_USER	用于身份验证的用户名(环境变量)，Redis ACL for Redis 6.0+, 默认为空	否	admin
REDIS_PASSWORD	redis密码(环境变量)，若为空则不填，默认为空	否	123456
-redis.addr	redis 实例地址	是	redis://localhost:6379
-include-system-metrics	是否包含系统指标，比如total_system_memory_bytes, 默认为false	否	true
-is-cluster	是否集群模式, 默认为false	是	false
-ping-on-connect	连接后是否ping redis 实例并将持续时间记录为指标，默认为false	否	true
-connection-timeout	连接到redis的超时时间, 默认为15s	否	15s
-web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601

使用指引

验证redis密码

./redis-cli -h redis地址 -p 端口号
./redis-cli -h 127.0.0.1 -p 6379

# 进入后会出现 127.0.0.1:6379>
# 在右侧输入AUTH 密码, 如果正确会返回OK, 下面是一些示例
root@5a3f395bab17:/usr/local/bin# ./redis-cli -h 127.0.0.1 -p 6379 -a wsbs201712
Warning: Using a password with '-a' or '-u' option on the command line interface may not be safe.
127.0.0.1:6379>
127.0.0.1:6379> AUTH 1234567
(error) ERR invalid password
127.0.0.1:6379> AUTH 123456
OK
127.0.0.1:6379> config get requirepass
1) "requirepass"
2) "123456"

查看redis密码方法1: 通过redis-cli进入redis后执行config get requirepass命令
```
# 返回示例，密码为空
127.0.0.1:6379> config get requirepass
1) "requirepass"
2) ""

# 返回示例，密码不为空
127.0.0.1:6379> config get requirepass
(error) NOAUTH Authentication required.
```
方法2: 寻找Redis的配置文件, 默认在/etc/redis.conf，找到字样"requirepass" requirepass redis密码

redis账户如果用到redis账户需要确保授权，注意redis版本不同可能授权不同例: redis v7授权

127.0.0.1:6379> ACL SETUSER weops on >123456 +client +ping +info +config|get +cluster|info +slowlog +latency +memory +select +get +scan +xinfo +type +pfcount +strlen +llen +scard +zcard +hlen +xlen +eval allkeys
OK

3.6 MongoDB

使用说明

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

mongoDB版本: >= 3.6

注意 mongodb低于3.6版本(例如3.4)可能会缺少部分监控指标，还可能出现连接不兼容等问题。

部署模式支持: 单机(Standalone), 集群(Replicaset), 分片(Sharded)

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
--mongodb.host	数据库主机IP	是	127.0.0.1
--mongodb.port	数据库服务端口	是	27017
--mongodb.db	数据库库名	是	admin
MONGODB_USER	数据库用户名(环境变量)	是	admin
MONGODB_PASSWORD	数据库密码(环境变量)	是
--collect-all	是否采集所有collectors的指标，默认采集所有	是	true
--timeout	连接mongodb超时时间(seconds), 默认为10s	否	5
--log.level	日志级别	否	info
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601

额外参数说明

，mongoDB插件支持的额外参数如下:

collect-all默认使用采集以下所有collector指标，如果不需要采集所有，可选择赋值--collect-all=false并单独启用以下的collector, 若启用则赋值true --collector.diagnosticdata: getDiagnosticData类指标 --collector.replicasetstatus: replSetGetStatus类指标 --collector.dbstats: dbStats类指标 --collector.topmetrics: top admin command类指标 --collector.indexstats: $indexStats类指标 --collector.collstats: $collStats类指标

使用指引

连接mongoDB
- 输入连接指令后输入对应的账户配置即可进入。有多种方式进入MongoDB，下面列出常用的使用方式
```
# 常用
mongo -u [username] -p [password] --host [host] --port [port]

# 连接MongoDB并指定端口
mongo 127.0.0.1:27017

# 使用用户名和密码连接到指定的MongoDB数据库
mongo 127.0.0.1:27017/test -u [username] -p [password]
```
- 如果没有mongo命令，可尝试使用mongosh命令，具体使用方式与上面mongo连接命令方式一致，MongoDB Shell下载地址: https://www.mongodb.com/try/download/shell
创建账户及授权
- 需要注意auth授权的账户密码是管理员, 创建的用户是新的账户密码
- 管理员授权命令若失败，可尝试直接创建账户，一般管理员为admin
- 创建账户创建在admin下的账户
```
use admin;
db.auth('admin', '管理员密码');
db.createUser({
  user: 'weops',
  pwd: 'Weops123',
  roles: [{ role: 'read', db: 'admin' }, 'clusterMonitor'],
  mechanisms: ['SCRAM-SHA-256']
});
```
  创建在其他数据库下的账号
```
use admin;
db.auth('admin', '管理员密码');
use weops;
db.createUser({
  user: 'weops',
  pwd: 'Weops123',
  roles: [{ role: 'read', db: 'weops' }],
  mechanisms: ['SCRAM-SHA-256']
});
db.grantRolesToUser('weops', [{ role: 'clusterMonitor', db: 'admin' }]);
```
  需要注意mongodb的版本，mechanisms: ['SCRAM-SHA-256'] 身份认证一般用于 >= 4.0，若mongodb < 4.0 (比如3.6), 那么可以去掉 mechanisms: ['SCRAM-SHA-256'] , 或者使用 mechanisms: ['SCRAM-SHA-1']

mongo相关命令指引

查询特定数据库下的用户属性

use weops;
db.getUser('weops');

# 执行命令返回的用户信息
{
  "_id" : "weops.weops",
  "userId" : UUID("2a14dcf6-fd72-4247-9a45-092ea128c775"),
  "user" : "weops",
  "db" : "weops",
  "roles" : [
      {
      "role" : "read",
      "db" : "weops"
      },
      {
      "role" : "clusterMonitor",
      "db" : "admin"
      }
  ],
  "mechanisms" : [
      "SCRAM-SHA-256"
  ]
}

查看全局所有用户 db.system.users.find().pretty();
查看所有数据库 show dbs;

3.7 IIS

使用说明

IIS Exporter用于采集Internet Information Services（IIS）服务器的性能指标。它通过从Perflib（Performance Library）获取监控数据来实现监控功能。

版本支持

操作系统支持: windows

是否支持arm: 否

组件支持版本：

IIS Exporter 支持的 IIS 版本为 7.0 及以上。

注意部分指标需要 IIS 8 及以上版本才能够正确采集。例如: windows_iis_worker_request_errors_total、windows_iis_worker_current_websocket_requests
建议使用 IIS 10.0 或更高版本作为采集对象，以确保能够获得更完整的性能指标数据。

是否支持远程采集:

否

参数说明

IIS exporter采集目前只可以设置日志级别参数，直接下发到windows服务器即可。

使用指引

检查 IIS 服务是否已启动：

打开 IIS 管理器：
- 直接进入 IIS 管理器：在计算机中搜索并运行 "IIS 管理器"。选择你的服务器，然后在左侧面板中展开 "服务器名"，选择 "应用程序池"，在右侧窗口中查看应用程序池的状态。
- 使用服务器管理器进入 IIS 管理器：
  使用开始菜单或搜索栏找到 "服务器管理器" 并打开。打开 "服务器管理器"，在左侧面板中选择 "IIS"。右键点击你的服务器，选择 "Internet Information Services (IIS) 管理器"。
检查应用程序池和网站状态：
在 IIS 管理器中，展开 "服务器名"，然后选择 "应用程序池"。在应用程序池窗口内查看应用程序池的状态。同时，选择 "网站"，然后右键点击网站，在管理网站选项中查看是否已启动。
验证 IIS 服务是否启动：在浏览器中输入默认的 IIS 服务地址：http://127.0.0.1。如果 IIS 服务已启动并运行，你应该会看到 "Internet Information Services" 或类似的内容页面。否则，可能会显示连接错误或无法访问页面。

检查性能计数器

Get-Counter '\Web Service(_total)\*' 此命令将返回有关IIS Web服务的总体性能计数器信息。

3.8 AD

使用说明

AD Exporter用于采集Windows Active Directory域控制器的指标，通过 Windows Management Instrumentation (WMI) 提供的接口来采集数据。

版本支持

操作系统支持: windows

是否支持arm: 否

组件支持版本：

可以在支持 WMI 的 Windows 操作系统上采集数据。

是否支持远程采集:

否

参数说明

AD exporter采集目前只可以设置日志级别参数，直接下发到windows服务器即可。

3.9 Exchange

使用说明

Windows Exchange Exporter用于采集Windows Exchange的指标，通过 Windows Management Instrumentation (WMI) 提供的接口来采集数据。

版本支持

操作系统支持: windows

是否支持arm: 否

组件支持版本：

可以在支持 WMI 的 Windows 操作系统上采集数据。

是否支持远程采集:

否

参数说明

Exchange exporter采集目前只可以设置日志级别参数，直接下发到windows服务器即可。

3.10 ElasticSearch

使用说明

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

elasticsearch版本: 5.x, 6.x, 7.x, 8.x 部署模式支持: 单机(Standalone), 集群(Cluster)

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
ES_USERNAME	elasticsearch账户名, 填入则会覆盖uri中的账户, 特殊字符不需要转义	否	weops
ES_PASSWORD	elasticsearch密码, 填入则会覆盖uri中的密码, 特殊字符不需要转义	否	Weops@123
--es.uri	elasticsearch访问地址, 注意区分http和https, uri中的账户密码特殊字符需要转义	是	http://127.0.0.1:9200
--es.all	全节点采集开关(开关参数), 如果打开则采集集群中所有节点, 否则只采集填写的连接地址的节点数据, 默认关闭	是
--es.ssl-skip-verify	跳过SSL认证开关(开关参数), 如果打开则跳过SSL认证, 默认关闭	是
--es.indices	索引采集开关(开关参数), 如果打开则采集所有在集群中的索引, 默认关闭	否
--es.indices_settings	索引配置采集开关(开关参数), 如果打开则采集所有在集群中的索引配置信息, 默认关闭	否
--es.indices_mappings	索引映射采集开关(开关参数), 如果打开则采集所有在集群中的索引映射信息, 默认关闭	否
--es.shards	分片采集开关(开关参数), 如果打开则采集所有在集群中的分片信息, 默认关闭	否
--es.slm	快照管理采集开关(开关参数), 如果打开则采集快照管理信息, 默认关闭	否
--collector.clustersettings	集群配置采集开关(开关参数), 如果打开则采集集群配置信息, 默认关闭	否
--collector.snapshots	快照采集开关(开关参数), 如果打开则采集快照信息, 默认关闭	否
--es.clusterinfo.interval	集群配置信息更新时间间隔，默认5m	否	5m
--es.timeout	连接elasticsearch超时时间, 默认5s	否	5s
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
--log.level	日志级别	否	info

使用指引

配置监控账户示例：

设置	所需权限	描述
exporter defaults	cluster monitor	所有集群的只读操作，如集群健康和状态、热线程、节点信息、节点和集群统计以及待处理的集群任务。
cluster_settings	cluster monitor
indices	indices monitor	所有监控所需的操作（恢复、段信息、索引统计和状态）。可对每个索引或 *（通配符）应用此权限。
indices_settings	indices monitor	可对每个索引或 *（通配符）应用此权限。
indices_mappings	indices view_index_metadata	可对每个索引或 *（通配符）应用此权限。
shards	不确定是indices、cluster monitor还是两者都是
snapshots	cluster:admin/snapshot/status 和 cluster:admin/repository/get	ES Forum Post
slm	read_slm
data_stream	monitor 或 manage	可对每个数据流或 *（通配符）应用此权限。

不同版本的elasticsearch配置监控账户的方式和可配置权限不同，具体可参考官方文档

采集参数探针每次从 Elasticsearch 服务抓取监控指标时都会获取新的信息。因此，需要注意频繁的采集频率可能会对 Elasticsearch 服务造成过大的压力，特别是当打开了 --es.all 和 --es.indices 的采集开关。建议首先测量从 /_nodes/stats 和 /_all/_stats 获取数据所需的时间，然后根据实际情况来调整采集频率。

3.11 Kafka

使用说明

插件功能 连接到Kafka，获取与主题、消费者组以及其他相关数据。帮助用户监控Kafka健康状态、性能指标以及消费者行为。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

kafka版本: >= 0.10.1.0 部署模式支持: 单机(Standalone), 集群(Cluster)

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
--kafka.server	kafka服务主机ip:服务端口，若为集群，也请填写单个ip和服务端口	是	127.0.0.1:9092
--kafka.version	kafka服务版本	是	0.10.1.0
--sasl.enabled	SASL认证开关(开关参数)	是
SASL_USERNAME	kafka SASL用户名(环境变量)	是	weops
SASL_PASSWORD	kafka SASL用户的密码(环境变量)	是	weops123
SASL_MECHANISM	kafka SASL机制(环境变量)，若不开启SASL则填空，否则可填plain、scram-sha512、scram-sha256	否	plain
TOPIC_FILTER	筛选并留下含有正则关键字的主题(环境变量)，默认不过滤	是	.*
TOPIC_EXCLUDE	筛选并排除含有正则关键字的主题(环境变量)，默认不过滤	是	^$
GROUP_FILTER	筛选并留下含有正则关键字的消费者组(环境变量)，默认不过滤	是	.*
GROUP_EXCLUDE	筛选并排除含有正则关键字的消费者组(环境变量)，默认不过滤	是	^$
--verbosity	日志级别，默认为0，0(ERROR级别)，1(INFO级别)，(DEBUG级别)	否	0
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601

使用指引

查看kafka版本有以下几种方式:
- 进入kafka安装目录，比如/opt/kafka_2.11-0.11.0.3/bin，那么该kafka版本为0.11.0.3
- 进入kafka目录，比如/opt/kafka/libs，该路径底下的包会含有版本信息，比如 kafka_2.12-0.10.2.0.jar，那么该kafka版本为0.10.2.0
主题和消费者组过滤选项支持主题和消费者组的过滤，需要注意如果主题过多或者在集群的模式下，可能监控获取到的数据量会较大，指标抓取时长会增加并且会占用较多的cpu资源，一般建议缩小监控的主题和消费者组范围，减少指标抓取时长和资源占用。若需要全部数据，注意要增加抓取时长等待时间(采集任务采集周期)。

3.12 Tomcat

使用说明

通过抓取和公开JMX目标的mBeans来收集有关应用程序的度量数据，并将这些度量数据转换为Prometheus监控指标格式。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

tomcat版本: 6.x, 7.x, 8.x, 9.x, 10.x

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
host	监听IP(采集器IP)，建议使用默认的127.0.0.1	是	127.0.0.1
port	监听端口(采集器监听端口)，一般为9601，注意不要与已使用端口冲突	是	9601
username	jmx认证用户名，若未配置则留空	否
password	jmx认证密码，若未配置则留空	否
jmx_url	jmx 连接字符串，格式为service:jmx:rmi:///jndi/rmi://${target_host}:${target_port}/jmxrmi	是	service:jmx:rmi:///jndi/rmi://127.0.0.1:1234/jmxrmi

使用指引

配置tomcat jmx参数

打开tomcat的bin目录下的catalina.sh文件

在文件中找到CATALINA_OPTS变量，添加如下参数

-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=1234
-Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false

例如:

CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=192.168.1.1 -Dcom.sun.management.jmxremote.port=1234 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false"

配置JMX的账号密码验证(选择性)：

CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=192.168.1.1 -Dcom.sun.management.jmxremote.port=1234 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=true -Dcom.sun.management.jmxremote.access.file=./jmx.access -Dcom.sun.management.jmxremote.password.file=./jmx.password"

jmx.access文件内容参考：

#用户名    权限
monitor readonly

jmx.password参考内容：

注意：若无法启动tomcat则建议修改jmx.password文件的权限，权限设置为400或600
#用户名    密码
monitor monitor

重启tomcat
验证jmx端口是否生效: netstat -antlp |grep 1234

3.13 Apache

使用说明

向Apache服务器的server-status模块页面发送请求，获取服务器的运行状态信息。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

Apache版本: 2.2, 2.4

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
SCRAPE_URI	apache server-status模块访问地址(环境变量)，如果有http auth则使用http://user:password@localhost/server-status?auto	是	http://localhost/server-status/?auto
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
--log.level	日志级别	否	info

使用指引

配置server-status 默认配置文件存放于 /etc/httpd/conf/httpd.conf 需要先检查是否开启mod_status模块，检查文件内容是否含有 LoadModule status_module modules/mod_status.so，若没有则需要手动添加开启模块后，在文件末尾添加以下内容，若已存在则修改对应配置
```
ExtendedStatus On               # 开启ExtendedStatus
<Location /server-status>       # server-status服务地址，按需配置
   SetHandler server-status      # 开启server-status服务
   Deny from all                # 禁止任何来源访问，按需配置
   Allow from 127.0.0.1         # 允许指定IP访问
</Location>
```
修改后使用 apachectl -t 检查配置文件内容是否正确，如果正确会返回 Syntax OK，否则会返回错误信息
注意: 配置更改后需要重启服务，使用 apachectl graceful 重启apache服务不会中断原有连接
验证server-status 配置完成后，使用 curl http://localhost/server-status?auto 验证server-status是否正常工作，如果正常会返回以下内容
```
Total Accesses: 1
Total kBytes: 0
CPULoad: .000797
Uptime: 884
ReqPerSec: .00113208
BytesPerSec: .000797
BytesPerReq: 702.5
BusyWorkers: 1
IdleWorkers: 7
Scoreboard: _W_______
```
如果返回 Forbidden，则需要检查配置文件中的 Allow from 是否正确配置，如果返回 Not Found，则需要检查配置文件中的 Location 是否正确配置

3.14 Nginx

使用说明

插件功能

Nginx Exporter通过解析 Nginx 的状态页面和其他可访问的信息源, 从中提取出有价值的监控数据。该工具能够将从 Nginx 收集到的数据转换为易于理解和分析的监控指标，使用户能够更轻松地监视和评估 Nginx 实例的性能。收集多种关键的 Nginx 指标，从而实现性能优化和故障排查。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
-nginx.common	nginx stub采集开关(开关参数), 默认打开	是
NGINX_SCRAPE_URI	nginx stub访问地址(环境变量)	否	http://127.0.0.1:8080/stub_status
-nginx.vts	nginx vts采集开关(开关参数), 默认关闭	是
NGINX_VTS_SCRAPE_URI	nginx vts访问地址(环境变量)	否	http://127.0.0.1:8080/vts_status
-nginx.rtmp	nginx rtmp采集开关(开关参数), 默认关闭	是
NGINX_RTMP_SCRAPE_URI	nginx rtmp访问地址(环境变量)	否	http://127.0.0.1:8080/rtmp_status
NGINX_RTMP_REGEX_STREAM	nginx rtmp音视频流正则过滤(环境变量), 默认采集所有	否	.*
-nginx.timeout	nginx采集超时时间, 默认为5s	是	5s
-log.level	日志级别	否	info
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601

使用指引

注意：采集器所在的服务器需要能够正常访问对应模块功能的地址。

nginx配置采集nginx基础指标需要开启stub_status模块。采集vts类指标需要开启vts模块, 提供对 nginx 虚拟机主机状态数据的访问，可将数据输出格式为json、html、jsonp、prometheus。采集rtmp类指标需要开启rtmp模块。

检查模块配置
通过 nginx -V 查看模块是否添加成功, 可看到示例中已安装stub_status和vts模块

nginx -V

# 返回结果示例
nginx version: nginx/1.25.1
built with OpenSSL 1.1.1n  15 Mar 2022
TLS SNI support enabled
configure arguments: --prefix=/opt/bitnami/nginx --with-http_stub_status_module --with-stream --with-http_gzip_static_module --with-mail --with-http_realip_module --with-http_stub_status_module --with-http_v2_module --with-http_ssl_module --with-mail_ssl_module --with-http_gunzip_module --with-threads --with-http_auth_request_module --with-http_sub_module --with-http_geoip_module --with-compat --with-stream_realip_module --with-stream_ssl_module --with-cc-opt=-Wno-stringop-overread --add-module=/bitnami/blacksmith-sandox/nginx-module-vts-0.2.2 --add-dynamic-module=/bitnami/blacksmith-sandox/nginx-module-geoip2-3.4.0 --add-module=/bitnami/blacksmith-sandox/nginx-module-substitutions-filter-0.20220124.0 --add-dynamic-module=/bitnami/blacksmith-sandox/nginx-module-brotli-0.20220429.0

nginx配置文件文件内容示例(一般为nginx.conf)

# 开启 upstram zones 
upstream backend{
  server 127.0.0.1:80;
}

vhost_traffic_status_zone;  # 开启vts统计模块
vhost_traffic_status_filter_by_host on;  # 打开vts vhost过滤
vhost_traffic_status_filter_by_set_key $status $server_name;  # 开启vts详细状态码统计

server {
  server_name *.example.org;

  listen 8080;

  # vts访问路径
  location /vts_status {  
    vhost_traffic_status_display;   # 开启vts展示
    vhost_traffic_status_display_format html;
  }

  # stub_status访问路径
  location /stub_status { 
    stub_status on;   # 开启stub_status模块
    access_log   off;
    allow 127.0.0.1;    # 只允许本地IP访问
    deny all;        # 禁止任何IP访问
  }
}

nginx访问控制需要自行配置，allow 和 deny 后内容按照实际情况填写。

vts除了状态码统计, 还有基于地理信息的统计，根据访问量或访问流量对nginx做访问限制，详细使用见文档: https://github.com/vozlt/nginx-module-vts#installation

重新加载配置
sudo nginx -t && sudo nginx -s reload
检查配置
` nginx -t
返回结果示例
nginx: the configuration file /opt/bitnami/nginx/conf/nginx.conf syntax is ok nginx: configuration file /opt/bitnami/nginx/conf/nginx.conf test is successful `
重启服务如果是改变 Nginx 的编译参数、添加新的模块, 通常需要重新编译和安装, 然后重启服务。

3.15 Zookeeper

使用说明

插件连接Zookeeper并执行命令：mntr 和 ruok。通过执行这些命令，插件会收集相关输出结果，并将其转化为监控指标以供分析。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

部署模式支持: 单机(Standalone), 集群(Cluster)

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
--zk-hosts	Zookeeper服务的地址，可使用逗号分隔多个服务地址。例如 10.0.0.1:2181,10.0.0.2:2181,10.0.0.3:2181	是	127.0.0.1:2181
--timeout	连接超时时间(s)	否	30

使用指引

需要确保zookeeper能够响应监控探针输入的命令。注意从版本v3.4.10开始可能需要 mntr 命令白名单，详情参考: 4lw.commands.whitelist

测试mntr结果

echo mntr | nc 127.0.0.1 2181
zk_version      3.4.13-2d71af4dbe22557fda74f9a9b4309b15a7487f03, built on 06/29/2018 04:05 GMT
zk_avg_latency  0
zk_max_latency  0
zk_min_latency  0
zk_packets_received     1
zk_packets_sent 0
zk_num_alive_connections        1
zk_outstanding_requests 0
zk_server_state standalone
zk_znode_count  51
zk_watch_count  0
zk_ephemerals_count     0
zk_approximate_data_size        621501
zk_open_file_descriptor_count   38
zk_max_file_descriptor_count    1048576
zk_fsync_threshold_exceed_count 0

测试ruok结果

echo ruok | nc 127.0.0.1 2181
imok%  

注意
能采集到的监控指标与zookeeper版本有关，如果发现监控指标有缺失，请检查mntr和ruok是否能显示对应的字段，否则监控探针无法转换为对应的指标。

3.16 RabbitMQ

使用说明

插件功能

从rabbitmq服务的管理插件模块页获取服务的运行状态信息。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

rabbitmq版本: 3.7.x, 3.8.x

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
RABBIT_URL	RabbitMQ管理插件的URL	是	http://127.0.0.1:15672
RABBIT_USER	RabbitMQ管理插件的用户名，该用户需要具备监控标签	是	guest
RABBIT_PASSWORD	RabbitMQ管理插件的密码	是	guest
RABBIT_CONNECTION	连接类型，"direct"或"loadbalancer". 使用"loadbalancer"时会删除自身标签	是	direct
RABBIT_EXPORTERS	激活的模块列表。可能的模块包括: connections,shovel,federation,exchange,node,queue,memory	是	connections,exchange,node,queue,memory
RABBIT_TIMEOUT	从管理插件检索数据的超时时间，以秒为单位	是	30
LOG_LEVEL	日志级别，可能的值包括:"debug", "info", "warning", "error", "fatal"或"panic"	是	info
SKIP_VHOST	正则表达式，与之匹配的vhost名字不会被导出。该操作在INCLUDE_VHOST之后进行，适用于队列和交换机	是	^$
INCLUDE_VHOST	正则表达式用于过滤vhost. 只有匹配的vhosts会被导出。适用于队列和交换机	是	.*
INCLUDE_QUEUES	正则表达式用于过滤队列. 只有匹配的名字会被导出	是
SKIP_QUEUES	正则表达式，与之匹配的队列名不会被导出（适用于处理短暂的rpc队列）	是
INCLUDE_EXCHANGES	正则表达式用于过滤交换机. （只有在匹配的vhosts中的交换机会被导出）	是
SKIP_EXCHANGES	正则表达式，与之匹配的交换机名不会被导出	是
MAX_QUEUES	删除度量之前，队列的最大数量（如果将其设置为0，则禁用）	是	0

使用指引

需要获取rabbitmq管理插件页面的账户和密码才可使用。
rabbitmq_up指标与常见的up指标不同，若其他模块的rabbitmq_module_up指标采集异常也会导致rabbitmq_up指标为0，只有全部采集模块正常时rabbitmq_up才会为1，若不清楚哪些模块有问题，可以编辑RABBIT_EXPORTERS参数，减少采集的模块。

3.17 TiDB

使用说明

插件功能

从TiDB Server的监控指标接口拉取指标数据

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
metrics_url	采集URL	是	http://127.0.0.1:10080/metrics

使用指引

检查TiDB服务是否正常

TiDB Server

TiDB API 地址：http://${host}:${port}
默认端口：10080

获取当前 TiDB Server 的状态
判断该 TiDB Server 是否存活。结果以 JSON 格式返回

curl http://127.0.0.1:10080/status

{
    connections: 0,  # 当前 TiDB Server 上的客户端连接数
    version: "8.0.11-TiDB-v8.1.0",  # TiDB 版本号
    git_hash: "7267747ae0ec624dffc3fdedb00f1ed36e10284b"  # TiDB 当前代码的 Git Hash
}

使用 metrics 接口
Metrics 接口用于监控整个集群的状态和性能。
curl http://127.0.0.1:10080/metrics

3.18 IBM MQ

使用说明

版本支持

操作系统支持: linux

是否支持arm: 不支持

是否支持远程采集:

是

备注: 可在linux远程采集在windows上运行的IBMMQ服务

参数说明

参数名	含义	是否必填	使用举例
--ibmmq.httpListenHost	插件监听地址(下发请保持默认)	是	127.0.0.1
--ibmmq.httpListenPort	插件监听端口(下发请保持默认)	是	9601
--ibmmq.client	以客户端形式连接(开关参数), 默认关闭	否
--ibmmq.usePublications	资源发布控制开关, 默认使用true	否
--ibmmq.useStatus	获取所有STATUS开关, 默认使用false	否
IBMMQ_CONNECTION_CONNNAME	ibmmq服务连接地址(环境变量), 注意填写形式 `ip(port)`	是	127.0.0.1(1414)
IBMMQ_CONNECTION_QUEUEMANAGER	ibmmq队列管理器名称(环境变量)	是	QM1
IBMMQ_CONNECTION_CHANNEL	ibmmq连接通道名称(环境变量)	是	SERVER
IBMMQ_CONNECTION_USER	ibmmq连接账户名称(环境变量)	否	admin
IBMMQ_CONNECTION_PASSWORD	ibmmq连接密码(环境变量)	否
IBMMQ_OBJECTS_QUEUES	过滤监控队列正则表达式, 默认使用 `*` 获取所有队列	是	*
--log.level	日志级别	否	info

使用指引

配置IBM MQ redistributable client 使用该探针的前提条件必须在下发探针的机器配置IBM MQ redistributable client。
如果没有配置客户端, 可以下载安装包。
根据需要的版本下载x.x.x.x-IBM-MQC-Redist-LinuxX64.tar.gz
下载地址: IBM MQ redistributable client
指定版本下载地址: 9.3.4.1-IBM-MQC-Redist-LinuxX64.tar.gz

下载后解压到对应目录
linux在目录/opt/mqm下解压, 如果没有该目录请新建一个即可

配置账户授权
该配置授权命令windows和linux都可使用

# 进入名称为QM1的队列管理器管理界面
runmqsc QM1

# 查看ccsid
display qmgr ccsid

# 修改队列管理器的ccsid, 建议修改为819
alter qmgr ccsid(819)
 
# 定义类型为SVRCONN名称为SERVER的远程连接通道，同时授权mqm账号进行远程连接
def chl(SERVER) chltype(SVRCONN) trptype(tcp) mcauser('mqm') replace

# 定义名称为TCP端口为1414的tcp监听端口
def listener(TCP) trptype(tcp) port(1414)

# 启动监听端口
start listener(TCP)

定义通道时 SERVER 是填入探针参数 IBMMQ_CONNECTION_CHANNEL的通道名称, mqm 是填入探针参数 IBMMQ_CONNECTION_USER 已存在的账号名称

可以选择验证方式, 一般不建议取消验证

正常验证

# 关闭对mqm的禁用  
SET CHLAUTH(*) TYPE(BLOCKUSER) USERLIST(*MQADMIN) ACTION(REMOVE)

取消验证

# 禁用通道校验
ALTER QMGR CHLAUTH(DISABLED)

# 禁用连接权限认证
ALTER QMGR CONNAUTH('')

# 刷新安全策略：  
REFRESH SECURITY TYPE(CONNAUTH)

3.19 minio

使用说明

插件功能 从minio的cluster监控指标接口拉取指标数据

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
metrics_url	采集URL	是	http://127.0.0.1:9000/minio/v2/metrics/cluster

使用指引

需要minio提供cluster监控指标接口, 启动minio时加入环境变量 MINIO_PROMETHEUS_AUTH_TYPE=public

3.20 nacos

使用说明

插件功能 从nacos提供的监控指标地址拉取监控数据

版本支持

组件支持版本：

nacos版本: >= 0.8.0

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
metrics_url	采集URL	是	http://127.0.0.1:8848/nacos/actuator/prometheus

使用指引

提供监控数据接口
配置application.properties文件，暴露metrics数据
例如k8s部署的nacos，该配置文件存放于 /home/nacos/conf 目录，找到 application.properties 修改或增加配置
```
management.endpoints.web.exposure.include=*
```
修改完成后需要重启nacos服务，然后访问{nacos_ip}:8848/nacos/actuator/prometheus，看是否能访问到metrics数据

3.21 WebLogic

使用说明

插件功能 WebLogic监控探针通过使用WebLogic Server的RESTful API ( /management/weblogic/latest/serverRuntime/search ) 导出监控指标数据。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

Weblogic Server: 12.2.1+

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
USERNAME	weblogic登录用户名(环境变量)	是	weblogic
PASSWORD	weblogic登录密码(环境变量)	是	welcome
--host	weblogic服务实例IP地址	是	127.0.0.1
--port	weblogic服务实例端口	是	7001
--config-file	采集配置文件(文件参数), 默认内容已填写, 不需要修改	是	config.yaml
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601

使用指引

验证登录信息访问Weblogic Servers实例, 登录 host:port/console 。默认管理服务器端口一般是7001
输入账户和密码, 验证是否账户是否正确。
如果需要采集数据源监控指标
配置数据源指引
如果没有配置数据源, 那么将采集不到 wls_datasource_类指标。

3.22 Websphere

使用说明

插件功能

从web application server的监控指标接口拉取指标数据

是否支持远程采集:

是

支持版本:

9.0.5.7+
8.5.5.x
特殊版本8.5.5.16需要安装iFix补丁

参数说明

参数名	含义	是否必填	使用举例
metrics_url	采集URL	是	http://127.0.0.1:9080/metrics

使用指引

websphere application server监控需要完成以下操作

获取metrics.ear文件

metrics.ear 文件存放于 <WAS_HOME>/installableApps 目录下。如果没有可以直接拿包上传安装。

登录websphere

https://localhost:9043/ibm/console/login.do?action=secure

安装metrics服务

在工作台最左侧，选择Applications -> Application Type

选择右方视图中的 New Enterprise Application
选择上传文件 metrics.ear，点击 Next
选择Fast Path，点击 Next
进入 Select installation options，保持默认选择，点击 Next
进入 Map modules to servers，点击 Module 名称为 metrics的一栏中的Select，Select 下方出现 √ 选择才是正确的，点击 Next
进入 Summary，点击 Finish 完成配置
开始自动开始，等出现 Save 选择即可点击

安装完成后返回 Applications -> Enterprise Applications

查看右方视图，MetricsApp 一栏的 Application Status 是否正常，绿色箭头代表 Started，红色 × 代表Failed，出现绿色箭头才是正常部署状态
如果是异常状态，可以尝试选择 MetricsApp 后再点击 Start 启动

配置监控指标

进入 Monitoring and Tunning - > Performance Monitoring Infrastructure (PMI) ，选择Name下发的server1
选择 Runtime -> Currently monitored statistic set -> All ，点击OK，打开所有监控指标

查看HTTP端口

导航到服务器设置: 在管理控制台的左侧导航栏中，展开 Servers > Server Types > WebSphere application servers。点击你想要配置的服务器（例如，server1）。
进入通信设置:
在服务器详细信息页面，展开Communications，再点击Ports。
查看服务端口信息找到WC_defaulthost 或类似的 HTTP 端口配置。默认情况下，这个端口可能被禁用或设置为一个你不期望的端口号。确认或修改WC_defaulthost 端口号。例如，将它设置为 9080（或你希望的端口号）。

获取metrics 获取metrics不需要账户和密码
http://127.0.0.1:9080/metrics

3.23 HANA

使用说明

从系统表/视图中收集所有 HANA 信息，SYS 模式下所有以 M 为前缀的表/视图都是监控表/视图，只从 SYS.M* 表/视图中获取数据。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

HanaData数据库版本: 2.x

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
HOST	数据库服务IP(环境变量)	是
PORT	数据库服务端口(环境变量)	是
USER	数据库账户名(环境变量)	是
PASS	数据库密码(环境变量)	是
TIMEOUT	连接超时时间(s), 默认5s(环境变量)	否	5
--web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
--log.level	日志级别	否	info

使用指引

配置监控账户用户需要拥有 SAP_INTERNAL_HANA_SUPPORT 角色才能访问 SYS 模式。如果没有 SAP_INTERNAL_HANA_SUPPORT 角色，这些信息只能由 SYSTEM 用户选择。
注意：配置的用户至少需要对 SYS 模式具有 SELECT 权限，所有收集器将从该模式下的表/视图中收集信息。

授予用户 SAP_INTERNAL_HANA_SUPPORT 角色：GRANT SAP_INTERNAL_HANA_SUPPORT TO user;

3.23 达梦

使用说明

采集器连接数据库后执行sql，转换为监控指标。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

达梦数据库: >=8.1.1.126

使用指引

登录数据库并执行命令创建蓝鲸监控账号和授权：

# 创建用户: weops 密码: Weops123!
CREATE USER weops IDENTIFIED BY "Weops123!";
# 要获取DB\table级别的监控信息必须拥有对应数据库的select权限
GRANT SELECT ON v$sessions TO weops;
GRANT SELECT ON V$SYSTEMINFO TO weops;
GRANT SELECT ON V$DM_INI TO weops;
GRANT SELECT ON V$SYSSTAT TO weops;
GRANT SELECT ON V$LOCK TO weops;
GRANT SELECT ON V$PARAMETER TO weops;
GRANT SELECT ON DBA_TABLES TO weops;
GRANT SELECT ON DBA_INDEXES TO weops;
GRANT SELECT ON V$OPEN_STMT TO weops;
GRANT SELECT ON V$RLOGFILE TO weops;
GRANT SELECT ON V$TRX TO weops;
GRANT SELECT ON V$ASMGROUP TO weops;
GRANT SELECT ON V$RLOG TO weops;
GRANT SELECT ON DBA_FREE_SPACE TO weops;
GRANT SELECT ON DBA_DATA_FILES TO weops;
GRANT SELECT ON DBA_OBJECTS TO weops;
GRANT SELECT ON V$BUFFERPOOL TO weops;
GRANT SELECT ON v$rapply_stat TO weops;
GRANT SELECT ON V$ARCH_STATUS TO weops;
GRANT SELECT ON V$UTSK_SYS2 TO weops;
GRANT SELECT ON v$instance TO weops;
GRANT SELECT ON v$dmwatcher TO weops;
GRANT SELECT ON V$DM_MAL_INI TO weops;
GRANT SELECT ON SYS.V$DM_MAL_INI TO weops;
GRANT SOI TO weops;

参数说明

参数名	含义	是否必填	使用举例
SQL_EXPORTER_USER	数据库用户名(环境变量)，特殊字符不需要编码转义	是	SYSDBA
SQL_EXPORTER_PASS	数据库密码(环境变量)，特殊字符不需要编码转义	是	SYSDBA001
SQL_EXPORTER_DB_TYPE	数据库类型(环境变量)	是	dm
SQL_EXPORTER_HOST	数据库服务IP(环境变量)	是	127.0.0.1
SQL_EXPORTER_PORT	数据库服务端口(环境变量)	是	5236
-config.file	sql_exporter.yml 采集器全局配置文件, 包含超时设置、最大连接数、目标配置、采集指标配置文件名等	是	默认已有采集器全局配置文件
-log.level	日志级别	否	info
-web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
collector.file.content	.collector.yml 采集指标配置文件, 包含指标名、维度、sql等内容。注意！该参数为文件参数，非探针执行文件参数！*	是	默认已有标准采集指标配置文件

3.24 GBase8a

使用说明

采集器连接数据库后执行sql，转换为监控指标。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

GBase8a数据库

使用指引

登录数据库并执行命令创建蓝鲸监控账号和授权：

# 创建用户: weops 密码: Weops123!
CREATE USER 'weops' IDENTIFIED BY 'Weops123!';

# 要获取DB\table级别的监控信息必须拥有对应数据库的select权限
GRANT SELECT ON *.* TO 'weops';

参数说明

参数名	含义	是否必填	使用举例
SQL_EXPORTER_USER	数据库用户名(环境变量)，特殊字符不需要编码转义	是	weops
SQL_EXPORTER_PASS	数据库密码(环境变量)，特殊字符不需要编码转义	是	Weops123!
SQL_EXPORTER_DB_TYPE	数据库类型(环境变量)	是	gbase8a
SQL_EXPORTER_HOST	数据库服务IP(环境变量)	是	127.0.0.1
SQL_EXPORTER_PORT	数据库服务端口(环境变量)	是	5258
SQL_EXPORTER_DB_NAME	数据库名(环境变量)	是	gbase
-config.file	sql_exporter.yml 采集器全局配置文件, 包含超时设置、最大连接数、目标配置、采集指标配置文件名等	是	默认已有采集器全局配置文件
-log.level	日志级别	否	info
-web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
collector.file.content	.collector.yml 采集指标配置文件, 包含指标名、维度、sql等内容。注意！该参数为文件参数，非探针执行文件参数！*	是	默认已有标准采集指标配置文件

3.25 OpenGauss

使用说明

采集器连接数据库后执行sql，转换为监控指标。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

OpenGauss: >= 2.0.1

使用指引

登录数据库并执行命令创建蓝鲸监控账号和授权：
创建账户名 weops, 密码 Weops123!

CREATE USER weops PASSWORD 'Weops123!';

参数说明

参数名	含义	是否必填	使用举例
SQL_EXPORTER_USER	数据库用户名(环境变量)，特殊字符不需要编码转义	是	SYSDBA
SQL_EXPORTER_PASS	数据库密码(环境变量)，特殊字符不需要编码转义	是	SYSDBA001
SQL_EXPORTER_DB_TYPE	数据库类型(环境变量)	是	dm
SQL_EXPORTER_HOST	数据库服务IP(环境变量)	是	127.0.0.1
SQL_EXPORTER_PORT	数据库服务端口(环境变量)	是	5236
SQL_EXPORTER_DB_NAME	数据库名(环境变量)	是	postgres
-config.file	sql_exporter.yml 采集器全局配置文件, 包含超时设置、最大连接数、目标配置、采集指标配置文件名等	是	默认已有采集器全局配置文件
-log.level	日志级别	否	info
-web.listen-address	exporter监听id及端口地址	否	127.0.0.1:9601
collector.file.content	.collector.yml 采集指标配置文件, 包含指标名、维度、sql等内容。注意！该参数为文件参数，非探针执行文件参数！*	是	默认已有标准采集指标配置文件

3.26 ETCD

使用说明

从etcd提供的监控指标接口获取prometheus指标

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

etcd版本: 3.3+

是否支持远程采集:

是

注意蓝鲸 bk-pull 不支持证书配置，而 etcd 提供的监控指标接口通常需要证书才能访问。

本地采集如果选择在本地采集 etcd 的监控指标，需要在采集机器上安装 agent，该 agent 对本机 IP 进行数据采集。这种方法不需要额外的证书配置，因为采集是在本地进行的。
远程采集对于远程采集，可以使用 NGINX 进行转发。通过配置 NGINX，将 etcd 的 metrics 接口转发到本地端口，并确保 NGINX 的证书配置正确。这样，蓝鲸 bk-pull 可以通过 NGINX 代理访问 etcd 的监控指标。

远程采集时nginx配置示例：编辑 Nginx 配置文件（通常位于 /etc/nginx/nginx.conf 或 /etc/nginx/conf.d/default.conf），添加一个新的 server 块，用于转发 etcd 的 /metrics 接口。

以下是一个示例配置：

server {
    listen 8080;  # 本地端口
    server_name your_domain_or_ip;

    location /metrics {
        proxy_pass https://<etcd_node_ip>:2379/metrics;  # 填入etcd节点ip
        proxy_ssl_certificate /etc/kubernetes/ssl/etcd.pem;  # etcd 证书路径
        proxy_ssl_certificate_key /etc/kubernetes/ssl/etcd-key.pem;  # etcd 证书密钥路径
        proxy_ssl_trusted_certificate /etc/kubernetes/ssl/ca.pem;  # etcd CA 证书路径
        proxy_ssl_verify off;  # 禁用主机名验证
        proxy_ssl_server_name on;
        proxy_ssl_name etcd;  # 使用证书中的主机名
        proxy_ssl_session_reuse on;
        proxy_ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
        proxy_ssl_ciphers HIGH:!aNULL:!MD5;
    }
}

保存配置文件后，重启 Nginx 使配置生效

参数说明

参数名	含义	是否必填	使用举例
metrics_url	采集URL	是	http://127.0.0.1:2379/metrics

使用指引

etcd内置 /metrics 接口，默认的 2379 端口的访问一般是需要证书

3.27 JBoss

注意jboss版本，某些旧版本使用的是jmxrmi，新版本使用的是remote+http ，请选用适用的插件，两类插件的操作指引如下：

插件使用说明

通过抓取和公开JMX目标的mBeans来收集有关应用程序的度量数据，并将这些度量数据转换为Prometheus监控指标格式。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

JBoss: 7.x JBoss EAP: 6.x

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
host	监听IP(采集器IP)，建议使用默认的127.0.0.1	是	127.0.0.1
port	监听端口(采集器监听端口)，一般为9601，注意不要与已使用端口冲突	是	9601
username	jmx认证用户名，若未配置则留空	否
password	jmx认证密码，若未配置则留空	否
jmx_url	jmx 连接字符串，格式为service:jmx:remote+http://{服务IP}:{管理端口}	是	service:jmx:remote+http://127.0.0.1:9990

注意jboss版本，某些旧版本使用的是jmxrmi，新版本使用的是remote+http
如果是旧版本，那么请填写 service:jmx:rmi:///jndi/rmi://{服务IP}:{管理端口}/jmxrmi

使用指引

配置JBoss

需要确保JBoss打开了管理端口，新版本的JBoss默认管理端口为9990，一般都默认打开，否则无法登录。此处新版本指JBoss 7.x 和 JBoss EAP 6.x。

Linux环境

需要配合jboss-cli-client.jar和jmx_exporter.jar使用，具体步骤如下：如果要运行探针，请执行命令 java -cp jmx_exporter.jar:jboss-cli-client.jar io.prometheus.jmx.WebServer 127.0.0.1:9601 etc/config.yaml

蓝鲸下发的采集任务缺少部分参数，可以更改start.sh内容后再次启动采集任务

客户端包一般存放于
<WILDFLY_HOME>/bin/client/jboss-cli-client.jar

config.yaml内容

---
jmxUrl: service:jmx:remote+http://127.0.0.1:9990
ssl: false
username: {JBoss管理员账户}
password: {JBoss管理员密码}
lowercaseOutputName: true
lowercaseOutputLabelNames: true
whitelistObjectNames: 
 - "jboss.as:subsystem=messaging-activemq,server=*,jms-queue=*"
 - "jboss.as:subsystem=messaging-activemq,server=*,jms-topic=*"
 - "jboss.as:subsystem=datasources,data-source=*,statistics=*"
 - "jboss.as:subsystem=datasources,xa-data-source=*,statistics=*"
 - "jboss.as:subsystem=transactions*"
 - "jboss.as:subsystem=undertow,server=*,http-listener=*"
 - "jboss.as:subsystem=undertow,server=*,https-listener=*"
 # - "java.lang:*"
rules:
  - pattern: "^jboss.as<subsystem=messaging-activemq, server=.+, jms-(queue|topic)=(.+)><>(.+):"
    attrNameSnakeCase: true
    name: wildfly_messaging_$3
    labels:
      $1: $2

  - pattern: "^jboss.as<subsystem=datasources, (?:xa-)*data-source=(.+), statistics=(.+)><>(.+):"
    attrNameSnakeCase: true
    name: wildfly_datasource_$2_$3
    labels:
      source_name: $1

  - pattern: "^jboss.as<subsystem=transactions><>number_of_(.+):"
    attrNameSnakeCase: true
    name: wildfly_transaction_$1

  - pattern: "^jboss.as<subsystem=undertow, server=(.+), (http[s]?-listener)=(.+)><>(bytes_.+|error_count|processing_time|request_count):"
    attrNameSnakeCase: true
    name: wildfly_undertow_$4
    labels:
      server_name: $1
      listener: $3

Windows环境

windows环境配置原理与linux基本一致，都是通过管理端口连接。

采集方案

方案1 使用蓝鲸JMX采集任务

如果想使用监控平台JMX采集，请确保下发采集机器的java，默认1.8是不支持使用jboss-cli-client.jar的，需要自行安装java。另外蓝鲸自带的jmx_exporter.jar版本过低，需要替换为高级版本。
因蓝鲸JMX采集任务写死java运行命令，下发后，需要找到对应的采集任务目录，添加jmx_prometheus_httpserver-0.20.0.jar和jboss-cli-client.jar路径，并修改start.sh 原始内容
java -jar jmx_exporter.jar ${BK_LISTEN_HOST}:${BK_LISTEN_PORT} ${BK_CONFIG_PATH} > ${log_filepath} 2>&1 &

修改为
java -cp jmx_prometheus_httpserver-0.20.0.jar:jboss-cli-client.jar io.prometheus.jmx.WebServer ${BK_LISTEN_HOST}:${BK_LISTEN_PORT} ${BK_CONFIG_PATH} > ${log_filepath} 2>&1 &

修改后，重启采集任务即可。

方案2 使用bkpull

在服务器上手动启动监控探针
java -cp jmx_prometheus_httpserver-0.20.0.jar:jboss-cli-client.jar io.prometheus.jmx.WebServer 127.0.0.1:9601 config.yaml
启动后，使用bkpull拉取该探针提供的监控指标

bkpull使用说明

从JBoss jmx exporter提供的指标接口采集监控数据。

版本支持

操作系统支持: linux, windows

是否支持arm: 支持

组件支持版本：

JBoss: 7.x JBoss EAP: 6.x

是否支持远程采集:

是

参数说明

参数名	含义	是否必填	使用举例
metrics_url	采集URL	是	127.0.0.1:9601/metrics

注意jboss版本，某些旧版本使用的是jmxrmi，新版本使用的是remote+http
如果是旧版本，那么请填写 service:jmx:rmi:///jndi/rmi://{服务IP}:{管理端口}/jmxrmi

使用指引

配置JBoss

需要确保JBoss打开了管理端口，新版本的JBoss默认管理端口为9990，一般都默认打开，否则无法登录。此处新版本指JBoss 7.x 和 JBoss EAP 6.x。

Linux环境

蓝鲸下发的采集任务缺少部分参数，可以更改start.sh内容后再次启动采集任务

客户端包一般存放于
<WILDFLY_HOME>/bin/client/jboss-cli-client.jar

config.yaml内容

---
jmxUrl: service:jmx:remote+http://127.0.0.1:9990
ssl: false
username: {JBoss管理员账户}
password: {JBoss管理员密码}
lowercaseOutputName: true
lowercaseOutputLabelNames: true
whitelistObjectNames: 
 - "jboss.as:subsystem=messaging-activemq,server=*,jms-queue=*"
 - "jboss.as:subsystem=messaging-activemq,server=*,jms-topic=*"
 - "jboss.as:subsystem=datasources,data-source=*,statistics=*"
 - "jboss.as:subsystem=datasources,xa-data-source=*,statistics=*"
 - "jboss.as:subsystem=transactions*"
 - "jboss.as:subsystem=undertow,server=*,http-listener=*"
 - "jboss.as:subsystem=undertow,server=*,https-listener=*"
 # - "java.lang:*"
rules:
  - pattern: "^jboss.as<subsystem=messaging-activemq, server=.+, jms-(queue|topic)=(.+)><>(.+):"
    attrNameSnakeCase: true
    name: wildfly_messaging_$3
    labels:
      $1: $2

  - pattern: "^jboss.as<subsystem=datasources, (?:xa-)*data-source=(.+), statistics=(.+)><>(.+):"
    attrNameSnakeCase: true
    name: wildfly_datasource_$2_$3
    labels:
      source_name: $1

  - pattern: "^jboss.as<subsystem=transactions><>number_of_(.+):"
    attrNameSnakeCase: true
    name: wildfly_transaction_$1

  - pattern: "^jboss.as<subsystem=undertow, server=(.+), (http[s]?-listener)=(.+)><>(bytes_.+|error_count|processing_time|request_count):"
    attrNameSnakeCase: true
    name: wildfly_undertow_$4
    labels:
      server_name: $1
      listener: $3

Windows环境 windows环境配置原理与linux基本一致，都是通过管理端口连接。

采集方案

方案1 使用蓝鲸JMX采集任务

如果想使用监控平台JMX采集，请确保下发采集机器的java，默认1.8是不支持使用jboss-cli-client.jar的，需要自行安装java。
因蓝鲸JMX采集任务写死java运行命令，下发后，需要找到对应的采集任务目录，修改start.sh
原始内容
java -jar jmx_exporter.jar ${BK_LISTEN_HOST}:${BK_LISTEN_PORT} ${BK_CONFIG_PATH} > ${log_filepath} 2>&1 &

修改为
java -cp jmx_exporter.jar:jboss-cli-client.jar io.prometheus.jmx.WebServer ${BK_LISTEN_HOST}:${BK_LISTEN_PORT} ${BK_CONFIG_PATH} > ${log_filepath} 2>&1 &

修改后，重启采集任务即可。

方案2 使用bkpull

在服务器上手动启动监控探针
java -cp jmx_exporter.jar:jboss-cli-client.jar io.prometheus.jmx.WebServer 127.0.0.1:9601 config.yaml
启动后，使用bkpull拉取该探针提供的监控指标

4、告警源插件说明

序号	告警源插件	版本
1	REST API	无需版本适配
2	VCenter	5.5及以上
3	华为云
4	阿里云
5	腾讯云
6	听云
6	Zabbix	3.X、4.X、5.X
7	Prometheus	2.15
8	日志易	3.6
9	H3C-IMC
10	华为esight系统
11	绿盟日志审计系统	V2.0

5、日志内容说明

5.1 日志探针说明

Weops支持日志探针管理和安装，并内置探针对应的配置文件模板详情如下，若查看更加详细内容可下载表格WeOps内置日志探针说明

序号	探针名称	探针说明	内置模板
1	Filebeat	能够采集操作系统中的任意日志文件。	1、自定义模板 2、内置模板：ActiveMQ 、Coredns 、Elasticsearch、IIS、Kafka、mongodb、mssql、MySQL、Nginx、Oracle、PostgreSQL、RabbitMQ、Redis、Apache Tomcat
2	Packetbeat	能够采集操作系统中的流量数据	1、自定义模板 2、内置模板：AMQP、Cassandra、DHCPv4、DNS、HTTP、ICMP、Memcache、MongoDb、MySQL、NFS、PostgreSQL（pgSQL）、Redis、SIP、Thrift-RPC、Detailed TLS
3	Auditbeat	能够监听文件或操作系统的变更动态，例如文件发生了修改、用户登录了操作系统等。	1、自定义模板 2、内置模板：文件变化日志、系统变更日志
4	Metricbeat	轻量级的指标收集器，用于监控和收集系统和应用程序的指标数据	1、自定义模板 2、内置模板：system指标日志、Window指标日志、linux指标日志、docker指标日志
5	Winlogbeat	能够采集Windows事件	1、自定义模板 2、内置模板：应用程序日志、安全事件日志、系统事件日志
6	Uniprobe	与packetbeat功能类似，额外具备http请求的响应延迟、操作系统的网络环境质量等数据	1、自定义模板

5.2 日志提取器说明

WeOps支持的提取器如下表

提取器名称	适用	说明
复制输入	适用于需要从非结构化的日志数据中提取特定字段或值的场景。	将原始消息中的一部分数据复制到提取器的规则中，并将其存储在结构化的数据字段中
Grok模式	适用于需要从非结构化的日志数据中提取特定字段或值的场景。	用于从非结构化的日志数据中提取结构化数据。它使用预定义的Grok模式或自定义Grok模式来匹配和提取数据，包括一些特殊的模式，用于匹配常见的数据格式，如IP地址、日期、时间戳等。（WeOps内置常用的Grok表达式）（Grok表达式是一种用于解析非结构化或半结构化数据的模式匹配工具。它是由Elasticsearch社区开发的一种基于正则表达式的模式匹配语言）
JSON	适用于处理JSON格式的日志数据的场景。	可以从JSON格式的数据中提取特定的字段，并将它们存储在结构化的数据字段中。
正则表达式	适用于需要从未结构化的日志数据中提取特定字段或值的场景。	使用正则表达式从数据中提取特定的字段，并将它们存储在结构化的数据字段中
正则表达式替换	适用于需要替换日志数据中特定字符串的场景。	正则表达式替换器可以使用正则表达式从数据中匹配特定的模式，并将其替换为指定的字符串
分隔	适用于需要从日志数据中提取特定字段或值的场景。	使用指定的分隔符将数据分割成多个部分，并将它们存储在结构化的数据字段中
子窜捕获	适用于需要从日志数据中提取特定子字符串的场景。	使用指定的开始和结束字符串或位置来捕获数据中的子串，并将它们存储在结构化的数据字段中

5.3 日志NIDS网络入侵识别能力

WeOps支持接入NIDS网络入侵识别识别日志，支持的识别规则类别如下，点击可下载WeOps-NIDS网络入侵识别能力清单，

规则类型	说明
CVE	识别利用CVE通用漏洞进行的网络攻击
Malicious_behavior	识别常见的可疑行为，例如利用http请求执行netstat命令
Crypto_miner_pool	识别与常见公共矿池地址进行的网络传输
MySQL	识别特定的 MySQL 数据库恶意活动
DNS_tunnel	识别可疑的DNS隧道请求
ICMP_tunnel	识别可疑的ICMP隧道请求
Behinder	识别冰蝎渗透
Metasploit	识别Metasploit渗透
PHP_Weevely_Webshell	识别Weevely渗透
PowerShell_Empire	识别PowerShell Empire渗透
webshell_caidao	识别菜刀渗透
CobaltStrike	识别CobaltStrike渗透

6、APM内容说明

6.1 服务器-应用探针接入

支持语言框架说明

WeOps目前封装支持两类开发语言，java和python，具体的框架如下

（1）Java

库/框架	支持版本
Akka Actors	2.5+
Akka HTTP	10.0+
Apache Axis2	1.6+
Apache Camel	2.20+ (不包括3.x)
Apache DBCP	2.0+
Apache CXF JAX-RS	3.2+
Apache CXF JAX-WS	3.0+
Apache Dubbo	2.7+
Apache HttpAsyncClient	4.1+
Apache HttpClient	2.0+
Apache Kafka Producer/Consumer API	0.11+
Apache Kafka Streams API	0.11+
Apache MyFaces	1.2+ (不包括3.x)
Apache Pulsar	2.8+
Apache RocketMQ gRPC/Protobuf-based Client	5.0.0+
Apache RocketMQ Remoting-based Client	4.8+
Apache Struts 2	2.3+
Apache Tapestry	5.4+
Apache Wicket	8.0+
Armeria	1.3+
AsyncHttpClient	1.9+
AWS Lambda	1.0+
AWS SDK	1.11.x和2.2.0+
Azure Core	1.14+
Cassandra Driver	3.0+
Couchbase Client	2.0+和3.1+
c3p0	0.9.2+
Dropwizard Metrics	4.0+ (默认禁用)
Dropwizard Views	0.7+
Eclipse Grizzly	2.3+
Eclipse Jersey	2.0+ (不包括3.x)
Eclipse Jetty HTTP Client	9.2+ (不包括10+)
Eclipse Metro	2.2+ (不包括3.x)
Eclipse Mojarra	1.2+ (不包括3.x)
Elasticsearch API Client	7.16+和8.0+
Elasticsearch REST Client	5.0+
Elasticsearch Transport Client	5.0+
Finatra	2.9+
Geode Client	1.4+
Google HTTP Client	1.19+
Grails	3.0+
GraphQL Java	12.0+
gRPC	1.6+
Guava ListenableFuture	10.0+
GWT	2.0+
Hibernate	3.3+ (not including 6.x yet)
HikariCP	3.0+
HttpURLConnection Java	8+
Hystrix	1.4+
Java Executors	Java 8+
Java Http Client	Java 11+
java.util.logging	Java 8+
Java Platform	Java 8+
JAX-RS	0.5+
JAX-RS Client	1.1+
JAX-WS	2.0+ (not including 3.x yet)
JBoss Log Manager	1.1+
JDBC	Java 8+
Jedis	1.4+
JMS	1.1+
Jodd Http	4.2+
JSP	2.3+
Kotlin Coroutines	1.0+
Ktor	1.0+
Kubernetes Client	7.0+
Lettuce	4.0+
Log4j 1	1.2+
Log4j 2	2.11+
Logback	1.0+
Micrometer	1.5+
MongoDB Driver	3.1+
Netty	3.8+
OkHttp	2.2+
Oracle UCP	11.2+
OSHI	5.3.1+
Play	2.4+
Play WS	1.0+
Quartz	2.0+
R2DBC	1.0+
RabbitMQ Client	2.7+
Ratpack	1.4+
Reactor	3.1+
Reactor Netty	0.9+
Rediscala	1.8+
Redisson	3.0+
RESTEasy	3.0+
Restlet	1.0+
RMI Java	8+
RxJava	1.0+
Scala ForkJoinPool	2.8+
Servlet	2.2+
Spark Web Framework	2.3+
Spring Boot
Spring Batch	3.0+ (not including 5.0+ yet)
Spring Data	1.8+
Spring Integration	4.1+ (not including 6.0+ yet)
Spring JMS	2.0+
Spring Kafka	2.7+
Spring RabbitMQ	1.0+
Spring Scheduling	3.1+
Spring RestTemplate	3.1+
Spring Web MVC	3.1+
Spring Web Services	2.0+
Spring WebFlux	5.3+
Spymemcached	2.12+
Tomcat JDBC Pool	8.5.0+
Twilio	6.6+ (not including 8.x yet)
Undertow	1.4+
Vaadin	14.2+
Vert.x Web	3.0+
Vert.x HttpClient	3.0+
Vert.x Kafka Client	3.6+
Vert.x RxJava2	3.5+
Vert.x SQL Client	4.0+
Vibur DBCP	11.0+
ZIO	2.0.0+

（2）python

库/框架
aio_pika
aiohttp_client
aiopg
asgi
asyncpg
aws_lambda
base
boto
boto3sqs
botocore
celery
confluent_kafka
dbapi
django
elasticsearch
falcon
fastapi
flask
grpc
httpx
jinja2
kafka_python
logging
mysql
mysqlclient
pika
psycopg2
pymemcache
pymongo
pymysql
pyramid
redis
remoulade
requests
sqlalchemy
sqlite3
starlette
system_metrics
tornado
tortoiseorm
urllib
urllib3
wsgi

（3）其他

库/框架
Node.js
TypeScript

接入步骤说明

（1）Java

WeOps采用OpenTelemetry探针无代码侵入的接入方式，支持上百种Java框架自动上传Trace数据，详细的Java框架列表请参见支持清单，若您的Java框架不在支持清单，请参考接入文档进行手动接入。

前置检查

开始探针安装前，请检查主机环境，确保满足以下条件：
1、 WeOps数据接收端所在系统和探针所在系统的时钟同步
2、 WeOps数据接收端所在系统和探针所在系统、后端服务之间网络环境正常可以相互通信
3、 探针所在系统Java运行环境已安装
4、 服务启动所使用的操作系统用户具备探针安装目录的读、写、运行权限

安装流程

1、下载Agent，通过“WeOps-管理-APM关联-应用接入”页面下载

2、修改启动参数

java -javaagent:<opentelemetry-javaagent.jar文件路径> -Dotel.resource.attributes=service.name=<服务英文名>,bk.biz.id=41,probe.name=3781099f-a6c8-48d6-aedf-7fdff1ff1eca -Dotel.exporter.otlp.endpoint=10.10.26.235:4317 -Dotel.metrics.exporter=none  -jar <myapp.jar>

3、前往“WeOps-APM-调用链”查看调用链情况

（2）Python

WeOps采用OpenTelemetry探针无代码侵入的接入方式，支持数十种Python框架自动上传Trace数据，详细的Python框架列表请参见支持清单，若您的Python框架不在支持清单，请参考接入文档进行手动接入。

前置检查

开始探针安装前，请检查主机环境，确保满足以下条件：
1、 WeOps数据接收端所在系统和探针所在系统的时钟同步
2、 WeOps数据接收端所在系统和探针所在系统、后端服务之间网络环境正常可以相互通信
3、 探针所在系统Python运行环境已安装
4、 服务启动所使用的操作系统用户具备探针安装目录的读、写、运行权限

安装流程

1、在项目中安装OpenTemetry组件

pip install opentelemetry-distro opentelemetry-exporter-otlp
opentelemetry-bootstrap -a install

2、项目运行时修改OpenTemetry配置并运行

opentelemetry-instrument --traces_exporter otlp --resource_attributes "bk.biz.id=32" --resource_attributes "probe.name=4dff9337-5e2a-4de9-a372-2edcae98d89c" --exporter_otlp_endpoint 10.10.26.235:4317 --service_name <服务英文名> python <myapp.py>

3、前往“WeOps-APM-调用链”查看调用链情况

6.2 K8S集群-应用探针接入

K8S集群的OT探针接入指引

前置准备

以下内容需要按照顺序进行部署

（1）部署cert manager到集群

可参考: https://cert-manager.io/docs/installation/

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.3/cert-manager.yaml

等待cert-manager全部就绪才可部署opearator，例如

kubectl get pod -n cert-manager

NAME                                       READY   STATUS    RESTARTS   AGE
cert-manager-56588b57f4-6pbc2              1/1     Running   0          5d5h
cert-manager-cainjector-7bbf568f47-m2f6l   1/1     Running   0          5d5h
cert-manager-webhook-7f7c7898cc-b9x6f      1/1     Running   0          5d5h

（2）部署operator

需要注意依赖的k8s版本，最下方已列出对应的版本依赖

# 版本v0.82.0
kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/download/v0.82.0/opentelemetry-operator.yaml

（3）部署Instrumentation

注意: 必须指定命名空间以对特定命名空间的资源进行注入，否则将不会生效。例如，如果未指定命名空间，只有默认命名空间才能接受自动注入

apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
  name: my-instrumentation
  namespace: tomcat
spec:
  propagators:
    - tracecontext
    - baggage
    - b3
  sampler:
    type: parentbased_traceidratio
    argument: "0.25"
  java:
    env:
      - name: OTEL_EXPORTER_OTLP_ENDPOINT
        value: http://127.0.0.1:4317
      - name: OTEL_RESOURCE_ATTRIBUTES
        value: bk.biz.id=2
      - name: OTEL RESOURCE_ATTRIBUTES
        value: 18ed4404-f20b-457d-a5e8-7fa964061823

容器安装探针

（1）提前拉取java agent镜像

docker pull ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-java:1.28.0

（2）添加参数

注意部署文件中annotations的添加位置，在多容器情况下需要指定注入的容器名称
若Instrumentation修改过，则注入容器的部署部分需要重新部署，或者重新拉起新的pod

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment-with-multiple-containers
spec:
  selector:
    matchLabels:
      app: my-pod-with-multiple-containers
  replicas: 1
  template:
    metadata:
      labels:
        app: my-pod-with-multiple-containers
      annotations:
        instrumentation.opentelemetry.io/inject-java: "true"
        instrumentation.opentelemetry.io/container-names: "myapp"
    spec:
      containers:
      - name: myapp
        image: myImage1
      - name: myapp2
        image: myImage2
      - name: myapp3
        image: myImage3

查看调用链

版本依赖

目前WeOps内置的探针版本为v0.82.0，适用的K8S版本号为：v1.19 to v1.27

OpenTelemetry Operator	Kubernetes	Cert-Manager
v0.90.0	v1.23 to v1.28	v1
v0.89.0	v1.23 to v1.28	v1
v0.88.0	v1.23 to v1.28	v1
v0.87.0	v1.23 to v1.28	v1
v0.86.0	v1.23 to v1.28	v1
v0.85.0	v1.19 to v1.28	v1
v0.84.0	v1.19 to v1.28	v1
v0.83.0	v1.19 to v1.27	v1
v0.82.0	v1.19 to v1.27	v1
v0.81.0	v1.19 to v1.27	v1
v0.80.0	v1.19 to v1.27	v1
v0.79.0	v1.19 to v1.27	v1
v0.78.0	v1.19 to v1.27	v1
v0.77.0	v1.19 to v1.26	v1
v0.76.1	v1.19 to v1.26	v1
v0.75.0	v1.19 to v1.26	v1

K8S集群Beyla接入指引

第一步、创建命名空间并配置权限

创建命名空间 kubectl create namespace beyla

创建ServiceAccount并绑定ClusterRole授权，授予pod和ReplicaSets的list和watch权限

apiVersion: v1
kind: ServiceAccount
metadata:
  name: beyla
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: beyla
rules:
  - apiGroups: ["apps"]
    resources: ["replicasets"]
    verbs: ["list", "watch"]
  - apiGroups: [""]
    resources: ["pods"]
    verbs: ["list", "watch"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: beyla
subjects:
  - kind: ServiceAccount
    name: beyla
    namespace: beyla
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: beyla

第二步、配置Beyla的采集规则

部署Beyla前，需通过配置采集规则，定义采集K8S集群中的哪些数据

apiVersion: v1
kind: ConfigMap
metadata:
  namespace: beyla
  # 如果需要接入多个的业务，需部署多套Beyla，需更改metadata.name保证不重复
  name: beyla-config
data:
  beyla-config.yml: |
    # 开启kubernetes发现和元数据
    attributes:
      kubernetes:
        enable: true

    # 提供自动路由报告，同时最小化基数
    routes:
      unmatched: heuristic
      
    # 填写需要检测的服务的deployment，比如检测docs的deployment
    discovery:
      services:
        - k8s_deployment_name: "^docs$" # 根据实际的命名规则调整正则表达式
        # 还可以支持检测多个deployment，比如解除下方注释则会同时检测docs和website的deployment
        # - k8s_deployment_name: "^website$"

除了使用k8s_deployment_name字段作为检测规则外，还支持以下字段（选择一类字段使用即可）：

k8s_pod_name
k8s_namespace
k8s_replicaset_name
k8s_statefulset_name
k8s_daemonset_name
k8s_owner_name (Deployment, ReplicaSet, DaemonSet or StatefulSet)

第三步、使用DaemonSet方式部署Beyla

具体如下：

apiVersion: apps/v1
kind: DaemonSet
metadata:
  namespace: beyla
  # 如果需要接入多个的业务，需部署多套Beyla，需更改metadata.name保证不重复
  name: beyla
spec:
  selector:
    matchLabels:
      instrumentation: beyla # 需与metadata.name保持一致
  template:
    metadata:
      labels:
        instrumentation: beyla # 需与metadata.name保持一致
    spec:
      serviceAccountName: beyla
      hostPID: true # 必须为true，否则将导致Beyla服务异常
      volumes:
        - name: beyla-config
          configMap:
            name: beyla-config # 需与第二步中采集规则的metadata.name一致
      containers:
        - name: beyla
          image: grafana/beyla:1.3.1
          securityContext:
            privileged: true # 必须为true，否则将导致Beyla服务异常
          volumeMounts:
            - mountPath: /config
              name: beyla-config
          env:
            - name: BEYLA_CONFIG_PATH
              value: /config/beyla-config.yml
            - name: OTEL_EXPORTER_OTLP_ENDPOINT
              valueFrom:
                secretKeyRef:
                  name: grafana-credentials
                  key: otlp-endpoint
            - name: OTEL_EXPORTER_OTLP_HEADERS
              valueFrom:
                secretKeyRef:
                  name: grafana-credentials
                  key: otlp-headers
            - name: OTEL_RESOURCE_ATTRIBUTES
              value: bk.biz.id=2  # WeOps中的配置应用id

7、仪表盘说明

7.1 仪表盘说明

序号	仪表盘名称	关键指标
1	单主机运行状态	CPU使用率、应用内存可用率、磁盘空间使用率、1分钟系统负载、系统进程数、磁盘IO使用率、当前连接数、网卡出流量、网卡入流量、可用inode数量
2	应用主机运行状态	CPU使用率、内存剩余空间、磁盘空间使用率、5分钟系统负载、磁盘IO使用率、当前连接数、网卡出流量、网卡入流量
3	Oracle监控	数据库状态、服务器CPU使用率、服务器内存使用率、数据库会话数、进程数、解析次数、执行次数、PGA使用率、表空间使用率、SGA使用率、当前资源使用量、用户提交次数、ASM磁盘使用率、系统I/O等待时间、用户I/O等待时间、归档日志空间使用率
4	MySQL监控	服务器CPU使用率、服务器内存使用率、执行命令总数、当前已连接的线程数、查询缓存命中数、慢查询的次数、最大连接数、IO线程运行状态、InnoDB日志文件大小、主从延迟时间、SQL线程运行状态、InnoDB缓冲池大小、打开文件数、查询总次数
5	MSSQL监控	数据库状态、数据库连接数、用户错误数、服务器CPU使用率、服务器内存使用率、缓冲区命中率、阻塞进程数、数据库文件使用率、页面错误次数、I/O暂停时间、数据库日志文件使用率、页面读取数、死锁数、批量请求、页面写入数
6	Redis监控仪表盘	Redis可用性、内存碎片率、客户端连接数、拒绝的连接数、服务器CPU使用率、服务器内存使用率、处理命令数、网络接送流量、Key数量、过期的key数量、已删除key数量、命令执行数量、命令执行时间
7	Apache监控仪表盘	Apache状态、运行时间、服务进程状态、重启配置次数、服务器CPU使用率、服务器内存使用率、总访问次数、发送总量、进程CPU秒数总计、进程最大文件描述符数、进程打开文件描述符数、服务平均负载、CPU使用负载
8	Tomcat监控仪盘	服务器CPU使用率、服务器内存使用率、会话数、请求数、过期会话数、全局处理总时长、发送的流量、接收的流量、线程连接数、当前线程数、繁忙线程数
9	Nginx监控仪盘	Nginx监控状态、活动连接数、已接受连接数、已处理连接数、服务器CPU使用率、服务器内存使用率、读取连接数、写入连接数、空闲连接数、请求总数

7.2 仪表盘各个组件说明

所属模块	组件名称	作用	支持的配置
监控	仪表盘	展示指定时间范围内，该监控指标的最近数值	1、配置需要展示的监控指标 2、可以根据选择的维度汇聚方式展示“最大值”“最小值”“平均值”“累加值”“维度数量” 3、支持配置仪表盘展示的最大值/最小值，支持选择各个阈值的配色
监控	单值	展示指定时间范围内，该监控指标的最近数值	1、配置需要展示的监控指标 2、可以根据选择的维度汇聚方式展示“最大值”“最小值”“平均值”“累加值”“维度数量”
监控	饼形图	指定时间范围内，该监控指标的最近数值，每个饼状图代表一项资产，若有多维度则展示百分比	1、配置需要展示的监控指标
监控	柱状图	展示指定时间范围内，该监控指标的最近数值；柱状图的每一簇代表一项资产，若资产有多维度，则展示多条	1、配置需要展示的监控指标
监控	折线图	以时间为横坐标展示指定时间内该监控指标的数值变化，多资产和多维度都在用一个折线图中展示	1、配置需要展示的监控指标 2、支持配置阈值线 3、支持配置是否面积填充
资产	资产表格	展示选中的资产基本配置信息	1、支持配置所有资产管理的资产 2、支持选择展示的字段 3、对于枚举型字段等特殊字段，支持筛选/排序等操作
自动化	运维工具	展示/执行各个运维工具	1、配置展示不同的运维工具 2、在仪表盘直接使用该工具对选中的资产进行操作，并展示执行结果
日志	日志消息	展示日志的原始消息	1、配置搜索条件 2、配置展示字段 3、支持配置某个字段的升序/降序
日志	单值	展示单个数值或统计结果，最近数据的第一个值	1、配置分组和度量，确定统计的角度和值 2、设置趋势：越大越好、越小越好，普通
日志	表格	以表格的形式展示各个分组的度量统计数值	1、配置搜索语句 2、配置分组和度量，确定统计的角度和值 3、配置排序，分组和度量的字段可以设置排序
日志	饼形图	按照特定度量字段，统计各个分组该度量值所占的百分比	1、配置搜索语句 2、配置分组和度量，确定统计的角度和值 3、配置排序，分组和度量的字段可以设置排序
日志	折线图	用于展示统计数据的变化趋势，比如随时间的变化趋势	1、配置搜索语句 2、配置分组和度量，确定统计的角度和值 3、配置排序，分组和度量的字段可以设置排序
日志	柱状图	以柱形图展示日志数据，展示各个分组的度量值	1、配置搜索语句 2、配置分组和度量，确定统计的角度和值 3、配置排序，分组和度量的字段可以设置排序 4、支持设置堆叠/分组模式
日志	地图	以地图的形式展示IP地址的地域分布情况	1、配置搜索语句 2、选择中国地图/世界地图 3、配置地域字段 4、支持阈值配色
高级	单值	填写Trino语句，获取对应数据后，以单值形式呈现	1、填写Trino语句
高级	折线图	填写Trino语句，获取对应数据后，以折线图形式呈现	1、填写Trino语句 2、配置X轴、Y轴展示的数值和维度数值
高级	饼形图	填写Trino语句，获取对应数据后，以饼形图形式呈现	1、填写Trino语句 2、配置分组（组别）和度量值
高级	柱状图	填写Trino语句，获取对应数据后，以柱状图形式呈现	1、填写Trino语句 2、配置X轴、Y轴展示的数值和维度数值
高级	表格	填写Trino语句，获取对应数据后，以表格形式呈现	1、填写Trino语句
高级	流量拓扑	填写Trino语句，获取对应数据后，以流量拓扑形式呈现	1、填写Trino语句 2、配置源对象和目标对象 3、配置连线数值和阈值配色
高级	桑基图	填写Trino语句，获取对应数据后，以桑基图形式呈现	1、填写Trino语句 2、配置源对象、目标对象和度量值

8、健康扫描包说明

共内置11个扫描包，各个扫描包的介绍和相关指标见下表

序号	扫描包名称	对象	操作系统	检查项数量	检查项
1	基础健康检查-Windows	主机	Windows	10	Windows是否激活、内存可用大小、磁盘空间使用率（Windows）、磁盘可用空间（Windows）、磁盘IO读速率、磁盘IO写速率、DCP时间百分比、处理器队列长度、逻辑磁盘队列长度、每秒页面错误数
2	基础健康检查-Linux	主机	Linux	8	磁盘空间使用率（Linux）、磁盘可用空间（Linux）、交换空间使用率、iNode可用大小、iNode使用率、僵尸进程数、TIME_WAIT状态的连接数、passwd文件权限
3	基础健康检查-ActiveDirectory	ActiveDirectory		4	AD数据库文件盘可用空间、AD数据库日志文件盘可用空间、AD健康性检查、时间偏差检查
4	基础健康检查-ExchangeServer	ExchangeServer（支持系统为Exchange Server 2016/2019的邮箱角色）		22	关键服务测试、活动目录连接测试、ActiveSync连接测试、Ecp连接测试、Imap连接测试、Owa连接测试、Pop连接测试、Outlook连接测试、Smtp连接测试、复制健康性测试、数据包出站错误、数据库平均读延迟、数据库平均写延迟、数据库日志平均读延迟、数据库日志平均写延迟、应用重启次数、工作进程重启次数、应用队列中的请求数、RPC请求数（信息存储进程）、RPC平均延迟（客户端协议）、RPC平均延迟（数据库）、证书过期时间
5	基础健康检查- MSSQL（Windows）	MSSQL	Windows	26	缓冲区命中率、磁盘空间使用率、可用连接数、MSSQL内存可用大小、阻塞源会话(近一个小时)、死锁情况(近一个小时)、长事务（TOP5）、页生存周期、实例内存使用情况、数据库使用内存、可用线程数、资源等待Top5、磁盘队列数、群集资源状态、群集网络状态、群集仲裁状态、AlwaysOn同步健康状态、AlwaysOn发送队列大小、AlwaysOn重做队列大小、AlwaysOn重做延迟时长、文件组可用大小、错误日志磁盘可用大小、作业执行失败Top20、最近备份时间、SQL代理服务启动方式、最近完整备份时间
6	基础健康检查- MySQL（Windows）	MySQL	Windows	17	InnoDB缓冲区命中率、每秒查询数、每秒事务数、每秒全表扫描数量、慢查询数量、数据空间使用率、Binlog日志空间使用率、不能立即获得表锁次数、InnoDB行锁次数、可用连接数、数据文件总大小、InnoDB缓存池可用大小、锁等待数量、操作系统CPU使用率、操作系统内存使用率、操作系统内存可用大小、操作系统交换空间使用率
7	基础健康检查- MySQL（Linux）	MySQL	Linux	17	InnoDB缓冲区命中率、每秒查询数、每秒事务数、每秒全表扫描数量、慢查询数量、数据空间使用率、Binlog日志空间使用率、不能立即获得表锁次数、InnoDB行锁次数、可用连接数、数据文件总大小、InnoDB缓存池可用大小、锁等待数量、操作系统CPU使用率、操作系统内存使用率、操作系统内存可用大小、操作系统交换空间使用率
8	基础健康检查- Oracle（Windows）	Oracle	Windows	20	缓冲区命中率、共享池命中率、表空间空间使用率、归档空间使用率、数据空间使用率、ASM磁盘组空间使用率、可用会话数、可用进程数、SQL硬解析百分比、内存排序百分比、无效索引个数、行锁等待大于1分钟数量、联机日志每小时切换次数、DG状态、最近备份成功状态、实例状态、监听状态、Oracle目录使用率、操作系统内存使用率、操作系统内存可用大小
9	基础健康检查- Oracle（Linux）	Oracle	Linux	14	缓冲区命中率、共享池命中率、表空间空间使用率、可用会话数、可用进程数、SQL硬解析百分比、内存排序百分比、无效索引个数、行锁等待大于1分钟数量、联机日志每小时切换次数、最近备份成功状态、实例状态、监听状态、Oracle目录使用率
10	基础健康检查- vCenter（Windows）	vCenter	Windows	7	物理机最新启动时间、物理机cpu使用率、物理机内存使用率、物理机上虚拟机数量、存储空间使用率、物理机NTP服务器、物理机NTP服务状态
11	基础健康检查- vCenter（Linux）	vCenter	Linux	7	物理机最新启动时间、物理机cpu使用率、物理机内存使用率、物理机上虚拟机数量、存储空间使用率、物理机NTP服务器、物理机NTP服务状态

9、运维工具说明

内置的脚本工具的介绍见下表

序号	工具类型	工具名	脚本类型	工具介绍
1	操作系统类	查询消耗系统内存最多的进程	shell(Linux)	查找出Linux系统当前占用内存资源最多的TopN进程
2	操作系统类	查询消耗系统CPU最多的进程	shell(Linux)	查找出Linux系统当前占用CPU资源最多的TopN进程
3	操作系统类	MSSQL全库备份	powershell(Windows)	将MSSQL全库备份到所选服务器的指定目录，支持SQL Server 2008 R2及以上版本
4	操作系统类	修改Windows本地账号密码	powershell(Windows)	修改Windows本地账号密码，支持Powershell 5.2及以上版本
5	操作系统类	修改Linux账号密码	shell(Linux)	修改Linux账号密码
6	操作系统类	查询系统本地帐户信息	powershell(Windows)	查找出Windows系统所有本地帐户的信息
7	操作系统类	查询AD用户上次登陆时间	powershell(Windows)	查找出指定的AD用户上次登陆时间，需在域服务器执行该脚本
8	操作系统类	查询服务进程状态信息	shell(Linux)	查找出Linux系统指定进程的状态信息
9	操作系统类	查询占用空间最大的目录和文件	shell(Linux)	查找出Linux系统指定目录下占用空间最大的top N目录和文件
10	操作系统类	Ping	shell(Linux)	测试所选主机与目标主机的数据连通性是否正常
11	操作系统类	查看Linux日志文件	shell(Linux)	查看Linux日志文件，协助问题排查
12	操作系统类	AD密码质量审计	powershell(Windows)	执行AD审计，检查AD账号使用弱密码、重复密码、默认密码和空密码等情况
13	操作系统类	查找容量最大的文件	shell(Linux)	查找容量最大的文件
14	操作系统类	统计目录的文件数量	shell(Linux)	统计目录的文件数量
15	操作系统类	查询僵尸进程数	shell(Linux)	查询僵尸进程数
16	操作系统类	查询文件打开数最多的进程	shell(Linux)	查询文件打开数最多的进程
17	操作系统类	MySQL显示错误日志内容	shell(Linux)	MySQL显示错误日志内容
18	操作系统类	Oracle显示错误日志内容	shell(Linux)	Oracle显示错误日志内容
19	操作系统类	MySQL显示参数值	shell(Linux)	MySQL显示参数值
20	操作系统类	查询网络连接数最多的服务	python(Linux)	查询网络连接数最多的服务
21	操作系统类	查找UID或GID为0的系统用户	shell(Linux)	查找UID或GID为0的系统用户
22	操作系统类	查询已删除用户的进程	shell(Linux)	查询已删除用户的进程
23	操作系统类	Oracle显示参数值	shell(Linux)	Oracle显示参数值
24	操作系统类	查询权限为777的文件	shell(Linux)	查询权限为777的文件
25	操作系统类	统计TIME_WAIT连接数量	python(Linux)	统计TIME_WAIT连接数量
26	操作系统类	查询无属主或无属组的文件	shell(Linux)	查询无属主或无属组的文件
27	操作系统类	查询进程的文件打开数	shell(Linux)	查询进程的文件打开数
28	操作系统类	收集sosreport	shell(Linux)	收集sosreport或 supportconfig
29	操作系统类	检查拥有sudo权限账号或组	shell(Linux)	检查拥有sudo权限账号或组
30	操作系统类	MySQL查询实例连接数和活动连接数	shell(Linux)	MySQL查询实例连接数和活动连接数
31	操作系统类	Oracle查询实例连接数和活动连接数	shell(Linux)	Oracle查询实例连接数和活动连接数
32	操作系统类	Oracle查看正在运行的SQL语句	shell(Linux)	Oracle查看正在运行的SQL语句
33	操作系统类	Oracle查看最近15分钟的等待事件	shell(Linux)	Oracle查看最近15分钟的等待事件
34	操作系统类	Oracle查询会话增长趋势	shell(Linux)	Oracle查询会话增长趋势
35	操作系统类	Oracle查看当前的等待事件	shell(Linux)	Oracle查看当前的等待事件
36	操作系统类	Oracle查看表空间的大小和可用空间	shell(Linux)	Oracle查看表空间的大小和可用空间
37	操作系统类	Oracle查看数据库锁信息	shell(Linux)	Oracle查看数据库锁信息
38	操作系统类	查看系统防火墙启用情况	powershell(Windows)	查看系统防火墙启用情况
39	操作系统类	查看占用内存 Top10进程信息	powershell(Windows)	查看占用内存 Top10进程信息
40	操作系统类	Oracle查看ASM磁盘组大小和可用空间	shell(Linux)	Oracle查看ASM磁盘组大小和可用空间
41	操作系统类	Oracle查询数据库中具有DBA权限的用户	shell(Linux)	Oracle查询数据库中具有DBA权限的用户
42	操作系统类	MySQL查看表空间的大小和可用空间	shell(Linux)	MySQL查看表空间的大小和可用空间
42	操作系统类	MySQL查询当前运行的SQL语句	shell(Linux)	MySQL查询当前运行的SQL语句
43	操作系统类	查看所有物理网卡的网线连接状态	shell(Linux)	查看所有物理网卡的网线连接状态
44	操作系统类	Linux补丁升级	shell(Linux)	适用于已部署Yum源的Linux服务器

序号	工具类型	工具名	脚本类型	工具介绍
1	网络设备类	显示CDP查找进程的结果（思科）	telnet	可以看见本地接口ID，与此接口直连的设备ID,设备类型，若对端接口是路由接口，可以看见对端接口ID
2	网络设备类	显示打开的CDP接口信息（思科）	telnet	可以看见接口状态，连接状态，封装类型，发送cdp报文周期
3	网络设备类	显示CDP表中所列相邻设备的信息（思科）	telnet	展示运行cdp协议的邻居设备的详细信息：设备ID，厂家，设备能力，ip地址，IOS类型和版本，设备功能
4	网络设备类	展示总包吞吐量（思科）	telnet
5	网络设备类	展示接口统计信息（思科）	telnet	显示设置在路由器和访问服务器上所有接口的统计信息
6	网络设备类	显示连接所有用户（思科）	telnet
7	网络设备类	显示产品库存清单（思科）	telnet	显示安装的所有思科产品的产品库存清单和UDI
8	网络设备类	显示接口的状态和全局参数（思科）	telnet
9	网络设备类	显示路由选择表的当前状态（思科）	telnet
10	网络设备类	显示IP路由表信息（思科）	telnet
11	网络设备类	显示路由器的进程（思科）	telnet
12	网络设备类	显示设置的协议（思科）	telnet	显示全局和接口的第三层协议的特定状态。
13	网络设备类	显示内存大小（思科）	telnet
14	网络设备类	展示进程内存使用量（思科）	telnet	显示每个系统进程或指定进程使用的内存量
15	网络设备类	展示进程CPU使用率（思科）	telnet	显示所有进程及其CPU利用率
16	网络设备类	显示系统版本信息（思科）	telnet

【备注】网络设备自动化运维支持的范围如下 | 类别|型号| | -----| ----| | 网络设备自动化支持的型号|A10, Accedian, AdtranOS,AlcatelAos,NokiaSros, ApresiaAeos, Arista, Aruba, HPProcurve, HPProcurve, ExtremeErs, ExtremeVsp, BroadcomIcos, RuckusFastiron, ExtremeNetiron, ExtremeNos,ExtremeNos, VyOS, CheckPointGaia, CalixB6,CentecOS,CienaSaos,CiscoAsa,CiscoFtd,CiscoIos,CiscoNxos,CiscoS300,CiscoTpTcCe,CiscoWlc,CiscoIos,CiscoXr,CloudGenixIon,Coriant,DellForce10,DellForce10,DellDNOS6,DellForce10,DellOS10,DellPowerConnect,DellIsilon,DlinkDS,Endace,Eltex,EltexEsr,Enterasys,ExtremeExos,ExtremeErs,ExtremeExos, ExtremeNetiron,ExtremeNos,ExtremeSlx,ExtremeNos,ExtremeVsp,ExtremeWing,F5Tmsh,F5Tmsh,F5Linux,Flexvnf,Fortinet,Generic,TerminalServer,HPComware,HPProcurve,Huawei,HuaweiSmartAX,HuaweiSmartAX,HuaweiVrpv8,IpInfusionOcNOS,Juniper,Juniper,JuniperScreenOs,Keymile,KeymileNOS,Linux, MikrotikRouterOs,MikrotikSwitchOs,MellanoxMlnxos, MellanoxMlnxos,MrvLx, MrvOptiswitch,NetAppcDot,NetgearProSafe,Netscaler, NokiaSros, OneaccessOneOS,OvsLinux, PaloAltoPanos,Pluribus,QuantaMesh,RaisecomRoap,RuckusFastiron,RuijieOS,SixwindOS,SophosSfos,TPLinkJetStream,UbiquitiEdge, UbiquitiEdgeRouter, UbiquitiEdge, UbiquitiUnifiSwitch,VyOS, WatchguardFireware, ZteZxros, Yamaha,|

10、内置工单流程

共内置5个自动化工单流程，具体介绍见下表

序号	服务名称	服务流程
1	AD账号创建	【前置条件】AD已经纳管/AD凭据已经录入→【提单】填写新建的信息→【管理员审批】选择域和组→【自动执行】引用自动化流程自动批量创建→【发送邮件】申请人接收通知邮件
2	AD账号密码重置	【前置条件】AD已经纳管/AD凭据已经录入→【提单】填写重置信息→【管理员审批】选择域和组→【自动执行】引用自动化流程自动批量重置→【发送邮件】申请人接收通知邮件
3	AD账号禁用	【前置条件】AD已经纳管/AD凭据已经录入→【提单】填写禁用的信息→【管理员审批】选择域和组→【自动执行】引用自动化流程自动批量禁用→【发送邮件】申请人接收通知邮件
4	AD账号删除	【前置条件】AD已经纳管/AD凭据已经录入→【提单】填写删除的信息→【管理员审批】选择域和组→【自动执行】引用自动化流程自动批量删除→【发送邮件】申请人接收通知邮件
5	数据库SQL语句执行	【前置条件】数据库已经纳管/数据库凭据已经录入→【提单】填写执行对象和SQL语句→【管理员审批】审批并选择凭据→【自动执行】引用自动化流程自动执行
6	VMware虚拟机创建	【前置条件】vcenter已经纳管并设置自动发现/凭据已经录入→【提单】填写申请的虚拟机配置→【管理员审批】审批并选择凭据→【自动执行】引用自动化流程自动执行
7	VMware虚拟机快照创建	【前置条件】vcenter已经纳管并设置自动发现/凭据已经录入→【提单】填写申请的信息→【管理员审批】审批并选择凭据→【自动执行】引用自动化流程自动执行
8	VMware虚拟机快照回滚	【前置条件】vcenter已经纳管并设置自动发现/凭据已经录入→【提单】填写申请的信息→【管理员审批】审批并选择凭据→【自动执行】引用自动化流程自动执行

共内置36个工单流程，具体介绍见下表

序号	服务类型	服务流程	流程字段
1	【AD相关】	开通AD帐号	使用人、账号名、显示名、手机号、邮箱、部门、使用时间、禁用时间、用途、紧急程度
2	【AD相关】	续用AD帐号	使用人、账号名、手机号、邮箱、部门、禁用时间、原因、紧急程度
3	【AD相关】	修改AD帐号信息	使用人、账号名、部门、修改内容、原因、紧急程度
4	【AD相关】	重置AD帐号密码	使用人、账号名、部门、原因、紧急程度
5	【AD相关】	禁用AD帐号	使用人、账号名、部门、原因、紧急程度
6	【邮箱相关】	开通邮箱帐号	使用人、账号名、手机号、部门、使用时间、释放时间、邮箱容量、原因、紧急程度
7	【邮箱相关】	续用邮箱帐号	使用人、邮箱、部门、释放时间、补充说明、紧急程度
8	【邮箱相关】	扩容邮箱帐号	使用人、邮箱、部门、原因、扩容量、紧急程度
9	【邮箱相关】	注销邮箱帐号	使用人、邮箱、部门、原因、紧急程度
10	【服务器相关】	申请服务器	使用人、部门、使用时间、释放时间、规格、操作系统、指定IP、用途、补充说明、紧急程度
11	【服务器相关】	续用服务器	使用人、部门、服务器IP、释放时间、用途、紧急程度
12	【服务器相关】	释放服务器	使用人、部门、服务器IP、原因、紧急程度
13	【服务器相关】	扩容服务器	使用人、部门、服务器IP、现规格、扩充至、紧急程度
14	【服务器相关】	创建服务器快照	使用人、部门、服务器IP、原因、紧急程度
15	【服务器相关】	回滚服务器快照	使用人、部门、服务器IP、原因、快照时间、紧急程度
16	【服务器相关】	服务器文件上传	使用人、部门、服务器IP、操作系统、原因、紧急程度、附件
17	【服务器相关】	服务器文件下载	使用人、部门、服务器IP、操作系统、文件路径、原因、紧急程度
18	【服务器相关】	开通网络策略	使用人、部门、服务器IP、开通端口、用途、紧急程度
19	【笔记本相关】	申请笔记本	使用人、部门、操作系统、型号、规格、预装软件、使用时间、退还时间、用途、紧急程度
20	【笔记本相关】	续用笔记本	使用人、部门、资产编码、型号、退还时间、原因、紧急程度
21	【笔记本相关】	维修笔记本	使用人、部门、资产编码、型号、是否为公司电脑、维修方式、故障现象、故障原因、紧急程度
22	【笔记本相关】	更换笔记本	使用人、部门、资产编码、型号、现规格型号、期望规格型号、原因、紧急程度
23	【笔记本相关】	退还笔记本	使用人、部门、资产编码、型号、原因
24	【笔记本相关】	安装办公软件	使用人、部门、资产编码、型号、操作系统、软件名称、软件版本、用途、紧急程度
25	【办公设备相关】	申请办公设备	使用人、部门、设备类型、使用时间、退还时间、用途、其他要求、紧急程度
26	【办公设备相关】	续用办公设备	使用人、部门、资产编码、设备类型、型号、退还时间、原因、紧急程度
27	【办公设备相关】	维修办公设备	使用人、部门、资产编码、设备类型、型号、故障现象、故障原因
28	【办公设备相关】	更换办公设备	使用人、部门、资产编码、设备类型、现规格型号、期望规格型号、原因、紧急程度
29	【办公设备相关】	退还办公设备	使用人、部门、资产编码、型号、原因
30	【办公设备相关】	打印机加纸	设备位置、紧急程度
31	【办公设备相关】	更换墨盒	设备位置、紧急程度
32	【门禁相关】	申请门禁账号	使用人、工号、部门、使用时间、注销时间、原因、紧急程度
33	【门禁相关】	续用门禁帐号	使用人、工号、部门、注销时间、原因、紧急程度
34	【门禁相关】	重置门禁密码	使用人、工号、部门、原因、紧急程度
35	【门禁相关】	注销门禁账号	使用人、工号、部门、原因、紧急程度
36	【告警转工单】	告警转工单	标题、关联业务、影响范围、紧急程度、优先级、描述

嘉为蓝鲸WeOps 4.17 内容说明

1、资源模型内置说明​

2、监控指标说明​

2.1 各对象支持监控方式汇总​

2.2 各对象监控说明​

3、监控插件参数和权限说明​

3.1 MSSQL​

使用说明​

参数说明​

使用指引​

3.2 MySQL​

使用说明​

参数说明​

使用指引​

3.3 Oracle​

使用说明​

参数说明​

使用指引​

3.4 postgres​

使用说明​

参数说明​

额外参数说明​

使用指引​

3.5 Redis​

使用说明​

参数说明​

使用指引​

3.6 MongoDB​

使用说明​

参数说明​

额外参数说明​

使用指引​

3.7 IIS​

使用说明​

参数说明​

使用指引​

3.8 AD​

参数说明​

3.9 Exchange​

参数说明​

3.10 ElasticSearch​

使用说明​

参数说明​

使用指引​

3.11 Kafka​

使用说明​

参数说明​

使用指引​

3.12 Tomcat​

使用说明​

参数说明​

使用指引​

3.13 Apache​

使用说明​

参数说明​

使用指引​

3.14 Nginx​

使用说明​

参数说明​

使用指引​

3.15 Zookeeper​

使用说明​

参数说明​

使用指引​

3.16 RabbitMQ​

使用说明​

参数说明​

使用指引​

3.17 TiDB​

使用说明​

参数说明​

使用指引​

3.18 IBM MQ​

使用说明​

参数说明​

使用指引​

3.19 minio​

使用说明​

参数说明​

使用指引​

1、资源模型内置说明

2、监控指标说明

2.1 各对象支持监控方式汇总

2.2 各对象监控说明

3、监控插件参数和权限说明

3.1 MSSQL

使用说明

参数说明

使用指引

3.2 MySQL

使用说明

参数说明

使用指引

3.3 Oracle

使用说明

参数说明

使用指引

3.4 postgres

使用说明

参数说明

额外参数说明

使用指引

3.5 Redis

使用说明

参数说明

使用指引

3.6 MongoDB

使用说明

参数说明

额外参数说明

使用指引

3.7 IIS

使用说明

参数说明

使用指引

3.8 AD

参数说明

3.9 Exchange

参数说明

3.10 ElasticSearch

使用说明

参数说明

使用指引

3.11 Kafka

使用说明

参数说明

使用指引

3.12 Tomcat

使用说明

参数说明

使用指引

3.13 Apache

使用说明

参数说明

使用指引

3.14 Nginx

使用说明

参数说明

使用指引

3.15 Zookeeper

使用说明

参数说明

使用指引

3.16 RabbitMQ

使用说明

参数说明

使用指引

3.17 TiDB

使用说明

参数说明

使用指引

3.18 IBM MQ

使用说明

参数说明

使用指引

3.19 minio

使用说明

参数说明

使用指引

3.20 nacos