Add documentation for Usage Metrics #286
Merged
+48
−0
Conversation
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
Signed-off-by: lujunsan <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation about ToolHive's anonymous usage metrics collection alongside the existing error reporting documentation. The changes inform users about what data is collected and how to opt out.
- Separates telemetry documentation into two distinct types: Error reporting (Sentry) and Anonymous usage metrics
- Adds a new FAQ section for privacy and data collection with detailed information about usage metrics
- Includes opt-out instructions via CLI command and environment variable across all relevant documentation pages
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/toolhive/guides-ui/install.mdx | Restructured telemetry section to document both error reporting and anonymous usage metrics with opt-out instructions |
| docs/toolhive/guides-cli/install.mdx | Added info box after installation verification to notify users about anonymous usage metrics collection |
| docs/toolhive/faq.mdx | Added new "Privacy and data collection" section with two FAQs explaining what data is collected and how to disable metrics |
danbarr
requested changes
Nov 10, 2025
Signed-off-by: lujunsan <[email protected]>
Signed-off-by: lujunsan <[email protected]>
danbarr
approved these changes
Nov 13, 2025
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.
Updated documentation for the new Usage Metrics. Relevant PR: stacklok/toolhive#2449