Disclose usage reporting: README, environment opt-out, notice link - #23
Merged
Merged
Conversation
Re-vendor trace-client-java 0.2.0 (package line only), which honours TRACE_USAGE_REPORTING=off and DO_NOT_TRACK=1 before the usage.reporting.enabled property gh-backup already passes through the builder. The first-run notice stays first-run but names TRACE_USAGE_REPORTING=off and links to the details page; close() still flushes the one event before a short run exits. The README section becomes a top-level "Usage reporting" listing both events, what is not sent and every opt-out; CONFIG.md, .env.example and docker-compose.yml document and pass through the two environment variables alongside USAGE_REPORTING_ENABLED. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
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.
gh-backup has reported
startupandbackup-completedevents to trace since #22, with a first-run notice that named only its own opt-outs and no link to what trace collects. The vendored trace client is updated to 0.2.0, which honoursTRACE_USAGE_REPORTING=offandDO_NOT_TRACK=1in the environment before theusage.reporting.enabledproperty gh-backup already passes through the builder; the first-run notice stays first-run but now namesTRACE_USAGE_REPORTING=offand links to the details page, and the README's usage-reporting section becomes a top-level## Usage reportinglisting every opt-out.close()still flushes the one event before a short CLI run exits. Nothing about what is sent changes.src/main/java/com/github/backup/trace/TraceClient.java,src/test/java/com/github/backup/trace/TraceClientTest.java: re-vendored from trace-client-java 0.2.0, package line only changed (serverWideConfigis Spigot-only and is not used).src/main/java/com/github/backup/UsageReportingService.java: the first-run notice carries the details link andTRACE_USAGE_REPORTING=off; the class comment lists the environment opt-outs.src/test/java/com/github/backup/trace/UsageReportingEnvironmentTest.java(new),src/test/java/com/github/backup/UsageReportingServiceTest.java:DO_NOT_TRACK=1andTRACE_USAGE_REPORTING=offare asserted to yieldisEnabled() == falseeven when the property says enabled; the notice is asserted to contain the new opt-out and the link.README.md,CONFIG.md,.env.example,docker-compose.yml,src/main/resources/application.properties,CHANGELOG.md:## Usage reportingper the shared wording (events, what is not sent, every opt-out, details link);TRACE_USAGE_REPORTINGandDO_NOT_TRACKare documented alongsideUSAGE_REPORTING_ENABLEDand passed through from.envby the Docker daemon, empty by default.🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson