Repository navigation
docs(collect): document the telemetry export and --telemetry-days - #176
Draft
fatih-acar wants to merge 1 commit into
Draft
fatih-acar wants to merge 1 commit into
fatih-acar wants to merge 1 commit into
Conversation
Every troubleshooting bundle carries telemetry/telemetry-export.json, but no page mentioned it, so a customer reviewing a bundle before sharing it could not learn that it was there or what it holds. List the telemetry collector wherever the docs list bundle contents or collect flags. In "Review before sharing", explain that the export is written without masking and what Infrahub stores in each snapshot. Document --telemetry-days (INFRAHUB_TELEMETRY_DAYS). Closes #169 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Deploying infrahub-ops-cli with
|
| Latest commit: |
602e43c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b6ae6434.infrahub-ops-cli.pages.dev |
| Branch Preview URL: | https://fac-fix-telemetry-collector.infrahub-ops-cli.pages.dev |
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.
Why the collect docs need the telemetry collector
Every troubleshooting bundle contains
telemetry/telemetry-export.json: by default 30 days of Infrahub product-telemetry snapshots, exported withinfrahubctl telemetry export(collect_telemetry.go). No page indocs/mentioned the export or the--telemetry-daysflag. A customer who asked what a bundle contains and whether it is anonymous could not find the answer in the documentation, as reported in #169.Closes #169
This PR changes documentation only. It does not change the collector, its flags, or the bundle layout. It does not add a way to leave the telemetry export out of a bundle.
Pages that now document the telemetry export
docs/docs/collect/index.mdxINFRAHUB_TELEMETRY_OPTOUTturns reporting to OpsMill offdocs/docs/collect/create.mdx--telemetry-daysandINFRAHUB_TELEMETRY_DAYS. It says that a value of0or less uses the 30-day default, that no flag removes the export, and when the collector is recorded asskipped.docs/docs/reference/commands.mdx: thecreateflag table, a new example, and the collectors table.docs/docs/reference/configuration.mdx: the collect command flag table.changelog/169.fixed.md: the changelog entry.Sources for each claim about the telemetry export
task-worker, uses a 30-day default, falls back to 30 for a value of0or less, recordsskippedwhen the export produces no file, and keepsinfrahubctloutput intelemetry-export.err.txt. Source:src/internal/app/collect_telemetry.gosrc/cmd/infrahub-collect/main.goand theINFRAHUBprefix insrc/internal/app/cli.gosrc/internal/app/masking.goandcollect_telemetry.goinfrahub-v1.9.0and theinfrahubctl telemetry exportcommandinfrahub-v1.8.7tag.Docs checks run
uv run --no-sync rumdl check .: no issues.commands.mdx, which this PR does not change.pnpm run buildindocs/with Node 22: the site builds with no broken-link or broken-anchor warnings.uv run towncrier build --draft --version 0.0.0: the entry renders under "Fixed".No change to the binaries, flags, or bundle format
Documentation only: no change to the binaries, flags, defaults, environment variables, or bundle format.
Follow-up not done in this PR
[CLAUDE RECOMMENDED – based on the new "Change the telemetry time window" section, which has to state that no flag removes the export] Open an issue to discuss an option that leaves the telemetry export out of a bundle, for customers who decide not to share it.
Checklist
changelog/169.fixed.md)docs/)dev/knowledge/infrahub-collect.mdalready describes the telemetry collector)Assisted-by: opsmill-dev-pr 0.2.0
🤖 Generated with Claude Code
Summary by cubic
Documents the
telemetry/telemetry-export.jsonfile that every troubleshooting bundle already contains, which no docs page previously mentioned. Closes #169.The docs now describe what the export holds, that Infrahub stores the snapshots even when reporting to OpsMill is opted out, that the export is written without masking, and how to change the 30-day time window with
--telemetry-days(INFRAHUB_TELEMETRY_DAYS). Documentation only — no change to binaries, flags, defaults, or bundle format.Written for commit 602e43c. Summary will update on new commits.