Skip to content
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.

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

[preview] run the telemetry job right after gitpod is ready #11077

Merged
merged 1 commit into from
Jul 5, 2022

Conversation

Pothulapati
Copy link
Contributor

@Pothulapati Pothulapati commented Jul 1, 2022

Description

This PR updates the entry-point.sh to run a parallel step
that waits for the gitpod pods to be ready, and manually executes
the cronjob once its necessary.

This is necessary as our telemetry cronjobs are only ran
daily in the midnight, and we can't expect this schedule to work
for local previews as they are short lived.

example data that we get:

client.Track(&analytics.Track{
  UserId: "334c379a-afee-4882-ba44-fbd7dfc0a8b0",
  Event: "Installation telemetry",
  Properties: map[string]interface{}{
    "customerID": "",
    "platform": "local-preview",
    "totalInstances": 0,
    "totalUsers": 0,
    "totalWorkspaces": 0,
    "version": "tar-preview-tel-init.4",
  },
})

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

Related Issue(s)

Fixes #11113

How to test

Check if there is a new job called gitpod-telemetry-init is created once
gitpod pods are ready.

Release Notes

[preview] run the telemetry job right after a Gitpod install is ready

Documentation

Werft options:

  • /werft with-preview

Copy link
Contributor

@corneliusludmann corneliusludmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added 2 minor comments.

/hold in case you want to change something. Otherwise, feel free to remove the hold.

install/preview/entrypoint.sh Show resolved Hide resolved
install/preview/entrypoint.sh Outdated Show resolved Hide resolved
This PR updates the `entry-point.sh` to run a parallel step
that waits for the gitpod pods to be ready, and manually executes
the cronjob once its necessary.

This is necessary as our telemetry `cronjobs` are only ran
daily in the midnight, and we can't expect this schedule to work
for local previews as they are short lived.

example data that we get:

```
client.Track(&analytics.Track{
  UserId: "334c379a-afee-4882-ba44-fbd7dfc0a8b0",
  Event: "Installation telemetry",
  Properties: map[string]interface{}{
    "customerID": "",
    "platform": "local-preview",
    "totalInstances": 0,
    "totalUsers": 0,
    "totalWorkspaces": 0,
    "version": "tar-preview-tel-init.4",
  },
})
```

Signed-off-by: Tarun Pothulapati <[email protected]>
@Pothulapati Pothulapati force-pushed the tar/preview-tel-init branch 5 times, most recently from 4213ad8 to 1661885 Compare July 5, 2022 07:32
@Pothulapati
Copy link
Contributor Author

Also, Ignore the added changes.
Those are now removed to limit this change to running the telemetry when Gitpod is ready, and only that. Exit telemetry will added in a separate PR.

@corneliusludmann
Copy link
Contributor

Great! Feel free to remove the hold label when you are ready to merge.

@roboquat roboquat merged commit 79f7312 into main Jul 5, 2022
@roboquat roboquat deleted the tar/preview-tel-init branch July 5, 2022 08:43
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Pothulapati added a commit that referenced this pull request Jul 8, 2022
While #11077 adds a way
to send telemetry once a `local-preview` instance is instantiated
and is running, The user data is not very useful here as the user
hasn't performed any actions, etc. This data is only useful right now
to know that a new install has been performed.

This PR updates the `local-preview` to also do the same whenever
a exit signal is created, By doing this we also get the same
data once a instance is being closed and hence giving use anonymous
info on the usage.

Signed-off-by: Tarun Pothulapati <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note size/S team: delivery Issue belongs to the self-hosted team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Telemetry for local-preview
3 participants