Skip to content

Document the ServiceControl QueryTimeoutInSeconds settings #8486

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

Merged
ramonsmits merged 5 commits into from
Sep 10, 2026
Merged

Document the ServiceControl QueryTimeoutInSeconds settings #8486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
292cf3d
📝 Document ServiceControl.Audit/QueryTimeoutInSeconds setting
ramonsmits Aug 31, 2026
236c9dc
📝 Document ServiceControl/QueryTimeoutInSeconds setting
ramonsmits Aug 31, 2026
0a6bb9f
📝 Query timeout default is 1 minute
ramonsmits Sep 3, 2026
c3bd3b6
📝 Query timeout answers with 504 and partial composite results
ramonsmits Sep 4, 2026
079bc64
📝 The error instance's query time limit bounds the composite
ramonsmits Sep 7, 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
19 changes: 19 additions & 0 deletions servicecontrol/audit-instances/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -881,6 +881,25 @@ Configures the maximum duration, in seconds, for processing a batch of audited m
| --- | --- |
| int | `60` (1 minute) |

#end-if

#if-version [6.20,)
### ServiceControl.Audit/QueryTimeoutInSeconds

Configures the maximum duration, in seconds, that an audit message query (for example a message search or a conversation lookup issued by ServicePulse or ServiceInsight) is allowed to run before it is cancelled. This protects the RavenDB server from queries over very large data sets that would otherwise run for a long time and consume large amounts of temporary disk space. Values larger than one hour fall back to the default.

A query that runs out of its allowed time is answered with HTTP status `504 Gateway Timeout` and a problem details body that names this setting. The error instance treats that answer as a missing instance rather than as an instance with no data. How long the error instance waits for an audit instance is bounded by its own [`ServiceControl/QueryTimeoutInSeconds`](/servicecontrol/servicecontrol-instances/configuration.md#performance-tuning-servicecontrol-querytimeoutinseconds), independently of this value.

| Context | Name |
| --- | --- |
| **Environment variable** | `SERVICECONTROL_AUDIT_QUERYTIMEOUTINSECONDS` |
| **App config key** | `ServiceControl.Audit/QueryTimeoutInSeconds` |
| **SCMU field** | N/A |

| Type | Default value |
| --- | --- |
| int | `60` (1 minute) |

#end-if
## Transport

Expand Down
23 changes: 23 additions & 0 deletions servicecontrol/servicecontrol-instances/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,6 +976,29 @@ Use this setting to configure whether the bodies of processed error messages sho
> [!NOTE]
> Changing the full-text search setting will cause indexes to be redeployed and rebuilt. Depending on the number of documents stored, this operation might take a long time and search results won't be available until completed.

#if-version [6.20,)
### ServiceControl/QueryTimeoutInSeconds

Configures the maximum duration, in seconds, that a failed message view query (for example a message search or a conversation lookup issued by ServicePulse or ServiceInsight) is allowed to run before it is cancelled. This protects the database server from queries over very large data sets that would otherwise run for a long time and consume large amounts of temporary disk space. Values larger than one hour fall back to the default. Applies to all persisters. On the SQL Server and PostgreSQL persisters the database commands issued by these queries use this value as their command timeout, so `Database/CommandTimeout` does not apply to them.

A query that runs out of its allowed time is answered with HTTP status `504 Gateway Timeout` and a problem details body that names this setting.

When the instance gathers a message view from its own database and the configured [audit instances](/servicecontrol/audit-instances/), a timed-out or unreachable instance does not fail the request. The response contains the data of the instances that did answer, carries no `ETag`, and lists the missing instances in the `X-Particular-Incomplete-Results` header as `instanceId:reason` entries, where the reason is `timeout`, `unavailable` or `error`. Only when no instance answered and at least one of them timed out is the request answered with `504 Gateway Timeout`.

The instance waits for an audit instance's answer for at most this duration, so it also bounds the whole query when an audit instance is slow, unresponsive, or configured with a larger `ServiceControl.Audit/QueryTimeoutInSeconds`. An audit instance that has not answered in time is reported as missing; its own limit still ends the query on its side.

| Context | Name |
| --- | --- |
| **Environment variable** | `SERVICECONTROL_QUERYTIMEOUTINSECONDS` |
| **App config key** | `ServiceControl/QueryTimeoutInSeconds` |
| **SCMU field** | N/A |

| Type | Default value |
| --- | --- |
| int | `60` (1 minute) |

#end-if

## Transport

### ServiceControl/TransportType
Expand Down