Apache DolphinScheduler 阿里云语音告警AliyunVoice插件配置与实现解析【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler本指南以 Apache DolphinScheduler 的阿里云语音告警插件AliyunVoice为核心讲解如何通过告警实例管理创建语音告警实例、填写被叫号码/呼叫显示号码/语音模板及 AccessKey 等参数并结合仓库源码剖析插件从参数解析、阿里云语音服务调用到结果回传的完整链路。读者读完可独立完成语音告警的配置、测试与问题排查并理解其底层实现原理。一、语音告警是什么场景与定位在数据调度平台中告警的时效性至关重要。相比邮件、短信等文本通道语音通知能够在告警发生时直接拨打电话将关键故障信息以语音形式播报给值班人员适用于工作流Workflow失败、任务Task失败等高优先级告警深夜或非工作时间、值班人员无法持续盯屏的场景需要必达效果、要求第一时间人工介入的异常。Apache DolphinScheduler 的告警体系采用插件化架构语音告警作为AlertChannelFactory的一种实现注册名称为AliyunVoice。用户无需修改代码只需在告警实例管理中新建告警实例并选择语音插件即可把语音通道挂接到工作流的失败策略上。说明本插件依赖阿里云语音服务语音通知文件类型能力使用前需要在阿里云侧开通相应服务并准备好语音模板与 API 密钥。插件源码位于 dolphinscheduler-alert-aliyunVoice对应文档为 docs/docs/zh/guide/alert/aliyun-voice.md。二、创建语音告警实例进入 DolphinScheduler 的安全中心 → 告警实例管理点击创建告警实例选择告警插件类型为语音插件内部名称为AliyunVoice填写下表所述的参数保存后即可在告警组中引用该实例。如上图所示语音告警实例需要配置被叫电话号码、呼叫显示号码、语音模板、AccessKey ID、AccessKey Secret等字段。三、参数配置详解语音告警插件的参数由 VoiceAlertChannelFactory#params() 定义共 6 个输入项字段名与展示名定义在 VoiceAlertConstants.java 中占位提示语则来自 AlertInputTips.java。界面字段参数名key是否必填说明被叫电话号码calledNumber是接收语音通知的号码即真正被呼叫的号码呼叫显示号码calledShowNumber否呼叫时对端显示的号码不填则使用阿里云默认号码同时作为回调标识outId使用语音模板ttsCode否阿里云语音通知文件的语音模板编码VoiceCode/TTS Code访问域名addressaddress否阿里云语音服务 API 访问域名endpoint例如dyvmsapi.aliyuncs.com区域域名不填时客户端将使用 SDK 默认值accessKeyIdaccessKeyId否阿里云账号的 AccessKey ID用于 API 鉴权accessKeySecretaccessKeySecret否阿里云账号的 AccessKey Secret用于 API 签名各参数的详细说明如下被叫电话号码必填项对应AlertInputTips.CALLED_NUMBER请输入被叫电话号码。它是SingleCallByTts请求中的CalledNumber必须是可接听的真实手机号或固话。呼叫显示号码选填项界面提示不填则使用默认号码。从源码看该值在 VoiceAlertChannel#buildVoiceParam 中同时被设置到VoiceParam.outId作为调用方自定义的透传字段回调 ID。语音模板填写阿里云语音服务中创建的语音通知文件模板编码形如TTS_2450XXXXX。VoiceSenderTest 中即以TTS_2450XXXXX作为示例值。访问域名对应阿里云语音服务dyvmsapi的 endpoint 地址。源码中通过config.endpoint conn.getAddress()设置见下文发送链路。accessKeyId / accessKeySecret阿里云 OpenAPI 调用的鉴权凭据应妥善保管建议使用阿里云 RAM 子账号并仅授予语音服务调用权限。注前端国际化文案与上述参数一一对应见 dolphinscheduler-ui/src/locales/zh_CN/security.ts 与 en_US/security.ts其中访问域名在界面显示为Address。四、发送流程与源码级实现原理语音告警从触发到拨号经历告警事件 → 参数装配 → 阿里云 API 调用 → 结果回传四个环节核心实现为四个类VoiceAlertChannel.java告警通道入口VoiceParam.java参数封装对象VoiceSender.java真正执行发送VoiceAlertChannelFactory.java插件注册与参数定义。4.1 插件注册与参数装配VoiceAlertChannelFactory通过AutoService(AlertChannelFactory.class)注解完成 SPI 自动注册name()返回插件名称AliyunVoiceparams()返回 6 个输入参数create()实例化VoiceAlertChannel。对应测试 VoiceAlertChannelFactoryTest 验证了参数数量为 6、通道实例创建非空。告警触发后告警服务会以MapString, String形式把实例配置传入VoiceAlertChannel.process(AlertInfo info)若info.getAlertParams()为 null直接返回AlertResult(false, aliyun-voice params is null)否则调用buildVoiceParam(paramsMap)按常量 key 取出 6 个字段并装配成VoiceParam含Connection内部类承载 address、accessKeyId、accessKeySecret交由new VoiceSender(voiceParam).send()执行发送。4.2 阿里云语音 API 调用VoiceSenderVoiceSender.send()是发送核心基于阿里云官方 Java SDKcom.aliyun.dyvmsapi20170525Client client createClient(voiceParam.getConnection()); SingleCallByTtsRequest singleCallByTtsRequest new SingleCallByTtsRequest() .setCalledNumber(voiceParam.getCalledNumber()) .setTtsCode(voiceParam.getTtsCode()) .setOutId(voiceParam.getOutId()); RuntimeOptions runtime new RuntimeOptions(); SingleCallByTtsResponse response client.singleCallByTtsWithOptions(singleCallByTtsRequest, runtime);createClient使用 AccessKeyId / AccessKeySecret 构建鉴权配置并将实例中填写的address设置为config.endpoint请求类型为SingleCallByTts向指定号码发送语音通知文件类型的语音通知OutId为调用方透传的回调 ID响应体code为ok忽略大小写时判定发送成功并将callId作为成功消息返回否则返回阿里云侧的message作为失败原因任何异常都会被捕获并记录到日志log.error(send aliyun vocie error., e)同时把异常信息写入AlertResult.message。4.3 测试验证仓库提供了两类测试VoiceSenderTest使用占位手机号与假 AccessKey 构造VoiceParam并调用send()断言发送结果失败isSuccess() false验证在无效凭证下不会抛出未捕获异常VoiceAlertChannelFactoryTest验证插件参数数量与通道工厂创建行为。五、在告警组中使用语音实例创建好语音告警实例后还需要在告警组管理中把该实例加入告警组然后在工作流定义或任务定义中把失败/成功策略指向该告警组。当工作流状态满足触发条件时告警服务会读取实例配置并调用语音插件向被叫号码发起语音通知。语音通道的触发逻辑与其他告警通道完全一致均复用告警服务统一的发送调度无需额外配置。若需要验证可使用告警实例的测试功能如有或直接触发一次失败工作流观察告警日志。六、常见问题与排查建议现象可能原因排查建议发送返回失败AlertResult.message非空阿里云侧返回的业务错误码对照阿里云语音服务错误码表检查被叫号码、模板、AccessKey 权限一直不拨号AccessKey 无dyvmsapi权限或 endpoint 填错确认 RAM 子账号已授权检查实例中的访问域名与 SDK 默认值是否一致收到语音但内容不对语音模板编码填错或模板未审核通过在阿里云语音控制台核对ttsCode日志出现aliyun-vocie params is null告警实例参数未正确保存检查实例配置是否保存成功参数 map 是否为空排查时可重点查看alert-server的运行日志VoiceSender会把异常信息与阿里云返回 message 一并记录。七、小结本文以阿里云语音告警插件为主线完整覆盖了告警实例创建、6 个参数的语义与来源、发送链路的源码实现以及测试验证方式。通过 VoiceAlertChannelFactory、VoiceAlertChannel、VoiceSender 等源码可以看到插件采用标准 SPI 机制注册参数装配、鉴权配置与请求构造分层清晰告警结果callId或错误 message会完整回传至告警服务方便运维人员结合日志与阿里云侧记录定位问题。按本文步骤完成配置后即可将工作流失败信息以电话语音的方式第一时间触达值班人员。【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考