Repository navigation
fix: pass the usage-reporting opt-outs and overrides through compose - #261
Merged
dmccoystephenson merged 1 commit intoNov 6, 2026
Merged
Conversation
…258) compose.yml names the viron service's environment one variable at a time and has no env_file, so DO_NOT_TRACK, TRACE_USAGE_REPORTING, TRACE_INSTALL_ID, USAGE_REPORTING_ENDPOINT and USAGE_REPORTING_KEY never reached the container. Under docker-compose, the documented opt-outs did nothing. They are declared without a value, so compose passes each only when it is set. A ${VAR:-} empty string would turn reporting off, because an empty endpoint or key disables the client rather than falling back to its default. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (anchored on CI run 41994261520:
Judgment notes for the human reviewer:
This PR is not auto-merged: This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
dmccoystephenson
deleted the
feature/compose-usage-reporting-passthrough
branch
November 6, 2026 01:48
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.
Summary
compose.ymlnames thevironservice's environment one variable at a time and has noenv_file, so a variable it does not name never reaches the container.DO_NOT_TRACK=1andTRACE_USAGE_REPORTING=offtherefore had no effect under the documenteddocker-compose up, although the README lists both as ways to turn reporting off.TRACE_INSTALL_ID,USAGE_REPORTING_ENDPOINTandUSAGE_REPORTING_KEYhad the same gap.sample.envlists all five, commented out. The README states what is passed through and warns that an empty endpoint or key turns reporting off.Closes #258
Why no default values
The issue noted that empty is not the same as unset for the endpoint and key. That was confirmed in the source.
USAGE_REPORTING_KEY=set but empty givesREASON_NO_KEY, andUSAGE_REPORTING_ENDPOINT=set but empty makes the builder throw, whichUsageReporter.buildClientturns into a disabled client. A${VAR:-}entry, the form used for other optional variables in this file, would therefore have switched reporting off for every default deployment. A real default would have copied the bundled key intocompose.yml. A key-only entry avoids both and keeps today's behaviour when nothing is set.An operator who explicitly sets the endpoint or key to an empty value in
.envstill turns reporting off. This is documented in the README and insample.env.Test plan
mvn -B test: 663 tests run, 0 failures, 0 errors, 0 skipped.ComposeUsageReportingTestparses the realcompose.ymlandsample.env. With those two files reverted, both of its tests fail (Tests run: 2, Failures: 2). With the fix restored, both pass.docker composeitself. Docker is not available in the session sandbox, socompose.ymlwas parsed as YAML but never loaded by Compose. The resolution of key-only entries from the shell and from.envrests on the Compose documentation. A smoke test is recommended before merge: rundocker compose configwithDO_NOT_TRACK=1in.envand confirm it appears on thevironservice, then run it with the variable absent and confirm thatUSAGE_REPORTING_KEYdoes not appear.Merge hold
compose.ymlis on the dev loop's do-not-auto-merge list, so this PR is left open for human review even though the run was pre-authorized to merge.Triage / skip reasons
pom.xmlbuild pipeline, beyond one cycle's scope ceiling.This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson
🤖 Generated with Claude Code