silinternational / app-deployment-tracker-ga
此软件包已被弃用且不再维护。未建议替代包。
简单的脚本来将 Docker 镜像用作从 CI/CD 环境跟踪应用部署的 Google Analytics
1.0.3
2023-02-08 15:21 UTC
Requires
This package is auto-updated.
Last update: 2024-02-08 17:30:04 UTC
README
此脚本使用 Google Analytics 来跟踪部署事件。应在部署成功后添加对此脚本的调用到您的部署管道中。
由于它使用 Google Analytics,因此某些参数的名称可能对这种使用不太直观。所有使用的参数都在此处文档化。
GA 参数
GA 参数 | 环境变量名 | 必需 | 默认值 | 描述 |
---|---|---|---|---|
跟踪 ID | TRACKING_ID | true | none | GA 属性跟踪 ID,UA-xxxxxx |
用户 ID | USER_ID | false | none | 项目或仓库名称,例如:silinternational/app-deployment-tracker-ga |
USER_ID_VALUE_ENV_VAR | false | CI_REPO_NAME | 如果您想从另一个环境变量中获取数据源,请在此处指定环境变量名称。例如 CI_NAME |
|
数据源 | DATA_SOURCE | false | script | 事件来源的名称,例如:脚本、codeship 等。 |
DATA_SOURCE_VALUE_ENV_VAR | false | CI_NAME | 如果您想从另一个环境变量中获取数据源,请在此处指定环境变量名称。例如 CI_NAME |
|
事件类别 | EVENT_CATEGORY | false | app-deployment | 事件类别的名称 |
事件动作 | EVENT_ACTION | false | master | 事件动作,默认为 "master" 用于 master 分支的部署 |
EVENT_ACTION_VALUE_ENV_VAR | false | CI_BRANCH | 如果您想从另一个环境变量中获取事件动作,请在此处指定环境变量名称。例如 CI_BRANCH |
|
事件标签 | EVENT_LABEL | false | USER_ID | 已部署项目的友好名称,如果没有提供,则使用 USER_ID 的值 |
文档标题 | DOCUMENT_TITLE | false | USER_ID | 已部署项目的友好名称,如果没有提供,则使用 USER_ID 的值 |
一开始可能有些困惑,但我们使用上面带有 _VALUE_ENV_VAR
后缀的环境变量,以便我们可以从 CI 环境动态加载值。如果您想指定自己的值,您应将 _VALUE_ENV_VAR
环境变量设置为另一个包含您提供的值的 env 变量的名称。
例如,如果您想将 数据源
设置为 "my own source name",您应设置以下环境变量
DATA_SOURCE_VALUE_ENV_VAR=DATA_SOURCE
DATA_SOURCE=my own source name
参考
- 用于向 Google 发送测量事件的 PHP 库: theiconic/php-ga-measurement-protocol
- 可以与测量一起发送的属性列表: https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
许可 - MIT
MIT 许可证
版权所有 (c) 2017 SIL 国际
在此,特此许可,免费向任何获得此软件及其相关文档文件("软件")副本的个人授予在此软件上不受限制的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利,并允许向提供软件的个人提供上述权利,前提是遵守以下条件
上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。
软件按“现状”提供,不提供任何形式的保证,无论是明示的、暗示的,还是关于适销性、特定用途适用性或非侵权的保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任负责,无论该责任是基于合同、侵权或其他原因,以及该软件的产生、存在或与该软件的使用或其他方式有关。