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

Checkpoint telemetry integration #326

Merged
merged 7 commits into from
Aug 21, 2020
Merged

Checkpoint telemetry integration #326

merged 7 commits into from
Aug 21, 2020

Conversation

anubhavmishra
Copy link
Member

@anubhavmishra anubhavmishra commented Aug 18, 2020

Integrating Checkpoint telemetry to report project version, provider name, provider version, etc.

No personal data needs to be collected through this telemetry option. Like all HashiCorp projects using Checkpoint, we have an environmental variable CHECKPOINT_DISABLE that can be set to a non empty value for opting out of this reporting.

Fixes: #325

Copy link
Contributor

@skorfmann skorfmann left a comment

Choose a reason for hiding this comment

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

Besides from the comments, are we going to document this somehow?

packages/cdktf-cli/lib/checkpoint.ts Outdated Show resolved Hide resolved
packages/cdktf-cli/lib/checkpoint.ts Outdated Show resolved Hide resolved

export async function ReportRequest(reportParams: ReportParams): Promise<void> {
// we won't report when checkpoint is disabled.
if (process.env.CDKTF_CHECKPOINT_DISABLE == "1") {
Copy link
Contributor

Choose a reason for hiding this comment

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

should this be set for our tests - so pretty much for all CI jobs?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I think that would help give with generating accurate telemetry.

@anubhavmishra
Copy link
Member Author

I have documented the telemetry here.

Copy link
Contributor

@skorfmann skorfmann left a comment

Choose a reason for hiding this comment

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

Looks good.

What do you think about adding one explicit (integration) test for this telemetry stuff?

Copy link
Contributor

@skorfmann skorfmann left a comment

Choose a reason for hiding this comment

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

As just discussed, just merge after adding the integration test

@anubhavmishra
Copy link
Member Author

anubhavmishra commented Aug 21, 2020

I am seeing errors that aren't related to the PR. I think merging #276 has started causing these errors.

@jsteinich
Copy link
Collaborator

I am seeing errors that aren't related to the PR. I think merging #276 has started causing these errors.

I'm looking into it.

@anubhavmishra anubhavmishra merged commit ab46998 into master Aug 21, 2020
@anubhavmishra anubhavmishra deleted the f-checkpoint branch August 21, 2020 17:30
This was referenced Aug 21, 2020
@github-actions
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Project Metrics
3 participants