KKMonitor

`v0.10.x` 迁移指南

自托管 KMonitor v0.10.x 的迁移指南。添加 Google OAuth 客户端密钥、专用摄取端点和配置迁移。

仅当您的电量低于v0.10.0并升级到v0.10.x.

本文档中提到的步骤将导致停机。

升级到时请按照以下步骤操作0.10.x。涉及一些停机时间。在停机期间,SDK 将收到503 Service Unavailable发送会话时。升级完成后,摄取应该会正常恢复。 SDK 将自动重试发送未发送的会话。

1. 关闭所有 KMonitor 服务

通过 SSH 连接到托管 KMonitor 的虚拟机。

cd ~/measure/self-host
sudo docker compose -f compose.yml -f compose.prod.yml --profile init --profile migrate down --remove-orphans

2. 执行升级

访问发布页面捕获匹配的最新标签v[MAJOR].[MINOR].[PATCH]格式。例如,v0.10.0.

cd ~/measure
git reset --hard # only applies if you have local modifications
git fetch --tags
# replace <git-tag> with the chosen tag. example: v0.10.0
git checkout <git-tag>

3. 创建 Google OAuth 客户端密钥

如果您只使用的话请跳过此步骤GitHub登入。

开始于v0.10.x, Google 登录使用服务器端代码流,需要OAUTH_GOOGLE_SECRET环境变量。以前,只有客户端 ID (OAUTH_GOOGLE_KEY)是需要的。

  1. 前往Google Cloud 控制台> API 和服务 > 凭证

  2. 单击您现有的 OAuth 2.0 客户端 ID,创建一个新的客户秘密并复制它。 (如果您出于安全原因想要禁用现有的客户端密钥,并确保它不会在 KMonitor 之外的任何其他地方使用,您可以这样做。)

  3. 编辑self-host/.env并添加:

    OAUTH_GOOGLE_SECRET=your-google-client-secret  # change this

4. 设置摄取端点

为新的摄取端点设置新的 DNS A 记录,例如:https://measure-ingest.yourcompany.com指向您的虚拟机的 IP。此步骤是新步骤,建议这样做以确保最佳的摄取性能。确保将此端点也更新为API_URL在您的应用程序中。此更改之前的所有应用程序版本也将继续摄取。

5. 迁移配置

cd ~/measure/self-host
sudo ./config.sh --production --ensure

系统将提示您输入在上述步骤 4 中创建的摄取端点。

6.启动KMonitor服务

sudo ./install.sh

7.运行数据回填脚本

执行此步骤即可完成迁移。在运行这些脚本之前,KMonitor 仪表板将无法正常工作。

sudo ./migrations/v0.10.x-data-backfills-1.sh
sudo ./migrations/v0.10.x-data-backfills-2.sh
sudo ./migrations/v0.10.x-read-optim.sh