Correct the Windows section: supplied configs need a Windows config too - #261
Merged
Merged
Conversation
The section said the Windows daemon shares credentials with the other collectors and there was nothing further to configure. That is only true when the chart generates your collector configuration. If you supply scout.agent.config or scout.daemon.config -- which is what the otelcol style configuration further down this page does -- your configuration carries its own credentials under value names you chose, commonly scout.clientId and scout.clientSecret. A generated Windows configuration would instead derive client_id from scout.appName and read the secret from scout.apiKey, so the Windows daemon would authenticate differently from every other collector in the release. Chart 0.6.1 refuses to render in that case rather than doing it silently. This documents the requirement and shows the configuration to supply. extraEnvs is described alongside it, since it is the same per-collector behaviour for the same reason.
The page pinned 0.6.0, which is the version that silently falls back to a generated Windows configuration when you supply your own for the other collectors -- authenticating the Windows daemon with different credentials and failing every export at runtime. Documenting the requirement while still installing the version that does not enforce it would be the worst of both: a reader who missed the new section would hit exactly the failure it warns about. 0.6.1 refuses to render in that case instead.
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
1 participant
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.
Corrects the Windows section added in #260. It said:
That is only true when the chart generates your collector configuration.
The problem
If you set
scout.agent.configorscout.daemon.config— which is what the otelcol style configuration further down the same page does — your configuration carries its own credentials, under value names you chose. Our examples usescout.clientIdandscout.clientSecret.A generated Windows configuration instead derives
client_idfromscout.appNameand reads the secret fromscout.apiKey. So the Windows daemon would authenticate with different credentials from every other collector in the release, and fail every export at runtime while looking healthy.The fix
Chart
0.6.1refuses to render in that case rather than doing it silently (base14-infra#486). This documents the requirement and shows the configuration to supply.extraEnvsis described alongside it, since it is the same per-collector behaviour for the same underlying reason — Helm replaces lists rather than merging them.Also bumps the documented version to 0.6.1
The page pinned
0.6.0— the version that silently falls back to a generated Windows configuration. Documenting the requirement while still installing the version that does not enforce it would be the worst of both: a reader who skimmed past the new section would hit exactly the failure it warns about.0.6.1is live oncharts.base14.ioand refuses to render in that case instead.Verification
The
windowsDaemon.configexample in this change was rendered against the published0.6.1chart fromcharts.base14.io: it satisfies the guard and producesclient_id: THEIR-CLIENT-IDwith the Windows filelog glob, rather than falling back to generated defaults.🤖 Generated with Claude Code