docs(telemetry): actualize telemetry docs

Signed-off-by: Timofey Kirillov <timofey.kirillov@flant.com>
werf · Aug 4, 2022 · 3010971 · 3010971
1 parent 379268b
commit 3010971
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/docs/pages_en/internals/telemetry.md b/docs/pages_en/internals/telemetry.md
@@ -22,7 +22,9 @@ Below are examples of the data werf transmits:
   "attributes": {
     "arch": "amd64",
     "os": "linux",
-    "version": "dev"
+    "version": "dev",
+    "CI": true,
+    "ciName": "gitlab"
   },
   "eventType": "CommandStarted",
   "eventData": {
@@ -48,7 +50,9 @@ Below are examples of the data werf transmits:
   "attributes": {
     "arch": "amd64",
     "os": "linux",
-    "version": "dev"
+    "version": "dev",
+    "ci": true,
+    "ciName": "gitlab"
   },
   "eventType": "CommandExited",
   "eventData": {
@@ -69,7 +73,9 @@ In the examples above, the following usage data is sent:
   * `os`;
   * `arch`;
   * `trdl group-channel`;
-  * `werf version`.
+  * `werf version`;
+  * `ci` — whether CI-system is used;
+  * `ciName` — detected name of CI/CD system (gitlab, github-actions, etc.).
 * `eventType` — type of event:
   * `CommandStarted`;
   * `CommandExited`;

diff --git a/docs/pages_ru/internals/telemetry.md b/docs/pages_ru/internals/telemetry.md
@@ -22,7 +22,9 @@ permalink: internals/telemetry.html
   "attributes": {
     "arch": "amd64",
     "os": "linux",
-    "version": "dev"
+    "version": "dev",
+    "ci": true,
+    "ciName": "gitlab"
   },
   "eventType": "CommandStarted",
   "eventData": {
@@ -48,7 +50,9 @@ permalink: internals/telemetry.html
   "attributes": {
     "arch": "amd64",
     "os": "linux",
-    "version": "dev"
+    "version": "dev",
+    "ci": true,
+    "ciName": "gitlab"
   },
   "eventType": "CommandExited",
   "eventData": {
@@ -70,6 +74,8 @@ permalink: internals/telemetry.html
   * `arch`;
   * `trdl group-channel`;
   * `werf version`.
+  * `ci` — используется ли CI/CD система;
+  * `ciName` — имя используемой CI/CD системы (gitlab, github-actions, и т.п.).
 * `eventType` — тип события:
   * `CommandStarted`;
   * `CommandExited`;

diff --git a/pkg/telemetry/telemetrywerfio.go b/pkg/telemetry/telemetrywerfio.go
@@ -136,7 +136,7 @@ func (t *TelemetryWerfIO) getAttributes() map[string]interface{} {
 
 	{
 		if isCI := util.GetBoolEnvironmentDefaultFalse("CI"); isCI {
-			attributes["CI"] = true
+			attributes["ci"] = true
 		}
 		if isGitlabCI := util.GetBoolEnvironmentDefaultFalse("GITLAB_CI"); isGitlabCI {
 			attributes["ciName"] = "gitlab"