Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3,224 changes: 1,560 additions & 1,664 deletions docs/admin/observability/alerts.mdx

Large diffs are not rendered by default.

15,543 changes: 7,142 additions & 8,401 deletions docs/admin/observability/dashboards.mdx

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions docs/cli/references/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
| `-query` | GraphQL query to execute, e.g. 'query \{ currentUser \{ username \} \}' (stdin otherwise) | |
| `-trace` | Log the trace ID for requests. See [docs](/admin/observability/tracing) | `false` |
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
| `-vars` | GraphQL query variables to include as JSON string, e.g. '\{"var": "val", "var2": "val2"\}' | |

Expand All @@ -27,7 +27,7 @@ Usage of 'src api':
-query string
GraphQL query to execute, e.g. 'query { currentUser { username } }' (stdin otherwise)
-trace
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
-user-agent-telemetry
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
-vars string
Expand Down Expand Up @@ -60,3 +60,4 @@ Examples:


```

12 changes: 8 additions & 4 deletions docs/cli/references/batch/apply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
| `-f` | The batch spec file to read, or - to read from standard input. | |
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
Expand All @@ -20,11 +21,11 @@
| `-n` | Alias for -namespace. | |
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
| `-skip-errors` | If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped. | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
| `-tmp` | Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. | `/tmp` |
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
| `-v` | print verbose output | `false` |
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |
Expand All @@ -48,6 +49,8 @@ Usage of 'src batch apply':
Log GraphQL requests and responses to stdout
-f string
The batch spec file to read, or - to read from standard input.
-fail-fast
Halts execution immediately upon first error instead of continuing with other tasks.
-force-override-ignore
Do not ignore repositories that have a .batchignore file.
-get-curl
Expand All @@ -65,15 +68,15 @@ Usage of 'src batch apply':
-run-as-root
If true, forces all step containers to run as root.
-skip-errors
If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped.
If true, errors encountered won't stop the program, but only log them.
-text-only
INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines.
-timeout duration
The maximum duration a single batch spec step can take. (default 1h0m0s)
-tmp string
Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. (default "/tmp")
-trace
Log the trace ID for requests. # See https://sourcegraph.com/docs/admin/observability/tracing
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
-user-agent-telemetry
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
-v print verbose output
Expand All @@ -99,3 +102,4 @@ Examples:


```

8 changes: 6 additions & 2 deletions docs/cli/references/batch/new.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
| `-f` | The name of the batch spec file to create. | `batch.yaml` |
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |


Expand All @@ -25,8 +26,10 @@ Usage of 'src batch new':
Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
-insecure-skip-verify
Skip validation of TLS certificates against trusted chains
-skip-errors
If true, errors encountered won't stop the program, but only log them.
-trace
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
-user-agent-telemetry
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)

Expand All @@ -45,3 +48,4 @@ Examples:


```

12 changes: 8 additions & 4 deletions docs/cli/references/batch/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
| `-f` | The batch spec file to read, or - to read from standard input. | |
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
Expand All @@ -20,11 +21,11 @@
| `-n` | Alias for -namespace. | |
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
| `-skip-errors` | If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped. | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
| `-tmp` | Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. | `/tmp` |
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
| `-v` | print verbose output | `false` |
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |
Expand All @@ -48,6 +49,8 @@ Usage of 'src batch preview':
Log GraphQL requests and responses to stdout
-f string
The batch spec file to read, or - to read from standard input.
-fail-fast
Halts execution immediately upon first error instead of continuing with other tasks.
-force-override-ignore
Do not ignore repositories that have a .batchignore file.
-get-curl
Expand All @@ -65,15 +68,15 @@ Usage of 'src batch preview':
-run-as-root
If true, forces all step containers to run as root.
-skip-errors
If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped.
If true, errors encountered won't stop the program, but only log them.
-text-only
INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines.
-timeout duration
The maximum duration a single batch spec step can take. (default 1h0m0s)
-tmp string
Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. (default "/tmp")
-trace
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
-user-agent-telemetry
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
-v print verbose output
Expand All @@ -97,3 +100,4 @@ Examples:


```

8 changes: 6 additions & 2 deletions docs/cli/references/batch/remote.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
| `-n` | Alias for -namespace. | |
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |


Expand All @@ -40,8 +41,10 @@ Usage of 'src batch remote':
Alias for -namespace.
-namespace string
The user or organization namespace to place the batch change within. Default is the currently authenticated user.
-skip-errors
If true, errors encountered won't stop the program, but only log them.
-trace
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
-user-agent-telemetry
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
'src batch remote' runs a batch spec on the Sourcegraph instance.
Expand All @@ -58,3 +61,4 @@ Examples:


```

8 changes: 6 additions & 2 deletions docs/cli/references/batch/repositories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |


Expand All @@ -31,8 +32,10 @@ Usage of 'src batch repositories':
Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
-insecure-skip-verify
Skip validation of TLS certificates against trusted chains
-skip-errors
If true, errors encountered won't stop the program, but only log them.
-trace
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
-user-agent-telemetry
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)

Expand All @@ -52,3 +55,4 @@ Examples:


```

8 changes: 6 additions & 2 deletions docs/cli/references/batch/validate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |


Expand All @@ -31,8 +32,10 @@ Usage of 'src batch validate':
Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
-insecure-skip-verify
Skip validation of TLS certificates against trusted chains
-skip-errors
If true, errors encountered won't stop the program, but only log them.
-trace
Log the trace ID for requests. See https://sourcegraph.com/docs/admin/observability/tracing
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
-user-agent-telemetry
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)

Expand All @@ -51,3 +54,4 @@ Examples:


```

Loading