Grafana OnCall开源指南
Grafana OnCall开发者事件反应的工具用于Grafana开源和Grafana云用户。相同的OSS版本Grafana OnCall提供了可靠的待命管理解决方案以及自我管理环境的灵活性。
本指南描述了必要的安装和配置步骤需要配置OSS Grafana OnCall。
安装Grafana OnCall OSS
有三个Grafana OnCall OSS环境:
- 爱好操场环境为当地的用法:README.md
- 发展环境因素:发展README.md
- 生产可靠的云环境使用舵安装:生产环境
生产环境
我们建议使用我们的官员执掌的可靠的生产部署图Grafana OnCall。它将部署Grafana OnCall引擎和芹菜工人,连同RabbitMQ集群,复述,集群和数据库。
注意:的Grafana OnCall引擎目前支持的一个实例Grafana OnCall插件。
检查执掌图表为更多的细节。
我们永远是幸福和生产部署提供援助我们的社区!
更新Grafana OnCall OSS
更新的OSS安装Grafana OnCall,请参阅更新文档:
松弛的设置
缺口集成Grafana OnCall利用松弛API特性提供一个可定制的和有用的集成。参考以下步骤配置松弛集成:
确保你Grafana OnCall环境是启动和运行
集
FEATURE_SLACK_INTEGRATION_ENABLED
是真实的Grafana OnCall必须通过HTTPS来访问。发展的目的,使用localtunnel。用于生产目的,考虑建立一个适当的web服务器和HTTPS终止。localtunnel,参考以下配置:
#选择独特的前缀,而不是漂亮-土耳其- 83 # Localtunnel将生成一个url,如https://pretty -土耳其- 83.轨迹。lt #它下面称为< ONCALL_ENGINE_PUBLIC_URL > lt - 8080端口- s -土耳其- 83——print-requests
如果使用localtunnel,打开你的外部URL并单击继续允许绕过警告页面的请求。
创建一个松弛的工作区的发展,或者使用你的公司的工作空间。
去https://api.slack.com/apps并点击创建一个应用程序。
选择
从一个应用程序清单
选项,并选择您的工作区。用以下代码替换文本YAML代码块。一定要更换
< YOUR_BOT_NAME >
和< ONCALL_ENGINE_PUBLIC_URL >
与适当的字段信息。
_metadata: major_version: 1 minor_version: 1 display_information:名称:< YOUR_BOT_NAME >特点:app_home: home_tab_enabled:假messages_tab_enabled:真正的messages_tab_read_only_enabled:假bot_user: display_name: < YOUR_BOT_NAME > always_online:真正的捷径:-名称:增加分辨率注意类型:消息callback_id: add_resolution_note描述:添加这个消息解析注意slash_commands: -命令:/ oncall url: < ONCALL_ENGINE_PUBLIC_URL > /松弛/ interactive_api_endpoint /描述:创建一个手动警报组should_escape:假-命令:/升级url: < ONCALL_ENGINE_PUBLIC_URL > /松弛/ interactive_api_endpoint /描述:直接页面用户(s)或安排(s) should_escape:假oauth_config: redirect_urls: - < ONCALL_ENGINE_PUBLIC_URL > / api /内部/ v1 /完成/ slack-install-free——< ONCALL_ENGINE_PUBLIC_URL > / api /内部/ v1 /完成/ slack-login /范围:用户:-渠道:读-聊天:写-识别用户。简介:读机器人:- app_mentions:阅读-渠道:历史-渠道:阅读-聊天:写-聊天:写。自定义聊天:写作。公共-命令文件:写——组:历史——组:阅读- im:历史- im:阅读- im:写- mpim:历史- mpim:阅读- mpim:写-反应:写——团队:阅读-用户组:读-用户组:写——用户。简介:读——用户:读取-用户:阅读。电子邮件——用户:写设置:event_subscriptions: request_url: < ONCALL_ENGINE_PUBLIC_URL > /马/ event_api_endpoint / bot_events: - app_home_opened app_mention channel_archive - channel_created channel_deleted channel_rename - channel_unarchive member_joined_channel消息。渠道——消息。im - subteam_created subteam_members_changed - subteam_updated user_profile_changed交互性:is_enabled:真正的request_url: < ONCALL_ENGINE_PUBLIC_URL > /马/ interactive_api_endpoint / org_deploy_enabled:假socket_mode_enabled:假
设置环境变量通过导航到Grafana OnCall,然后单击Env变量并设置如下:
SLACK_CLIENT_OAUTH_ID =基本信息- >应用程序- >客户端凭证ID SLACK_CLIENT_OAUTH_SECRET =基本信息- >应用程序- >客户端凭证秘密SLACK_SIGNING_SECRET =基本信息- >应用凭证- >签署秘密SLACK_INSTALL_RETURN_REDIRECT_HOST = < < OnCall外部URL > >
在OnCall,导航到ChatOps,选择并单击安装松弛集成。
配置附加的松弛设置。
电报的设置
电报集成Grafana OnCall是专为协作的团队合作,提高事件反应。参考以下步骤配置电报集成:
- 确保你Grafana OnCall环境是启动和运行。
- 集
FEATURE_TELEGRAM_INTEGRATION_ENABLED
“真正的” - 创建一个电报机器人使用BotFather并保存BotFather提供的令牌。请确保禁用群体隐私机器人(机器人设置- >集团隐私- >关闭)。
- 粘贴BotFather到提供的令牌
TELEGRAM_TOKEN
变量的Env变量你的页面Grafana OnCall实例。 - 设置
TELEGRAM_WEBHOOK_HOST
变量的外部地址Grafana OnCall实例。请注意,TELEGRAM_WEBHOOK_HOST
必须从https://
并公开可用的(这意味着它可以通过电报服务器)。如果您的主机是私人或地方,考虑使用反向代理(如。ngrok)。 - 现在你可以连接电报账户用户页面和接收警报组电报直接消息。或者,如果您想电报通道连接到Grafana OnCall环境中,导航到ChatOps选项卡。
Grafana OSS-Cloud设置
连接到Grafana云的好处包括:
- 云OnCall监测OSS OnCall使用心跳正常运行时间
- 短信用户通知
- 用户的电话通知。
连接到Grafana云,请参考云页面在OSS Grafana OnCall实例。
支持手机供应商
为什么Twilio
Grafana OnCall支持为什么Twilio的短信和电话通知交货。如果你喜欢使用为什么Twilio配置短信和电话通知,请完成以下步骤:
- 集
GRAFANA_CLOUD_NOTIFICATIONS_ENABLED
作为假确保Grafana OSS < - >云连接器是禁用的。 - 从你的OnCall环境,选择Env变量和配置所有的变量开始
TWILIO_
。
Zvonok.com
Grafana OnCall支持Zvonok.com电话通知交货。使用Zvonok.com配置电话通知,请完成以下步骤:
- 改变
PHONE_PROVIDER
价值zvonok
。 - 创建一个公共API键在概要文件- >设置页面,并分配其价值
ZVONOK_API_KEY
。 - 创建活动和分配它的ID值
ZVONOK_CAMPAIGN_ID
。 - 如果你计划使用预先录制好的声音而不是语音合成器,你可以复制的ID音频剪辑到变量
ZVONOK_AUDIO_ID
(可选步骤)。 - 打电话与特定的声音,你可以设置
ZVONOK_SPEAKER_ID
。默认情况下,使用的IDSalli
(可选步骤)。 - 过程调用状态,需要添加一个回发的GET / POST方法的zvonok.com服务使用以下格式(可选步骤):
$ {ONCALL_BASE_URL} / zvonok / call_status_events ? campaign_id = {ct_campaign_id} &call_id = {ct_call_id} &地位= {ct_status} &user_choice = {ct_user_choice}
传输参数的名称可以通过环境变量定义:
ZVONOK_POSTBACK_CALL_ID
——调用id (ct_call_id)查询参数名称ZVONOK_POSTBACK_CAMPAIGN_ID
——公司id (ct_campaign_id)查询参数名称ZVONOK_POSTBACK_STATUS
-状态(ct_status)查询参数名称ZVONOK_POSTBACK_USER_CHOICE
——用户的选择(ct_user_choice)查询参数名称ZVONOK_POSTBACK_USER_CHOICE_ACK
——用户的选择(ct_user_choice)为承认警戒组查询参数值
电子邮件设置
Grafana OnCall能够使用SMTP发送邮件通知用户一步。设置电子邮件通知,以下env变量填充您的SMTP服务器凭证:
EMAIL_HOST
——SMTP服务器主机EMAIL_HOST_USER
——SMTP服务器用户EMAIL_HOST_PASSWORD
——SMTP服务器密码EMAIL_PORT
(默认是587年
)——SMTP服务器端口EMAIL_USE_TLS
(默认是真正的
启用/禁用TLS)EMAIL_FROM_ADDRESS
(可选)——电子邮件地址用于发送电子邮件。如果不指定,EMAIL_HOST_USER
就会被使用。
启用电子邮件集成后,它将可以使用通过电子邮件通知
通知用户设置。
入站电子邮件设置
Grafana OnCall能够创建警报组入站电子邮件集成。
配置入站电子邮件集成Grafana OnCall OSS env变量填充你的电子邮件服务提供者数据:
INBOUND_EMAIL_ESP
——入站电子邮件ESP的名字。可用的选项:amazon_ses
,mailgun
,mailjet
,山魈
,邮政
,邮戳
,sendgrid
,sparkpost
INBOUND_EMAIL_DOMAIN
——入站电子邮件域INBOUND_EMAIL_WEBHOOK_SECRET
——入站电子邮件webhook秘密
您还需要配置您的ESP将消息转发到以下网址:< ONCALL_ENGINE_PUBLIC_URL > /集成/ v1 / inbound_email_webhook
。
限制
默认情况下,Grafana OnCall限制电子邮件和电话通知(电话、短信)到200每天每个用户。限制使用env可以改变变量:
PHONE_NOTIFICATIONS_LIMIT
(默认是200年
)-电话通知每个用户EMAIL_NOTIFICATIONS_LIMIT
(默认是200年
)- - -每个用户的电子邮件
移动应用程序设置
请注意:这个应用程序目前处于测试阶段
Grafana OnCall OSS用户可以使用手机应用程序来接收从OnCall推送通知。Grafana OnCall OSS依赖Grafana云推送通知的继电器。你必须首先连接Grafana OnCall OSS Grafana云的移动应用程序工作。
指Grafana OSS-Cloud设置本文在继续之前的手机应用程序。
为Grafana OnCall OSS,移动应用二维码包含一个身份验证标记以及后端URL。你Grafana OnCall OSS实例应该从同一个网络可以作为你的移动设备,从互联网上最好。
有关更多信息,请参见Grafana OnCall移动应用
警戒组升级审计师
Grafana OnCall有周期性的后台任务,检查所有警报组正常升级完成。这个功能,如果配置,也可以平安OnCall Webhook集成心跳的URL,这样你可以提醒,如果出现错误。
日志源自芹菜工人的apps.alerts.tasks.check_escalation_finished.check_escalation_finished_task
任务,引用一个AlertGroupEscalationPolicyExecutionAuditException
异常表明审计师周期性任务失败检查(s)在一个或多个警报组。日志提到的这个任务. .通过审计检查
表明没有问题的升级审计预警组。
配置这个特性是这样的:
- 创建一个Webhook或格式化Webhook集成类型。
- “心跳”标签下的集成模式,显示了独特的心跳URL复制。
- 设置hearbeat的预期时间间隔15分钟(请参见下面的note有关
ALERT_GROUP_ESCALATION_AUDITOR_CELERY_TASK_HEARTBEAT_INTERVAL
) - 根据需要配置集成升级链
- 填充下面的env变量:
ALERT_GROUP_ESCALATION_AUDITOR_CELERY_TASK_HEARTBEAT_URL
——集成独特的心跳URLALERT_GROUP_ESCALATION_AUDITOR_CELERY_TASK_HEARTBEAT_INTERVAL
——审计任务应该运行多久。默认任务每13分钟运行一次我们因此建议心跳的时间间隔设置为15分钟。如果你想修改这个,我们建议配置这个env变量1或2分钟不到的值集集成心跳的时间间隔。
此外,如果你喜欢禁用此功能,您可以设置ESCALATION_AUDITOR_ENABLED
环境变量来假
。