Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Remove telemetry code #3633

Closed
dholbach opened this issue Aug 16, 2022 · 7 comments · Fixed by #3636
Closed

Remove telemetry code #3633

dholbach opened this issue Aug 16, 2022 · 7 comments · Fixed by #3636
Milestone

Comments

@dholbach
Copy link
Member

Following up from #2990 and discussion afterwards, it was pointed out to us that for telemetry data we should follow https://linuxfoundation.org/telemetry-data-policy/

As Flux v1 will be end-of-life soon anyway, it might make sense to just go and disable the code in question.

@stefanprodan
Copy link
Member

I'm for deleting the telemetry code from v1 https://github.com/fluxcd/flux/tree/master/pkg/checkpoint

@pjbgf
Copy link
Member

pjbgf commented Aug 16, 2022

+1 for removing the telemetry code.

@dholbach dholbach changed the title Disable telemetry Remove telemetry code Aug 16, 2022
@dholbach dholbach added this to the 1.25.4 milestone Aug 16, 2022
@kingdonb
Copy link
Member

If we delete the telemetry code, then users who depend on the checkpoint feature to know when there is a new version available will no longer receive the notice.

Is there a way to delete the code that does not remove this feature? Otherwise it is a breaking change as anything that emits a log message has been considered as part of the public API since maintenance mode.

@stefanprodan
Copy link
Member

Is there a way to delete the code that does not remove this feature?

No, to know which version is latest, Flux needs to call home.

@kingdonb
Copy link
Member

kingdonb commented Aug 16, 2022

We could substitute a call to GitHub REST API, query the tag refs, and pass back no information

Or we could go on using the same Checkpoint API, but pass in 0.0.0 since it does not matter which version of Flux v1 they are using, they should all be flagged as needing an upgrade. That would satisfy the policy requirement to not create telemetry data I think, but it does not stop us from potentially building a list of who is phoning home. I'll have to read the telemetry policy to understand its intention and purpose, but I would guess that's still not going to fly (and phoning home to GitHub is not much better.)

IOW, at some point all Flux v1 versions should be signaling that it's time to upgrade to v2 and emitting this warning every checkpoint interval whether or not they are on the latest Flux v1, and we have #3628 which suggests this time is coming soon (or has already arrived.)

@stefanprodan
Copy link
Member

I propose we delete the checkpoint code and replace it with a message that tells people to upgrade to v2 along with a link to the migration docs.

@kingdonb
Copy link
Member

I've removed the telemetry in #3636 and the output of checkpoint code looks like this now:

ts=2022-08-26T21:44:13.882228313Z caller=checkpoint.go:15 component=checkpoint msg="update available" latest=v0.33.0 URL=https://fluxcd.io/docs/migration/

I can change the msg to something grander than "update available" if you think we should use the word deprecated for example for emphasis, let me know what else you think it should say and I'll add it 👍

We should be ready to release this on Monday maybe Tuesday, knowing that Monday is a bank holiday for some folks, I'll be working though, so I can release it on Monday, along with fixes for the other issues I have tagged with Milestone 1.25.4 that I'm still working on

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 a pull request may close this issue.

4 participants