Skip to content

docs(code-monitoring): add Advanced section on result limit, timeout, and site config #2121

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.

Sign up for GitHub

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

Open
marcleblanc2 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(code-monitoring): add Advanced section on result limit, timeout, and site config #2121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27ffc56
docs(code-monitoring): add Advanced section on result limit, timeout,…
marcleblanc2 Oct 31, 2026
ef70172
Add jobutil to cspell-allow-list.txt
github-actions[bot] Oct 31, 2026
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
1 change: 1 addition & 0 deletions cspell-allow-list.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@ Jaccard
JCEF
jiapantw
jiti
jobutil
journalctl
Jsonnet
jsonschemadoc
Expand Down
19 changes: 19 additions & 0 deletions docs/code-monitoring/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,22 @@ Code monitors have been designed to be performant even for large Sourcegraph ins
## Architecture

Learn about how Code Monitoring fits into Sourcegraph in the [architecture overview](/admin/architecture#code-monitoring).

## Advanced

### Result limit and timeout

Each run of a code monitor is a regular search, with the same result limit and timeout as a search from the search bar. When a run reaches either limit, it stops and notifies you about the results found so far; commits it did not reach are not searched again on the next run. Set these in the monitor's query:

- [`count:`](/code-search/queries/language#count): the maximum number of results per run. Default: 10,000.
- [`timeout:`](/code-search/queries/language#timeout): how long a run may search. Default: 20 seconds. A query with `count:` but no `timeout:` uses the maximum timeout.

For example, `repo:^github\.example\.com/ type:diff TODO count:50000 timeout:120s`.

Email and Slack notifications show the total number of new results and the first 5; webhook notifications include every result.

### Site configuration

The `codeMonitors` object in [advanced configuration](/admin/config/site-config#reference) controls the worker that runs code monitors: `pollInterval` is how often each monitor runs, `concurrency` is how many monitor jobs run at once, and `maxRuntime` is how long a job may run before it is stopped. Raise `maxRuntime` with `timeout:`, so the job is not stopped before its search finishes.

`timeout:` cannot exceed the instance's [maximum search timeout](/admin/search#maximum-timeout).
Loading