rungutancommunity/sentry-snuba

Sentry性能监控镜像

本文参考来源：Rungutan博客

镜像概述和主要用途

本镜像为Snuba Sentry自定义镜像，基于Sentry性能监控平台构建，支持根据实际需求进行额外变更和定制化配置。Sentry是一款实时错误监控和性能追踪工具，可帮助开发团队定位应用崩溃、性能瓶颈，并结合用户体验数据优化应用表现。本镜像特别适用于需要在自有基础设施上部署、管理和扩展Sentry的企业或团队，尤其推荐使用Amazon Web Services (AWS)作为云服务提供商的用户。

核心功能和特性

性能监控基础

性能监控是通过定期验证和跟踪数字平台的运行状况和一致性，使用仪表板和告警系统等工具，通过关键性能指标(KPI)监控性能变化并采取行动。对于云应用，由于其高度分布式特性，需要专门工具追踪网络和应用间的流量，以理解应用性能，这属于应用性能监控(APM)范畴，可测量用户 latency、网络瓶颈等。

Sentry核心功能

• 实时错误监控：帮助实时监控和修复应用崩溃。
• 性能追踪：将慢加载页面追溯到API调用及相关错误，助力解决性能瓶颈。
• Web Vitals：通过Google Web Vitals收集真实用户数据（网络速度、浏览器、设备、地区等），了解错误对用户体验的影响。
• 调用链追踪：将性能不佳的页面不仅追溯到API调用，还可追踪到子调用，通过瀑布图可视化用户完整体验。
• 事务监控：按持续时间、相关问题或用户数量查看事务，结合发布标记，评估新代码对用户的影响。

使用场景和适用范围

• 开发团队：实时监控应用错误和性能，快速定位并修复问题。
• 运维团队：监控生产环境系统健康状态，确保服务稳定运行。
• 企业级部署：需要在自有基础设施上部署Sentry，满足数据隐私和定制化需求。
• AWS用户：通过基于AWS服务的可扩展架构，实现Sentry的高可用和易维护部署。

详细使用方法和配置说明

部署方式

Sentry提供开源版本和SaaS云服务。对于选择自建的用户，社区贡献了多种部署方式：

1. Docker Compose部署

参考Sentry官方GitHub仓库：https://github.com/sentry/onpremise

2. Helm Chart部署

社区构建的Helm包：https://github.com/sentry-kubernetes/charts

3. AWS云服务部署（推荐）

针对AWS用户，提供基于以下AWS服务的可扩展、易维护、安全的基础设施：

• AWS ECS Fargate
• AWS RDS
• AWS ElastiCache
• AWS MSK (Kafka)
• AWS OpsWorks
• AWS VPC
• AWS CloudWatch

部署架构图：

部署步骤：

1. 通过以下链接在CloudFormation中创建堆栈：
   [***]

2. 至少填写以下参数并点击"创建堆栈"：

   • SentrySystemSecretKey：随机UUIDv4，可从UUID生成器获取
   • InitialAdminUserEmail：初始管理员***
   • InitialAdminUserPassword：初始管理员强密码
   • SslLoadBalancer：启用HTTPS（Sentry必需）
   • SentryEmailUsername：推荐使用SES，从SES SMTP设置获取
   • SentryEmailPassword：同上
   • SentryEmailHost：SES端点，格式为email-smtp.${aws_region}.amazonaws.com
   • SentryEmailFrom：SES已验证的***或域名，从SES已验证发件人获取

注意：建议部署完成后创建新管理员并删除初始管理员。

集成

Rungutan集成

在CI/CD pipeline中集成Rungutan负载测试，结合Sentry指标告警：

GitHub Actions示例：

yaml
name: Load test with Rungutan

on:
  release:
    types:
      - created

jobs:
  load:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Load test your platform with Rungutan
        uses: Rungutan/rungutan-actions@1.0.0
        env:
          RUNGUTAN_TEAM_ID: ${{ secrets.RUNGUTAN_TEAM_ID }}
          RUNGUTAN_API_KEY: ${{ secrets.RUNGUTAN_API_KEY }}
          RUNGUTAN_TEST_FILE: test_file.json
          RUNGUTAN_TEST_NAME: ${{ github.repository }}-${{ github.ref }}

Slack集成

Slack集成可设置告警接收频道，团队成员可分配问题或在发布中解决问题。

Slack应用配置步骤：

1. 访问Slack API，点击"Create New App"，命名（如"Sentry"）并选择工作区。
2. 进入"OAuth & Permissions"，添加重定向URL：https://${SentryDnsRecord}/extensions/slack/setup/。
3. 在"Bot Token Scopes"下启用：
   • incoming-webhook
   • links:read
   • links:write
4. 在"User Token Scopes"下启用：
   • links:read
   • links:write
5. 进入"Interactivity & Shortcuts"，启用并设置：
   • Request URL：https://${SentryDnsRecord}/extensions/slack/action/
   • Options Load URL：https://${SentryDnsRecord}/extensions/slack/options-load/
6. 进入"Event Subscriptions"，启用并设置Request URL：https://${SentryDnsRecord}/extensions/slack/event/。
7. 在"Subscribe to bot events"中添加link_shared事件。
8. 在"App unfurl domains"中添加Sentry DNS记录。
9. 返回"Basic Information"，点击"Install App"，记录以下信息（用于CloudFormation模板）：
   • Client ID
   • Client Secret
   • Signing Secret

Sentry配置步骤：

• 进入Sentry"Settings" → "Integrations" → "Slack" → "Add Workspace" → 点击"Allow"。

注意：需使用Slack管理员账户完成配置。

Sentry与Rungutan协同工作

Rungutan模拟高用户活动，Sentry定位大规模下的代码问题，二者结合实现：

• 捕获和观察用户平台活动
• 监控每次发布后的平台行为
• 快速定位性能瓶颈和代码问题

重要注意事项

Elastic IP限制

自版本https://github.com/Rungutan/sentry-performance-monitoring/releases/tag/1.4.0%E8%B5%B7%EF%BC%8CNAT%E7%BD%91%E5%85%B3%E6%94%AF%E6%8C%81%E9%AB%98%E5%8F%AF%E7%94%A8%EF%BC%8C%E9%9C%80%E7%A1%AE%E4%BF%9DVPC Elastic IP配额可支持额外3个。可在AWS服务配额查看"EC2-VPC Elastic IPs"的当前应用值。AWS通常自动批准从5到20的配额增加。

Client Ingest DSN记录

创建新项目时，Sentry生成的Client DSN格式为：

https://some_random_public_key_string_here@o1.ingest.${the_sentry_dns_record}/2

若SentryDnsRecord为sentry.rungutan.com，则DSN为：

https://some_random_public_key_string_here@o1.ingest.sentry.rungutan.com/2

需确保SSL证书支持该ingest域名。若无法使用默认ingest记录，可通过SentryRelayAlternativeDnsRecord参数指定替代域名，例如设置为sentry-relay.rungutan.com，则DSN为：

https://some_random_public_key_string_here@sentry-relay.rungutan.com/2

关键参数安全

务必为以下参数设置自定义值：

• SentrySystemSecretKey
• InitialAdminUserEmail
• InitialAdminUserPassword