使用注释跟踪部署

编辑

使用注释跟踪部署编辑

Example view of transactions annotation in the APM app in Kibana

为了增强对部署的可见性,我们在所有事务图表上提供部署注释。此功能使您能够轻松确定部署是否增加了最终用户的响应时间,或者应用程序的内存/CPU 占用量是否发生了变化。能够快速识别错误部署使您能够回滚并修复问题,而不会导致代价高昂的停机。

默认情况下,自动部署注释处于启用状态。这意味着当应用程序的 service.version 发生更改时,APM 应用会在您的数据上创建注释。

或者,您可以使用我们的注释 API 显式创建部署注释。该 API 可以集成到您的 CI/CD 管道中,以便每次部署时,都会向注释 API 端点发送 POST 请求

curl -X POST \
  https://127.0.0.1:5601/api/apm/services/${SERVICE_NAME}/annotation \ 
-H 'Content-Type: application/json' \
-H 'kbn-xsrf: true' \
-H 'Authorization: Basic ${API_KEY}' \ 
-d '{
      "@timestamp": "${DEPLOY_TIME}", 
      "service": {
        "version": "${SERVICE_VERSION}" 
      },
      "message": "${MESSAGE}" 
    }'

应用程序的 service.name

具有足够权限的 APM 应用 API 密钥

部署时间

要在注释中显示的 service.version

要在注释中显示的自定义消息

有关更多信息,请参阅注释 API 参考。

如果已为所选时间段创建了自定义注释,则不会显示任何派生注释,即在 service.version 更改时自动创建的注释。