Merge #129946

129946: changefeedccl: update changefeed.sink_io_workers description r=wenyihu6 a=rharding6373

Include pubsub and kafka v2 in supported sinks.

Epic: CRDB-41784
Fixes: #127362

Release note (enterprise change): Updates the cluster setting `changefeed.sink_io_workers` with all the sinks that support the setting.

Co-authored-by: rharding6373 <[email protected]>

Author: craig[bot]

docs/generated/settings/settings-for-tenants.txt

@@ -24,7 +24,7 @@ changefeed.node_throttle_config	string		specifies node level throttling configur
 changefeed.protect_timestamp.max_age	duration	96h0m0s	fail the changefeed if the protected timestamp age exceeds this threshold; 0 disables expiration	application
 changefeed.protect_timestamp_interval	duration	10m0s	controls how often the changefeed forwards its protected timestamp to the resolved timestamp	application
 changefeed.schema_feed.read_with_priority_after	duration	1m0s	retry with high priority if we were not able to read descriptors for too long; 0 disables	application
-changefeed.sink_io_workers	integer	0	the number of workers used by changefeeds when sending requests to the sink (currently webhook only): <0 disables, 0 assigns a reasonable default, >0 assigns the setting value	application
+changefeed.sink_io_workers	integer	0	the number of workers used by changefeeds when sending requests to the sink (currently the batching versions of webhook, pubsub, and kafka sinks that are enabled by changefeed.new_<sink type>_sink_enabled only): <0 disables, 0 assigns a reasonable default, >0 assigns the setting value	application
 cloudstorage.azure.concurrent_upload_buffers	integer	1	controls the number of concurrent buffers that will be used by the Azure client when uploading chunks.Each buffer can buffer up to cloudstorage.write_chunk.size of memory during an upload	application
 cloudstorage.azure.read.node_burst_limit	byte size	0 B	burst limit on number of bytes per second per node across operations writing to the designated cloud storage provider if non-zero	application
 cloudstorage.azure.read.node_rate_limit	byte size	0 B	limit on number of bytes per second per node across operations writing to the designated cloud storage provider if non-zero	application

docs/generated/settings/settings.html

@@ -29,7 +29,7 @@
 <tr><td><div id="setting-changefeed-protect-timestamp-max-age" class="anchored"><code>changefeed.protect_timestamp.max_age</code></div></td><td>duration</td><td><code>96h0m0s</code></td><td>fail the changefeed if the protected timestamp age exceeds this threshold; 0 disables expiration</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
 <tr><td><div id="setting-changefeed-protect-timestamp-interval" class="anchored"><code>changefeed.protect_timestamp_interval</code></div></td><td>duration</td><td><code>10m0s</code></td><td>controls how often the changefeed forwards its protected timestamp to the resolved timestamp</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
 <tr><td><div id="setting-changefeed-schema-feed-read-with-priority-after" class="anchored"><code>changefeed.schema_feed.read_with_priority_after</code></div></td><td>duration</td><td><code>1m0s</code></td><td>retry with high priority if we were not able to read descriptors for too long; 0 disables</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
-<tr><td><div id="setting-changefeed-sink-io-workers" class="anchored"><code>changefeed.sink_io_workers</code></div></td><td>integer</td><td><code>0</code></td><td>the number of workers used by changefeeds when sending requests to the sink (currently webhook only): &lt;0 disables, 0 assigns a reasonable default, &gt;0 assigns the setting value</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
+<tr><td><div id="setting-changefeed-sink-io-workers" class="anchored"><code>changefeed.sink_io_workers</code></div></td><td>integer</td><td><code>0</code></td><td>the number of workers used by changefeeds when sending requests to the sink (currently the batching versions of webhook, pubsub, and kafka sinks that are enabled by changefeed.new_&lt;sink type&gt;_sink_enabled only): &lt;0 disables, 0 assigns a reasonable default, &gt;0 assigns the setting value</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
 <tr><td><div id="setting-cloudstorage-azure-concurrent-upload-buffers" class="anchored"><code>cloudstorage.azure.concurrent_upload_buffers</code></div></td><td>integer</td><td><code>1</code></td><td>controls the number of concurrent buffers that will be used by the Azure client when uploading chunks.Each buffer can buffer up to cloudstorage.write_chunk.size of memory during an upload</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
 <tr><td><div id="setting-cloudstorage-azure-read-node-burst-limit" class="anchored"><code>cloudstorage.azure.read.node_burst_limit</code></div></td><td>byte size</td><td><code>0 B</code></td><td>burst limit on number of bytes per second per node across operations writing to the designated cloud storage provider if non-zero</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
 <tr><td><div id="setting-cloudstorage-azure-read-node-rate-limit" class="anchored"><code>cloudstorage.azure.read.node_rate_limit</code></div></td><td>byte size</td><td><code>0 B</code></td><td>limit on number of bytes per second per node across operations writing to the designated cloud storage provider if non-zero</td><td>Serverless/Dedicated/Self-Hosted</td></tr>

pkg/ccl/changefeedccl/changefeedbase/settings.go

@@ -291,7 +291,9 @@ var SinkIOWorkers = settings.RegisterIntSetting(
 	settings.ApplicationLevel,
 	"changefeed.sink_io_workers",
 	"the number of workers used by changefeeds when sending requests to the sink "+
-		"(currently webhook only): <0 disables, 0 assigns a reasonable default, >0 assigns the setting value",
+		"(currently the batching versions of webhook, pubsub, and kafka sinks that are "+
+		"enabled by changefeed.new_<sink type>_sink_enabled only): <0 disables, 0 assigns "+
+		"a reasonable default, >0 assigns the setting value",
 	0,
 	settings.WithPublic)