{"id":20572004,"url":"https://github.com/netease/spark-alarm","last_synced_at":"2025-07-30T11:10:45.253Z","repository":{"id":39959811,"uuid":"181623230","full_name":"NetEase/spark-alarm","owner":"NetEase","description":"Alerting and monitoring tool for Apache Spark","archived":false,"fork":false,"pushed_at":"2022-05-20T20:56:57.000Z","size":48,"stargazers_count":23,"open_issues_count":2,"forks_count":16,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-15T22:21:37.377Z","etag":null,"topics":["alert","monitoring","monitoring-tool","scala","spark"],"latest_commit_sha":null,"homepage":"https://yaooqinn.github.io/spark-alarm/","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NetEase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-16T05:51:29.000Z","updated_at":"2025-01-15T20:43:24.000Z","dependencies_parsed_at":"2022-09-05T19:22:16.556Z","dependency_job_id":null,"html_url":"https://github.com/NetEase/spark-alarm","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NetEase/spark-alarm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NetEase%2Fspark-alarm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NetEase%2Fspark-alarm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NetEase%2Fspark-alarm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NetEase%2Fspark-alarm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NetEase","download_url":"https://codeload.github.com/NetEase/spark-alarm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NetEase%2Fspark-alarm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267858224,"owners_count":24155917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alert","monitoring","monitoring-tool","scala","spark"],"created_at":"2024-11-16T05:18:01.435Z","updated_at":"2025-07-30T11:10:45.203Z","avatar_url":"https://github.com/NetEase.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spark-Alarm  [![Build Status](https://travis-ci.com/yaooqinn/spark-alarm.svg?branch=master)](https://travis-ci.com/yaooqinn/spark-alarm)[![HitCount](http://hits.dwyl.io/yaooqinn/spark-alarm.svg)](http://hits.dwyl.io/yaooqinn/spark-alarm)\n\n\n## 项目简介\n\n提供一些基本的报警手段，并可以通过SparkListener实现对Spark内部执行逻辑进行监控报警\n\n| 报警模式 | 使用限制 | 简介 |\n| ------ | ------ | ------ |\n| 邮件 | 通用，无限制 | 通过 SMTP 协议发送告警 |\n| 哨兵 | 网易内部使用 | 通过 HTTP 协议发送告警|\n| Smilodon | 网易内部使用 | 通过 HTTP 协议发送告警 |\n\n## 使用方法\n\n### 编译\n\n```bash\n# 克隆本项目\ngit https://github.com/yaooqinn/spark-alarm.git\n# cd spark-alarm\n# mvn clean package\n```\n\n可以得到内置示例项目jar包：`streaming-alarmer/target/streaming-alarmer-1.0-SNAPSHOT.jar`，该构件实现了对Streaming程序\"异常退出\"和\"\"任务堆积\"等相关关键事件进行简单的告警服务\n\n## 配置\n\n配置工作分为三个过程：     \n- 配置报警方式相关参数     \n- 配置报警规则参数     \n- 配置spark.extraListeners   \n所有的参数都完全等价Spark内置的各项参数，可以通过代码/--conf/spark-default.conf等方式加入\n\n### 配置邮件报警\n\n| 配置 | 默认值 | 说明 |\n| ------ | ------ | ------ |\n| spark.alarm.email.smtp.host | \u003c空值\u003e | 发信邮件服务器的地址, 比如 smtp-mail.outlook.com |\n| spark.alarm.email.smtp.port | 465(ssl)/25(no ssl) | 发信邮件服务器的端口， 587|\n| spark.alarm.email.username | \u003c空值\u003e | 发信邮箱的用户名 |\n| spark.alarm.email.password | \u003c空值\u003e | 发信邮箱的密码 |\n| spark.alarm.email.ssl.on.connect | false | 是否ssl加密连接 |\n| spark.alarm.email.from | \u003c空值\u003e | 发信邮箱 |\n| spark.alarm.email.to | \u003c空值\u003e | 收信邮箱列表，用逗号分隔 |\n\n参见: https://github.com/yaooqinn/spark-alarm/blob/master/alarm-email/src/test/scala/com/netease/spark/alarm/email/EmailAlarmistTest.scala\n\n### 配置哨兵报警\n\n| 配置 | 默认值 | 说明 |\n| ------ | ------ | ------ |\n| spark.alarm.sentry.url | \u003c空值\u003e | 哨兵服务地址 |\n| spark.alarm.sentry.api.type | Stone | 哨兵服务通知到的终端类型 /** 泡泡 */ POPO, /** 易信 */YiXin, /** 短信 */ SMS, /** 语音 */ Voice, Stone, /** 邮件 */ Email|\n| spark.alarm.sentry.app.name | \u003c空值\u003e | 哨兵服务的应用名称，若没有可以去哨兵官网添加 |\n| spark.alarm.sentry.app.secret | \u003c空值\u003e | 哨兵服务应用对应的密钥 |\n| spark.alarm.sentry.to | \u003c空值\u003e | 收信邮箱、或者ID、电话列表，用逗号分隔，根据具体的终端类型决定 |\n\n参见: alarm-sentry/src/test/scala/com/netease/spark/alarm/sentry/SentryAlarmistTest.scala\n\n### 配置Smilodon报警\n\n| 配置 | 默认值 | 说明 |\n| ------ | ------ | ------ |\n| spark.alarm.smilodon.url | http://10.165.139.76:8765/v1/alerts | Smilodon服务地址 |\n| spark.alarm.smilodon.channels | POPO,STONE | 通知中心终端类型，目前只支持|\n| spark.alarm.smilodon.users | \u003c空值\u003e | 收信者的邮箱账号列表，逗号分隔 |\n| spark.alarm.smilodon.groups | \u003c空值\u003e | 暂时不用管 |\n\n参见: alarm-smilodon/src/test/scala/com/netease/spark/alarm/smilodon/SmilodonAlarmistTest.scala\n\n注意：Smilodon服务有白名单控制，所以需要用户Spark作业的Driver进程所在的服务器在该列表中，对于Cluster模式则需要所有的节点（如NodeManager）在该列表中\n\n### 配置报警规则参数\n\n该参数列表适用于本项目内置示例项目streaming-alarmer的报警规则，用户可以自己定义相关的SparkListener来定制报警器\n\n| 配置 | 默认值 | 说明 |\n| ------ | ------ | ------ |\n| spark.alarm.streaming.application.force.exit | false | 出现Application级别错误的时候，是否直接exit |\n| spark.alarm.streaming.batch.error.enable | true | 是否对Batch出错的信息进行告警 |\n| spark.alarm.streaming.job.error.enable | false | 是否对job出错的信息进行告警 |\n| spark.alarm.streaming.batch.delay.ratio | 1 | Schedule delay时间 / Processing 时间的比值，大于该值，则作为判定为需要告警的必要条件之一  |\n| spark.alarm.streaming.batch.process.time.threshold | 1s | 处理时间的阈值，实际处理时间大于该值的批次，才进行报警 |\n\n参见：streaming-alarmer/src/test/scala/com/netease/spark/alarm/alarmer/streaming/EmailStreamingAlarmListenerTest.scala\n\n\n### 配置spark.extraListeners\n\n开启邮件报警，也可以设置其他实现，或者多个逗号分隔的报警实现，以及自己拓展的实现\n```scala\nspark.extraListeners=com.netease.spark.alarm.alarmer.streaming.EmailStreamingAlarmListener\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetease%2Fspark-alarm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetease%2Fspark-alarm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetease%2Fspark-alarm/lists"}