From dbed5789b17e1c799b7d381ba31812d255068b3b Mon Sep 17 00:00:00 2001 From: Buildkite Date: Thu, 2 Apr 2026 22:07:29 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20sync'ing=20generated=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/admin/code-hosts/aws-codecommit.mdx | 2 +- docs/admin/code-hosts/azuredevops.mdx | 2 +- docs/admin/code-hosts/bitbucket-cloud.mdx | 2 +- docs/admin/code-hosts/bitbucket-server.mdx | 2 +- docs/admin/code-hosts/gerrit.mdx | 2 +- docs/admin/code-hosts/github.mdx | 2 +- docs/admin/code-hosts/gitlab.mdx | 2 +- docs/admin/code-hosts/gitolite.mdx | 2 +- docs/admin/code-hosts/other.mdx | 2 +- docs/admin/code-hosts/phabricator.mdx | 2 +- docs/admin/config/settings.mdx | 2 +- docs/admin/config/site-config.mdx | 2 +- docs/admin/repo/perforce.mdx | 2 +- docs/cli/references/auth.mdx | 22 +++++ docs/cli/references/index.mdx | 1 + docs/cli/references/login.mdx | 6 +- docs/self-hosted/observability/alerts.mdx | 36 ++++++++ docs/self-hosted/observability/dashboards.mdx | 82 +++++++++++++++++-- 18 files changed, 154 insertions(+), 19 deletions(-) create mode 100644 docs/cli/references/auth.mdx diff --git a/docs/admin/code-hosts/aws-codecommit.mdx b/docs/admin/code-hosts/aws-codecommit.mdx index 92975a892..ecfad70ab 100644 --- a/docs/admin/code-hosts/aws-codecommit.mdx +++ b/docs/admin/code-hosts/aws-codecommit.mdx @@ -37,7 +37,7 @@ AWS CodeCommit connections support the following configuration options, which ar {/* SCHEMA_SYNC_START: admin/code_hosts/aws_codecommit.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // REQUIRED: diff --git a/docs/admin/code-hosts/azuredevops.mdx b/docs/admin/code-hosts/azuredevops.mdx index a3b676c21..a6ffe885b 100644 --- a/docs/admin/code-hosts/azuredevops.mdx +++ b/docs/admin/code-hosts/azuredevops.mdx @@ -65,7 +65,7 @@ Azure DevOps connections support the following configuration options, which are {/* SCHEMA_SYNC_START: admin/code_hosts/azuredevops.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json // Authentication alternatives: token OR windowsPassword diff --git a/docs/admin/code-hosts/bitbucket-cloud.mdx b/docs/admin/code-hosts/bitbucket-cloud.mdx index 6e28423cf..741aef5fb 100644 --- a/docs/admin/code-hosts/bitbucket-cloud.mdx +++ b/docs/admin/code-hosts/bitbucket-cloud.mdx @@ -116,7 +116,7 @@ Bitbucket Cloud connections support the following configuration options, which a {/* SCHEMA_SYNC_START: admin/code_hosts/bitbucket_cloud.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // The workspace access token to use when authenticating with Bitbucket Cloud. diff --git a/docs/admin/code-hosts/bitbucket-server.mdx b/docs/admin/code-hosts/bitbucket-server.mdx index 4b32be04a..ee1fbf73c 100644 --- a/docs/admin/code-hosts/bitbucket-server.mdx +++ b/docs/admin/code-hosts/bitbucket-server.mdx @@ -202,7 +202,7 @@ Bitbucket Server / Bitbucket Data Center connections support the following confi {/* SCHEMA_SYNC_START: admin/code_hosts/bitbucket_server.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json // Authentication alternatives: token OR password diff --git a/docs/admin/code-hosts/gerrit.mdx b/docs/admin/code-hosts/gerrit.mdx index 9fd9f2825..eabc1781c 100644 --- a/docs/admin/code-hosts/gerrit.mdx +++ b/docs/admin/code-hosts/gerrit.mdx @@ -113,7 +113,7 @@ Gerrit connections support the following configuration options, which are specif {/* SCHEMA_SYNC_START: admin/code_hosts/gerrit.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. diff --git a/docs/admin/code-hosts/github.mdx b/docs/admin/code-hosts/github.mdx index 93826d807..34c09a03a 100644 --- a/docs/admin/code-hosts/github.mdx +++ b/docs/admin/code-hosts/github.mdx @@ -454,7 +454,7 @@ GitHub connections support the following configuration options, which are specif {/* SCHEMA_SYNC_START: admin/code_hosts/github.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json // Authentication alternatives: token OR gitHubAppDetails OR externalAccount OR useRandomExternalAccount diff --git a/docs/admin/code-hosts/gitlab.mdx b/docs/admin/code-hosts/gitlab.mdx index 0f844657f..bf70fdf6c 100644 --- a/docs/admin/code-hosts/gitlab.mdx +++ b/docs/admin/code-hosts/gitlab.mdx @@ -189,7 +189,7 @@ See [Internal rate limits](/admin/code-hosts/rate-limits#internal-rate-limits). {/* SCHEMA_SYNC_START: admin/code_hosts/gitlab.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // If non-null, enforces GitLab repository permissions. This requires that there be an item in the `auth.providers` field of type "gitlab" with the same `url` field as specified in this `GitLabConnection`. diff --git a/docs/admin/code-hosts/gitolite.mdx b/docs/admin/code-hosts/gitolite.mdx index c3e945707..0f1c1bfc0 100644 --- a/docs/admin/code-hosts/gitolite.mdx +++ b/docs/admin/code-hosts/gitolite.mdx @@ -25,7 +25,7 @@ To connect Gitolite to Sourcegraph: {/* SCHEMA_SYNC_START: admin/code_hosts/gitolite.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // A list of repositories to never mirror from this Gitolite instance. Supports excluding by exact name ({"name": "foo"}). diff --git a/docs/admin/code-hosts/other.mdx b/docs/admin/code-hosts/other.mdx index 38903208f..868d63769 100644 --- a/docs/admin/code-hosts/other.mdx +++ b/docs/admin/code-hosts/other.mdx @@ -68,7 +68,7 @@ Repositories must be listed individually: {/* SCHEMA_SYNC_START: admin/code_hosts/other_external_service.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // A list of repositories to never mirror by name after applying repositoryPathPattern. Supports excluding by exact name ({"name": "myrepo"}) or regular expression ({"pattern": ".*secret.*"}). diff --git a/docs/admin/code-hosts/phabricator.mdx b/docs/admin/code-hosts/phabricator.mdx index 49461a8f0..b41a339d3 100644 --- a/docs/admin/code-hosts/phabricator.mdx +++ b/docs/admin/code-hosts/phabricator.mdx @@ -76,7 +76,7 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config {/* SCHEMA_SYNC_START: admin/code_hosts/phabricator.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`. diff --git a/docs/admin/config/settings.mdx b/docs/admin/config/settings.mdx index 3073d85c5..4ebaadaff 100644 --- a/docs/admin/config/settings.mdx +++ b/docs/admin/config/settings.mdx @@ -27,7 +27,7 @@ Settings options and their default values are shown below. {/* SCHEMA_SYNC_START: admin/config/settings.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { diff --git a/docs/admin/config/site-config.mdx b/docs/admin/config/site-config.mdx index b2c318347..6c6026d2f 100644 --- a/docs/admin/config/site-config.mdx +++ b/docs/admin/config/site-config.mdx @@ -21,7 +21,7 @@ All site configuration options and their default values are shown below. {/* SCHEMA_SYNC_START: admin/config/site.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { diff --git a/docs/admin/repo/perforce.mdx b/docs/admin/repo/perforce.mdx index 8cb33dbab..0fccc0816 100644 --- a/docs/admin/repo/perforce.mdx +++ b/docs/admin/repo/perforce.mdx @@ -228,7 +228,7 @@ With this setting, Sourcegraph will ignore any rules with a host other than `*`, {/* SCHEMA_SYNC_START: admin/code_hosts/perforce.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} -{/* Last updated: 2026-03-30T11:57:12Z */} +{/* Last updated: 2026-04-02T22:07:28Z */} ```json { // If non-null, enforces Perforce depot permissions. diff --git a/docs/cli/references/auth.mdx b/docs/cli/references/auth.mdx new file mode 100644 index 000000000..eb5d3834e --- /dev/null +++ b/docs/cli/references/auth.mdx @@ -0,0 +1,22 @@ +# `src auth` + + + +## Usage + +``` +'src auth' provides authentication-related helper commands. + +Usage: + + src auth command [command options] + +The commands are: + + token prints the current authentication token + +Use "src auth [command] -h" for more information about a command. + + +``` + \ No newline at end of file diff --git a/docs/cli/references/index.mdx b/docs/cli/references/index.mdx index 5f606371d..9c0eb3737 100644 --- a/docs/cli/references/index.mdx +++ b/docs/cli/references/index.mdx @@ -5,6 +5,7 @@ * [`admin`](references/admin) * [`api`](references/api) +* [`auth`](references/auth) * [`batch`](references/batch) * [`code-intel`](references/code-intel) * [`codeowners`](references/codeowners) diff --git a/docs/cli/references/login.mdx b/docs/cli/references/login.mdx index a53c76fd7..19a74edaf 100644 --- a/docs/cli/references/login.mdx +++ b/docs/cli/references/login.mdx @@ -19,7 +19,7 @@ Usage: - src login SOURCEGRAPH_URL + src login [flags] SOURCEGRAPH_URL Examples: @@ -31,6 +31,10 @@ Examples: $ src login https://sourcegraph.com + If no access token is configured, 'src login' uses OAuth device flow automatically: + + $ src login https://sourcegraph.com + -dump-requests Log GraphQL requests and responses to stdout -get-curl diff --git a/docs/self-hosted/observability/alerts.mdx b/docs/self-hosted/observability/alerts.mdx index 1909109c1..42204ef42 100644 --- a/docs/self-hosted/observability/alerts.mdx +++ b/docs/self-hosted/observability/alerts.mdx @@ -6840,6 +6840,42 @@ Generated query for critical alert: `max((sum(rate(src_deepsearch_question_proce
+## deepsearch: deepsearch_errored_but_billed_rate + +

errored but billed rate over 5m

+ +**Descriptions** + +- warning deepsearch: 5%+ errored but billed rate over 5m for 10m0s +- critical deepsearch: 95%+ errored but billed rate over 5m for 10m0s + +**Next steps** + +- Check for upstream LLM provider issues causing token limit or truncation errors. +- Review `deepsearch_question_outcome_by_reason` for outcome breakdown. +- More help interpreting this metric is available in the [dashboards reference](dashboards#deepsearch-deepsearch_errored_but_billed_rate). +- **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: + +```json +"observability.silenceAlerts": [ + "warning_deepsearch_deepsearch_errored_but_billed_rate", + "critical_deepsearch_deepsearch_errored_but_billed_rate" +] +``` + +*Managed by the Sourcegraph Code Understanding team.* + +
+Technical details + +Generated query for warning alert: `max((sum(rate(src_deepsearch_question_outcome_total{billable="true",error="true"\}[5m])) / (sum(rate(src_deepsearch_question_outcome_total\{billable="true"}[5m])) > 0) * 100) > 5)` + +Generated query for critical alert: `max((sum(rate(src_deepsearch_question_outcome_total{billable="true",error="true"\}[5m])) / (sum(rate(src_deepsearch_question_outcome_total\{billable="true"}[5m])) > 0) * 100) > 95)` + +
+ +
+ ## deepsearch: deepsearch_llm_stream_fatal_errors

fatal LLM stream errors over 5m

diff --git a/docs/self-hosted/observability/dashboards.mdx b/docs/self-hosted/observability/dashboards.mdx index 0e5a20306..0396ff882 100644 --- a/docs/self-hosted/observability/dashboards.mdx +++ b/docs/self-hosted/observability/dashboards.mdx @@ -6205,9 +6205,7 @@ sum(src_gitserver_clone_queue)

Number of concurrent requests running against gitserver client

-This metric is only for informational purposes. It indicates the current number of concurrently running requests by process against gitserver gRPC. - -It does not indicate any problems with the instance, but can give a good indication of load spikes or request throttling. +This metric is only for informational purposes. It indicates the current number of concurrently running requests by process against gitserver gRPC. It does not indicate any problems with the instance, but can give a good indication of load spikes or request throttling. This panel has no related alerts. @@ -6227,6 +6225,30 @@ sum by (job, instance) (src_gitserver_client_concurrent_requests)
+#### gitserver: repos_not_on_primary + +

Cloned repos not on primary shard

+ +The number of cloned repositories currently observed off-primary. For shard relocation operations this should trend towards zero. + +This panel has no related alerts. + +To see this panel, visit `/-/debug/grafana/d/gitserver/gitserver?viewPanel=100032` on your Sourcegraph instance. + +*Managed by the Sourcegraph Services team.* + +
+Technical details + +Query: + +``` +max(src_repoupdater_repos_not_on_primary) +``` +
+ +
+ ### Git Server: Gitserver (CPU, Memory) Gitserver leverages memory mapping to optimize file reads: it is generally expected to consume all the memory provided to it, if it can. When it finds data that is not available in memory yet, this causes a 'page fault', and the data is loaded into memory from disk. @@ -33673,6 +33695,56 @@ histogram_quantile(0.50, sum(rate(src_deepsearch_question_processing_duration_se
+### Deep Search: Question outcomes + +#### deepsearch: deepsearch_question_outcome_by_reason + +

Question outcomes by reason over 5m

+ +Breakdown of deep search question outcomes by reason and whether the question was billable. + +This panel has no related alerts. + +To see this panel, visit `/-/debug/grafana/d/deepsearch/deepsearch?viewPanel=100100` on your Sourcegraph instance. + +*Managed by the Sourcegraph Code Understanding team.* + +
+Technical details + +Query: + +``` +sum by (outcome, billable) (rate(src_deepsearch_question_outcome_total[5m])) * 60 +``` +
+ +
+ +#### deepsearch: deepsearch_errored_but_billed_rate + +

Errored but billed rate over 5m

+ +Percentage of billed deep search questions that completed with an error (token limit exceeded or response truncated). + +Refer to the [alerts reference](alerts#deepsearch-deepsearch_errored_but_billed_rate) for 2 alerts related to this panel. + +To see this panel, visit `/-/debug/grafana/d/deepsearch/deepsearch?viewPanel=100101` on your Sourcegraph instance. + +*Managed by the Sourcegraph Code Understanding team.* + +
+Technical details + +Query: + +``` +sum(rate(src_deepsearch_question_outcome_total{billable="true",error="true"}[5m])) / (sum(rate(src_deepsearch_question_outcome_total{billable="true"}[5m])) > 0) * 100 +``` +
+ +
+ ### Deep Search: LLM streaming #### deepsearch: deepsearch_llm_stream_fatal_errors @@ -33683,7 +33755,7 @@ Number of fatal errors during LLM streaming in the last 5 minutes. Refer to the [alerts reference](alerts#deepsearch-deepsearch_llm_stream_fatal_errors) for 1 alert related to this panel. -To see this panel, visit `/-/debug/grafana/d/deepsearch/deepsearch?viewPanel=100100` on your Sourcegraph instance. +To see this panel, visit `/-/debug/grafana/d/deepsearch/deepsearch?viewPanel=100200` on your Sourcegraph instance. *Managed by the Sourcegraph Code Understanding team.* @@ -33707,7 +33779,7 @@ Number of non-fatal errors during LLM streaming. This panel has no related alerts. -To see this panel, visit `/-/debug/grafana/d/deepsearch/deepsearch?viewPanel=100101` on your Sourcegraph instance. +To see this panel, visit `/-/debug/grafana/d/deepsearch/deepsearch?viewPanel=100201` on your Sourcegraph instance. *Managed by the Sourcegraph Code Understanding team.*