-
Notifications
You must be signed in to change notification settings - Fork 110
馃 Sync generated docs from sourcegraph/sourcegraph #1883
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,12 +1,12 @@ | ||||||||||
| # Private metadata allowlist | ||||||||||
|
|
||||||||||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | ||||||||||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Link:
Suggested change
|
||||||||||
| By default, `privateMetadata` is **never** exported from customers because it can contain arbitrarily-shaped data that may accidentally include sensitive or private contents. | ||||||||||
| The specific events and properties listed below have been individually reviewed and approved for export. | ||||||||||
| The implementation of each is monitored to ensure they contain only categorized, enumerated information. | ||||||||||
|
|
||||||||||
| The only `metadata` we collect by default are non-sensitive numeric values. | ||||||||||
| To learn more, refer to the [telemetry documentation](/admin/telemetry). | ||||||||||
| To learn more, refer to the [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Link:
Suggested change
|
||||||||||
|
|
||||||||||
| | **Event feature** | **Event action** | **Allowed `privateMetadata` fields** | | ||||||||||
| | :---------------- | :--------------- | :----------------------------------- | | ||||||||||
|
|
||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,7 +3,7 @@ | |||||||||
|
|
||||||||||
| This page contains the core schema for telemetry event data that gets exported from Sourcegraph. | ||||||||||
|
|
||||||||||
| To learn more, refer to our [telemetry documentation](/admin/telemetry). | ||||||||||
| To learn more, refer to our [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Link:
Suggested change
|
||||||||||
|
|
||||||||||
| ## Table of Contents | ||||||||||
|
|
||||||||||
|
|
||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # `src debug` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src debug' gathers and bundles debug data from a Sourcegraph deployment for troubleshooting. | ||
|
|
||
| Usage: | ||
|
|
||
| src debug command [command options] | ||
|
|
||
| The commands are: | ||
|
|
||
| kube dumps context from k8s deployments | ||
| compose dumps context from docker-compose deployments | ||
| server dumps context from single-container deployments | ||
|
|
||
|
|
||
| Use "src debug command -h" for more information about a subcommands. | ||
| src debug has access to flags on src -- Ex: src -v kube -o foo.zip | ||
|
|
||
|
|
||
|
|
||
| ``` | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # `src search-jobs` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src search-jobs' is a tool that manages search jobs on a Sourcegraph instance. | ||
|
|
||
| Usage: | ||
|
|
||
| src search-jobs command [command options] | ||
|
|
||
| The commands are: | ||
|
|
||
| cancel cancels a search job by ID | ||
| create creates a search job | ||
| delete deletes a search job by ID | ||
| get gets a search job by ID | ||
| list lists search jobs | ||
| logs fetches logs for a search job by ID | ||
| restart restarts a search job by ID | ||
| results fetches results for a search job by ID | ||
|
|
||
| Common options for all commands: | ||
| -c Select columns to display (e.g., -c id,query,state,username) | ||
| -json Output results in JSON format | ||
|
|
||
| Use "src search-jobs [command] -h" for more information about a command. | ||
|
|
||
|
|
||
| ``` | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # `src snapshot` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src snapshot' manages snapshots of Sourcegraph instance databases. All subcommands are currently EXPERIMENTAL. | ||
|
|
||
| Usage: | ||
|
|
||
| src snapshot <command> | ||
|
|
||
| The commands are: | ||
|
|
||
| databases export databases from a Sourcegraph instance | ||
| restore restore databases from an export | ||
| upload upload exported databases and summary file when migrating to Sourcegraph Cloud | ||
|
|
||
| summary export summary data about an instance for acceptance testing of a restored Sourcegraph instance | ||
| test use exported summary data and instance health indicators to validate a restored and upgraded instance | ||
|
|
||
| Use "src snapshot [command] -h" for more information about a command. | ||
|
|
||
|
|
||
| ``` | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # `src teams` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src teams' is a tool that manages teams in a Sourcegraph instance. | ||
|
|
||
| Usage: | ||
|
|
||
| src teams command [command options] | ||
|
|
||
| The commands are: | ||
|
|
||
| list lists teams | ||
| create create a team | ||
| update update a team | ||
| delete delete a team | ||
| members manage team members, use "src teams members [command] -h" for more information. | ||
|
|
||
| Use "src teams [command] -h" for more information about a command. | ||
|
|
||
|
|
||
| ``` | ||
|
|
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.
https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters: Absolute self-link; use "/admin/telemetry/protocol#telemetrygateway-v1-EventParameters" instead