feat: Add telemetry opt-out env var #212
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marofke
force-pushed
the
marofke/telemetry-opt-out-env-var
branch
from
0a8d0ab
to
d74c197
Compare
gahyusuh
previously approved these changes
Mar 15, 2024
ddneilson
previously approved these changes
Mar 15, 2024
marofke
force-pushed
the
marofke/telemetry-opt-out-env-var
branch
from
d74c197
to
d06efcb
Compare
Signed-off-by: Caden Marofke <marofke@amazon.com>
marofke
force-pushed
the
marofke/telemetry-opt-out-env-var
branch
from
d06efcb
to
315e0c6
Compare
gahyusuh
approved these changes
Mar 15, 2024
ddneilson
approved these changes
Mar 15, 2024
This was referenced Mar 15, 2024
Merged
Merged
Merged
Merged
npmacl
pushed a commit
that referenced
this pull request
Mar 21, 2024
Signed-off-by: Caden Marofke <marofke@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was the problem/requirement? (What/Why)
We need an easy way for customers to opt-out of telemetry data collection for our adaptors, ideally through a Queue environment so the amount of configuration is minimal.
What was the solution? (How)
Add an opt-out env var,
DEADLINE_CLOUD_TELEMETRY_OPT_OUT, which will override the config file setting if it exists. Customers can define this env var in their queue environment to opt out of telemetry data collection.I also noticed some tests were throwing background errors, as telemetry wasn't mocked out in some tests, I've fixed those tests.
What is the impact of this change?
Customers can now easily opt-out. Also updated the readme to instruct users on opt-out instructions.
How was this change tested?
Tested manually, confirming telemetry was not sent went the env var was set to true/yes/1/on, and it did send if set to false/no/0/off (or didn't exist).
Tested with adaptors, confirming they didn't send telemetry when the env var was set.
Was this change documented?
There is a readme change.
Is this a breaking change?
No