-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: usage data collection #6822
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: Anonymous Usage Data | ||
| sidebar_label: Usage Data | ||
| sidebar_position: 66 | ||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
| import { PanelLeft } from 'lucide-react'; | ||
|
|
||
| On first use, goose asks for permission to collect anonymous usage data to help improve the product. You can change this setting at any time. | ||
|
|
||
| ## Usage data collected | ||
|
|
||
| To respect your privacy, goose collects only anonymous usage metrics when you opt in. If enabled, the following data is collected: | ||
|
|
||
| - Operating system, version, and architecture | ||
| - goose version and install method | ||
| - Provider and model used | ||
| - Extensions and tool usage counts (names only) | ||
| - Session metrics (duration, interaction count, token usage) | ||
| - Error types (e.g., "rate_limit", "auth" - no details) | ||
|
|
||
| Collected usage data doesn't include your conversations, code, tool arguments, error messages, or any personal data. | ||
|
|
||
| :::info Provider Data Handling | ||
| Depending on the [LLMs](/docs/getting-started/providers) you use with goose, your conversations, prompts, and information accessed by goose might be sent to the provider and subject to their data retention and privacy policies. | ||
| ::: | ||
|
|
||
| ## Change Your Preference | ||
|
|
||
| To change your usage data collection preference: | ||
|
|
||
| <Tabs groupId="interface"> | ||
| <TabItem value="ui" label="goose Desktop" default> | ||
| 1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar | ||
| 2. Click `Settings` in the sidebar | ||
| 3. Click the `App` tab | ||
| 4. In the `Privacy` section, toggle `Anonymous usage data` on or off | ||
| </TabItem> | ||
| <TabItem value="cli" label="goose CLI"> | ||
| Use the arrow keys to move through the options and press `Enter` to select. A solid dot shows your current selection. | ||
| 1. Run `goose configure` | ||
| 2. Choose `goose settings` | ||
| 3. Choose `Telemetry` | ||
| 4. Your current telemetry status is shown. Select `Yes` to enable anonymous usage data collection or `No` to disable it. | ||
|
|
||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ goose settings | ||
| │ | ||
| ◇ What setting would you like to configure? | ||
| │ Telemetry | ||
| │ | ||
| ● Current telemetry status: Disabled | ||
| │ | ||
| ◇ Share anonymous usage data to help improve goose? | ||
| │ Yes | ||
| │ | ||
| └ Telemetry enabled - thank you for helping improve goose! | ||
| └ Configuration saved successfully to /Users/julesv/.config/goose/config.yaml | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| You can also set the `GOOSE_TELEMETRY_ENABLED` variable directly in your [`config.yaml` file](/docs/guides/config-files), or use it as an [environment variable](/docs/guides/environment-variables#security-and-privacy) to set telemetry status for a given session. | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gleaned from other docs/blogs