GoogleContainerTools / GoogleContainerTools/skaffold
Telemetry docs say usage data has 'no argument values', but enum flag values and --platform are collected
- Dominant language
- Go
- Stars
- 15.9k
- Forks
- 1.7k
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 10
Description
### Summary
The telemetry docs state that usage data *"does not include any argument values"*, but the collected metrics do include some flag values — including the doc's own worked example. Flagging as a small documentation-accuracy fix (this is about the wording, not a concern with the data itself).
### Details (at current HEAD)
`docs-v2/content/en/docs/resources/telemetry/_index.md:11` (and the docs-v1 copy):
> Usage data does not include any argument values or personal information.
But the instrumentation collects flag values:
- `pkg/skaffold/instrumentation/meter.go` `AddFlag()` records the stringified value of every changed enum flag: `meter.EnumFlags[flag.Name] = flag.Value.String()`. The **same telemetry doc's example JSON** shows this: `"EnumFlags": {"cache-artifacts": "false", "port-forward": "true"}` — those are argument values.
- `AddCliBuildTargetPlatforms()` records the raw `--platform` CLI value (`types.go` documents it as "the build target platforms specified via command line flag `--platform`").
### Suggestion
Reword line 11 to match reality — e.g. "does not include free-form argument values or personal information; a fixed set of flag values (such as enum flags and `--platform`) is collected as shown below." I'm happy to open a small docs PR (I'd sign the Google CLA first) if that's welcome. I checked open + closed issues and didn't find an existing report.
---
*Disclosure: I used an AI tool to help spot this; I verified the doc claim against `meter.go` and the doc's own example JSON myself and take responsibility for it.*
Contributor guide
Research direction
Start with line 11 in docs-v2/content/en/docs/resources/telemetry/_index.md and its docs-v1 copy, then compare the wording with AddFlag() in pkg/skaffold/instrumentation/meter.go and AddCliBuildTargetPlatforms(). Done means both documentation copies accurately describe the collected enum flag and --platform values while remaining consistent with the example JSON.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 86/100