服务端应用错误巡检

背景

当服务端出现运行错误时，我们需要提早发现及时预警来让开发运维进行排错，及时确认错误是否对应用有潜在影响。服务端应用错误巡检事件上报的内容是提醒开发运维在过去一小时里应用出现了新的错误并定位到具体的出错的地方将关联的诊断线索一起提供给用户。

前置条件

在观测云「应用性能监测」已经存在接入的应用
自建 DataFlux Func 的离线部署
开启自建 DataFlux Func 的脚本市场
在观测云「管理 / API Key 管理」中创建用于进行操作的 API Key
在自建的 DataFlux Func 中，通过「脚本市场」安装「观测云自建巡检 Core 核心包」「观测云算法库」「观测云自建巡检（APM 错误）」
在自建的 DataFlux Func 中，编写自建巡检处理函数
在自建的 DataFlux Func 中，通过「管理 / 自动触发配置」，为所编写的函数创建自动触发配置

如果考虑采用云服务器来进行 DataFlux Func 离线部署的话，请考虑跟当前使用的观测云 SaaS 部署在同一运营商同一地域

配置巡检

在自建 DataFlux Func 创建新的脚本集开启内存泄漏巡检配置

Python
from guance_monitor__runner import Runner
from guance_monitor__register import self_hosted_monitor
import guance_monitor_apm_error__main as main

# 账号配置
API_KEY_ID  = 'wsak_xxxxxx'
API_KEY     = '5K3Ixxxxxx'

# 函数 filters 参数过滤器和观测云 studio 监控\智能巡检配置中存在调用优先级，配置了函数 filters 参数过滤器后则不需要在观测云 studio 监控\智能巡检中更改检测配置了，如果两边都配置的话则优先生效脚本中 filters 参数

def filter_project_servcie_sub(data):
    # {'project': None, 'service_sub': 'mysql:dev'}, {'project': None, 'service_sub': 'redis:dev'}, {'project': None, 'service_sub': 'ruoyi-gateway:dev'}, {'project': None, 'service_sub': 'ruoyi-modules-system:dev'}
    project = data['project']
    service_sub = data['service_sub']
    if service_sub in ['ruoyi-08-auth:dev:1.0']:
        return True

'''
任务配置参数请使用：
@DFF.API('服务端应用错误巡检', fixed_crontab='0 * * * *', timeout=1800)

fixed_crontab：固定执行频率「每小时一次」
timeout：任务执行超时时长，控制在 30 分钟
'''

# 服务端应用错误巡检配置 用户无需修改
@self_hosted_monitor(API_KEY_ID, API_KEY)
@DFF.API('服务端应用错误巡检', fixed_crontab='0 * * * *', timeout=1800)
def run(configs={}):
    """
    参数：
        configs：配置需要检测的 app_name 列表（可选，不配置默认检测所有 app_name）

        配置示例：
        configs = {
            "project": ["project", "project2"]  项目
            "env"    : ["env1", "env2"]         环境
            "version": ["version1", "version2"] 版本
            "service": ["service1", "service2"] 服务
        }
    """
    checkers = [
        # APM 错误巡检
        main.ApmErrorCheck(configs=configs, filters=[filter_project_servcie_sub]),

    ]

    Runner(checkers, debug=False).run()

开启巡检

在观测云中注册检测项

在 DataFlux Func 中在配置好巡检之后可以通过直接再页面中选择 run() 方法进行点击运行进行测试，在点击发布之后就可以在观测云「监控 / 智能巡检」中查看并进行配置

在观测云中配置服务端应用错误巡检

启用/禁用

内存泄漏巡检默认是「开启」状态，可手动「关闭」，开启后，将对配置好的服务列表进行巡检。

导出

智能巡检支持“导出 JSON 配置”。在智能巡检列表右侧的操作菜单下，点击「导出」按钮，即可导出当前巡检的 JSON 代码，导出文件名格式：智能巡检名称.json 。

编辑

智能巡检「服务端应用错误巡检」支持用户手动添加筛选条件，在智能巡检列表右侧的操作菜单下，点击「编辑」按钮，即可对巡检模版进行编辑。

筛选条件：配置需要检测的 app_name 列表（可选，不配置默认检测所有 app_name）
告警通知：支持选择和编辑告警策略，包括需要通知的事件等级、通知对象、以及告警沉默周期等

配置入口参数点击编辑后在参数配置中填写对应的检测对象点击保存开始巡检：

可以参考如下的 JSON 配置多个项目、环境、版本和服务的信息

JSON
// 配置示例：
configs = {
    "project": ["project", "project2"],  // 项目
    "env"    : ["env1", "env2"],         // 环境
    "version": ["version1", "version2"], // 版本
    "service": ["service1", "service2"], // 服务
}