Follow the Do Not Track pattern to opt out of telemetry
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- rust
- Domain
- cli, observability
Research direction
Start by reading the CLI telemetry option and the code that reads EMULATOR_TELEMETRY; the issue does not name specific files, so search the repository for those terms. Check how telemetry settings are documented and tested. Done means DO_NOT_TRACK=1 disables telemetry, existing opt-out options still work, and the documentation explains the new variable.
Written by the indexing model from the issue text.
Description
Before you file
- I searched open and recently closed issues and found no request for this.
- I checked that the latest version of the emulator doesn't already do this.
Use case
According to the documentation, opting out of telemetry requires using the CLI flag --telemetry off and/or setting the EMULATOR_TELEMETRY=off environment variable.
That's fine, but there's an effort to standardize on this behavior called Do Not Track.
My proposal would be to endorse this pattern, which would mean:
- Keeping the existing behavior.
- Adding support for the environment variable
DO_NOT_TRACKwhich, if set to1, would have the same effect as the above, disabling telemetry. - Updating the documentation accordingly.
What would help
It would allow users to set telemetry off by default, on CLIs that follow the standard, by exporting a standardized environment variable.
Other information
No response
Emulator version
- Dominant language
- Rust
- Stars
- 2.2k
- Forks
- 44
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aws/aws-emulator
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
aws/aws-emulator#30 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
aws/aws-emulator#34 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
aws/aws-emulator#33 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
aws/aws-emulator#32 · 1 reaction ·
-
ConverseStream fails from AWS SDK for JavaScript v3: TLS ALPN 'no application protocol' (no h2)Open
Difficulty 4/5 3-5 days Newbie friendliness 47/100
aws/aws-emulator#31 ·
All issues in aws/aws-emulator
Similar issues
-
tormach-plasma refusal text with no machine reads "no machine is not declared a plasma machine"Openarea:post bug effort:low P2 source:agent
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Chat images never show without ImageMagick: ffprobe fallback uses an option string ffprobe 9 rejectsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
eliasstravik/herdr-projects#1011 ·
-
design-data-spec
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
adobe/spectrum-design-data#1744 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day