Skip to content
Open
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
2 changes: 1 addition & 1 deletion src/current/v24.1/admission-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ COMMIT;

## Considerations

To prevent unnecessary queuing in admission control CPU queues, set the `goschedstats.always_use_short_sample_period.enabled` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) to `true` for any production cluster.
To prevent unnecessary queuing in admission control CPU queues, set the `goschedstats.always_use_short_sample_period.enabled` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#setting-goschedstats-always-use-short-sample-period-enabled) to `true` for any [production cluster]({% link {{ page.version.version }}/recommended-production-settings.md %}).

[Client connections]({% link {{ page.version.version }}/connection-parameters.md %}) are not managed by the admission control subsystem. Too many connections per [gateway node]({% link {{ page.version.version }}/architecture/sql-layer.md %}#gateway-node) can also lead to cluster overload.

Expand Down
12 changes: 12 additions & 0 deletions src/current/v24.1/cluster-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ These cluster settings have a broad impact on CockroachDB internals and affect a

{% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/{{ page.release_info.crdb_branch_name }}/docs/generated/settings/settings.html %}

<a name="setting-goschedstats-always-use-short-sample-period-enabled"></a>

<table>
<tr>
<td><code>goschedstats.always_use_short_sample_period.enabled</code></td>
<td>boolean</td>
<td>false</td>
<td>When set to true, the system uses a shorter sampling period of runnable queue lengths. This setting should always be enabled for <a href="recommended-production-settings.html">production clusters</a> to help prevent unnecessary queuing in the <a href="admission-control.html">admission control</a> subsystem.</td>
<td>Advanced/Self-Hosted</td>
</tr>
</table>

## View current cluster settings

Use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) statement.
Expand Down
6 changes: 6 additions & 0 deletions src/current/v24.1/recommended-production-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ Existing deployments that have THP enabled using the `always` option should chan

The method for permanently changing the THP setting across reboots depends on the operating system. For Red Hat Enterprise Linux, refer to the [Red Hat documentation](https://access.redhat.com/solutions/46111).

## Cluster settings

This section lists cluster setting changes that are recommended for production deployments:

- To prevent unnecessary queuing in [admission control]({% link {{ page.version.version }}/admission-control.md %}) CPU queues, set the `goschedstats.always_use_short_sample_period.enabled` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#setting-goschedstats-always-use-short-sample-period-enabled) to `true` for any production cluster.

## Hardware

{% include {{ page.version.version }}/prod-deployment/terminology-vcpu.md %}
Expand Down
Loading