[telemetry] Add new `telemetry.data` config option for telemetry #10925

Pothulapati · 2022-06-27T08:32:19Z

Description

This PR adds a new experimental.telemetry.data.platform config option
that is then passed to GITPOD_INSTALLATION_PLATFORM env variable, which
is then transmitted by the gitpod-telemetry job as the platform
property into our telemetry store. The value of this env variable
is then overrided by each install method.

This env can have the following values:

installer by default as when the installation is done directly
through the installer, We don't have enough information
about the environment.
One of the distribution values
when done through kots. This would have the distribution in which
Gitpod is being installed, and is dependent on kots.
local-preview when the installation is done through the new
preview install method.

As the changes show in the PR, each installation method overrides
the value.

Signed-off-by: Tarun Pothulapati [email protected]

Related Issue(s)

Fixes #10766

How to test

Check the gitpod-telemetry cronjob to have the new env, that is set
to the appropriate value based on the installation method

Release Notes

[telemetry] Add new telemetry.data config option for telemetry

Documentation

Werft options:

/werft with-preview

werft-gitpod-dev-com · 2022-06-27T08:32:35Z

started the job as gitpod-build-tar-preview-telemetry.1 because the annotations in the pull request description changed
(with .werft/ from main)

Pothulapati · 2022-06-27T10:49:51Z

/werft run

👍 started the job as gitpod-build-tar-preview-telemetry.3
(with .werft/ from main)

Pothulapati · 2022-06-27T11:21:42Z

/werft run

👍 started the job as gitpod-build-tar-preview-telemetry.6
(with .werft/ from main)

Pothulapati · 2022-06-27T11:59:00Z

/werft run

👍 started the job as gitpod-build-tar-preview-telemetry.7
(with .werft/ from main)

Pothulapati · 2022-06-29T10:16:26Z

/werft run publish-to-kots

👍 started the job as gitpod-build-tar-preview-telemetry.11
(with .werft/ from main)

Pothulapati · 2022-06-30T11:54:59Z

/werft run publish-to-kots

👍 started the job as gitpod-build-tar-preview-telemetry.13
(with .werft/ from main)

Pothulapati · 2022-06-30T12:04:15Z

/werft run publish-to-kots

👍 started the job as gitpod-build-tar-preview-telemetry.15
(with .werft/ from main)

Pothulapati · 2022-06-30T13:38:54Z

/hold

mrsimonemms

/hold

Looks fine. I've approved with a comment - your choice what you do with it

mrsimonemms · 2022-06-30T13:41:01Z

components/installation-telemetry/cmd/send.go

@@ -56,6 +56,11 @@ var sendCmd = &cobra.Command{
 			Set("totalWorkspaces", data.TotalWorkspaces).
 			Set("totalInstances", data.TotalInstances)

+		platform := os.Getenv("GITPOD_INSTALLATION_PLATFORM")
+		if platform != "" {
+			properties.Set("platform", platform)


Do we want to leave the platform as blank in the Segment data, or do we want something like unknown in there?

install/kots/manifests/gitpod-installer-job.yaml

install/installer/pkg/components/gitpod/cronjob.go

Pothulapati · 2022-07-01T07:35:14Z

/werft run publish-to-kots

👍 started the job as gitpod-build-tar-preview-telemetry.18
(with .werft/ from main)

Pothulapati · 2022-07-01T08:19:02Z

/werft run publish-to-kots

👍 started the job as gitpod-build-tar-preview-telemetry.23
(with .werft/ from main)

Pothulapati · 2022-07-01T08:47:36Z

Tested this on both local-preview and kots, and the values are set as expected

local-preview

Environment:
      GITPOD_INSTALLATION_VERSION:   tar-preview-telemetry.23
      GITPOD_INSTALLATION_PLATFORM:  local-preview
      SERVER_URL:                    http://server.default.svc.cluster.local:9000/
    Mounts:                          <none>

kots on a k3s cluster

    Environment:
      GITPOD_INSTALLATION_VERSION:   tar-preview-telemetry.23
      GITPOD_INSTALLATION_PLATFORM:  k3s
      SERVER_URL:                    http://server.gitpod.svc.cluster.local:9000
    Mounts:                          <none>
  Volumes:                           <none>

Also, Verified that our telemetry store is receving the new property as expected!

corneliusludmann

Looks good! 🚀 Thanks for taking my comments into consideration! 🧡

Fixes #10766 This PR adds a new `experimental.telemetry.data.platform` config option that is then passed to `GITPOD_INSTALLATION_PLATFORM` env variable, which is then transmitted by the `gitpod-telemetry` job as the `platform` property into our telemetry store. The value of this env variable is then overrided by each install method. This env can have the following values: - `installer` by default as when the installation is done directly through the installer, We don't have enough information about the environment. - [One of the `distribution` values](https://docs.replicated.com/reference/template-functions-static-context#distribution) when done through `kots`. This would have the distribution in which Gitpod is being installed, and is dependent on `kots`. - `local-preview` when the installation is done through the new preview install method. As the changes show in the PR, each installation method overrides the value. Signed-off-by: Tarun Pothulapati <[email protected]>

Pothulapati · 2022-07-01T09:18:35Z

/unhold

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/S labels Jun 27, 2022

Pothulapati force-pushed the tar/preview-telemetry branch from 88ce9d6 to 4f7a090 Compare June 27, 2022 10:33

Pothulapati force-pushed the tar/preview-telemetry branch from 4f7a090 to 35e871b Compare June 27, 2022 10:55

Pothulapati force-pushed the tar/preview-telemetry branch from 7ba7af9 to f1c2689 Compare June 29, 2022 08:21

Pothulapati force-pushed the tar/preview-telemetry branch from 3b9afb3 to 0182d4e Compare June 30, 2022 12:03

Pothulapati marked this pull request as ready for review June 30, 2022 13:36

Pothulapati requested a review from a team June 30, 2022 13:36

roboquat removed the do-not-merge/work-in-progress label Jun 30, 2022

Pothulapati requested a review from mrsimonemms June 30, 2022 13:36

github-actions bot added the team: delivery Issue belongs to the self-hosted team label Jun 30, 2022

roboquat added the do-not-merge/hold label Jun 30, 2022

mrsimonemms approved these changes Jun 30, 2022

View reviewed changes

corneliusludmann reviewed Jun 30, 2022

View reviewed changes

install/kots/manifests/gitpod-installer-job.yaml Outdated Show resolved Hide resolved

corneliusludmann reviewed Jun 30, 2022

View reviewed changes

install/installer/pkg/components/gitpod/cronjob.go Outdated Show resolved Hide resolved

roboquat added size/M and removed size/S labels Jul 1, 2022

Pothulapati force-pushed the tar/preview-telemetry branch from f308f63 to 34b991d Compare July 1, 2022 07:34

Pothulapati force-pushed the tar/preview-telemetry branch 2 times, most recently from 1fbebc6 to b9591f7 Compare July 1, 2022 07:48

Pothulapati force-pushed the tar/preview-telemetry branch 2 times, most recently from 669c002 to 1b4e129 Compare July 1, 2022 08:14

Pothulapati requested review from mrsimonemms and corneliusludmann July 1, 2022 08:47

Pothulapati changed the title ~~[telemetry] Add new GITPOD_INSTALLATION_PLATFORM telemetry variable~~ [telemetry] Add new data.platform config option for telemetry Jul 1, 2022

Pothulapati changed the title ~~[telemetry] Add new data.platform config option for telemetry~~ [telemetry] Add new telemetry.data config option for telemetry Jul 1, 2022

roboquat added release-note and removed do-not-merge/release-note-label-needed labels Jul 1, 2022

corneliusludmann approved these changes Jul 1, 2022

View reviewed changes

Pothulapati force-pushed the tar/preview-telemetry branch from 1b4e129 to 66bd0f1 Compare July 1, 2022 09:08

mrsimonemms approved these changes Jul 1, 2022

View reviewed changes

Pothulapati force-pushed the tar/preview-telemetry branch from 66bd0f1 to 2f7eaa8 Compare July 1, 2022 09:10

Pothulapati removed the do-not-merge/hold label Jul 1, 2022

roboquat merged commit c96adbe into main Jul 1, 2022

roboquat deleted the tar/preview-telemetry branch July 1, 2022 09:25

mrsimonemms mentioned this pull request Jul 18, 2022

Release/2022.06.1 - NOT TO BE MERGED #11411

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[telemetry] Add new `telemetry.data` config option for telemetry #10925

[telemetry] Add new `telemetry.data` config option for telemetry #10925

Pothulapati commented Jun 27, 2022 •

edited

Loading

werft-gitpod-dev-com bot commented Jun 27, 2022

Pothulapati commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 30, 2022

mrsimonemms left a comment

mrsimonemms Jun 30, 2022

Pothulapati commented Jul 1, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jul 1, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jul 1, 2022 •

edited

Loading

corneliusludmann left a comment

Pothulapati commented Jul 1, 2022

[telemetry] Add new telemetry.data config option for telemetry #10925

[telemetry] Add new telemetry.data config option for telemetry #10925

Conversation

Pothulapati commented Jun 27, 2022 • edited Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

Werft options:

werft-gitpod-dev-com bot commented Jun 27, 2022

Pothulapati commented Jun 27, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jun 27, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jun 27, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jun 29, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jun 30, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jun 30, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jun 30, 2022

mrsimonemms left a comment

Choose a reason for hiding this comment

mrsimonemms Jun 30, 2022

Choose a reason for hiding this comment

Pothulapati commented Jul 1, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jul 1, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati commented Jul 1, 2022 • edited Loading

corneliusludmann left a comment

Choose a reason for hiding this comment

Pothulapati commented Jul 1, 2022

[telemetry] Add new `telemetry.data` config option for telemetry #10925

[telemetry] Add new `telemetry.data` config option for telemetry #10925

Pothulapati commented Jun 27, 2022 •

edited

Loading

Pothulapati commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 27, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 29, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jun 30, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jul 1, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jul 1, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati commented Jul 1, 2022 •

edited

Loading