Skip to content

Platform information in gitpod telemetry #10766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
Pothulapati opened this issue Jun 20, 2022 · 0 comments · Fixed by #10925
Closed

Platform information in gitpod telemetry #10766

Pothulapati opened this issue Jun 20, 2022 · 0 comments · Fixed by #10925

Comments

@Pothulapati
Copy link
Contributor

Is your feature request related to a problem? Please describe

Now that we have basic Telemetry of a Gitpod instance, It would be really useful to understand
the environment in which the cluster is running to service the users better i.e writing better
docs, integrations, etc.

The platform/distribution is one such important data to understand where the users
are. The values could be gke, aks, eks, etc.

This also relates to #9075, so that we have a way
to separate the preview install's telemetry from others.

Describe the behaviour you'd like

Add a new platform attribute to the Gitpod telemetry. The identification can be
performed by using Replicated's distribution static function

To also accomodate the preview value, We can instead make this as a specific option
in config.go, and pass the right value during the render phase

Describe alternatives you've considered

Additional context

Discussion thread in slack https://gitpod.slack.com/archives/C01KLC56NP7/p1655726762212639
Pothulapati added a commit that referenced this issue Jun 27, 2022
@Pothulapati
[telemetry] Add new GITPOD_INSTALLATION_PLATFORM telemetry variable
88ce9d6 
Fixes #10766

This PR adds a new `GITPOD_INSTALLATION_PLATFORM` env variable, that
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 <tarun@gitpod.io>
@Pothulapati Pothulapati mentioned this issue Jun 27, 2022
Merged
1 task
Pothulapati added a commit that referenced this issue Jun 27, 2022
@Pothulapati
[telemetry] Add new GITPOD_INSTALLATION_PLATFORM telemetry variable
4f7a090 
Fixes #10766

This PR adds a new `GITPOD_INSTALLATION_PLATFORM` env variable, that
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 <tarun@gitpod.io>
Pothulapati added a commit that referenced this issue Jun 27, 2022
@Pothulapati
[telemetry] Add new GITPOD_INSTALLATION_PLATFORM telemetry variable
35e871b 
Fixes #10766

This PR adds a new `GITPOD_INSTALLATION_PLATFORM` env variable, that
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 <tarun@gitpod.io>
Pothulapati added a commit that referenced this issue Jun 30, 2022
@Pothulapati
[telemetry] Add new GITPOD_INSTALLATION_PLATFORM telemetry variable
681033a 
Fixes #10766

This PR adds a new `GITPOD_INSTALLATION_PLATFORM` env variable, that
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 <tarun@gitpod.io>
Pothulapati added a commit that referenced this issue Jul 1, 2022
@Pothulapati
[telemetry] Add new telemetry.data config option for telemetry
66bd0f1 
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 <tarun@gitpod.io>
Pothulapati added a commit that referenced this issue Jul 1, 2022
@Pothulapati
[telemetry] Add new telemetry.data config option for telemetry
2f7eaa8 
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 <tarun@gitpod.io>
Repository owner moved this from 🧊Backlog to ✨Done in 🚚 Security, Infrastructure, and Delivery Team (SID) Jul 1, 2022
default102 pushed a commit to cmcc-ict/gitpod that referenced this issue Jul 1, 2022
@Pothulapati @roboquat
[telemetry] Add new telemetry.data config option for telemetry
c96adbe 
Fixes gitpod-io#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 <tarun@gitpod.io>
@Pothulapati Pothulapati mentioned this issue Jul 4, 2022
Closed
Pothulapati added a commit that referenced this issue Jul 8, 2022
@Pothulapati
[telemetry] Add new telemetry.data config option for telemetry
4076bb2 
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 <tarun@gitpod.io>
mrsimonemms pushed a commit that referenced this issue Jul 15, 2022
@Pothulapati
[telemetry] Add new telemetry.data config option for telemetry
74d4bea 
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 <tarun@gitpod.io>
flaming-codes pushed a commit to flaming-codes/gitpod that referenced this issue Aug 1, 2022
@Pothulapati @flaming-codes
[telemetry] Add new telemetry.data config option for telemetry
3c5cfad 
Fixes gitpod-io#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 <tarun@gitpod.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
No open projects
🚚 Security, Infrastructure, and Delivery Team (SID)
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[telemetry] Add new telemetry.data config option for telemetry gitpod-io/gitpod
1 participant
@Pothulapati