This is an automated email from the ASF dual-hosted git repository.
cegerton pushed a commit to branch 3.5
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/3.5 by this push:
new b8cf3e31747 KAFKA-14876: Add stopped state to Kafka Connect
Administration docs section (#14336)
b8cf3e31747 is described below
commit b8cf3e31747f7193024c36f3381c0dd5bd22158c
Author: Chris Egerton <chr...@aiven.io>
AuthorDate: Tue Sep 5 14:46:37 2023 -0400
KAFKA-14876: Add stopped state to Kafka Connect Administration docs section
(#14336)
Original author (before modifications for backporting: Yash Mayya
<yash.ma...@gmail.com>
Reviewers: Chris Egerton <chr...@aiven.io>
---
docs/connect.html | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/connect.html b/docs/connect.html
index 5a053e4a0dc..40213ad3003 100644
--- a/docs/connect.html
+++ b/docs/connect.html
@@ -934,6 +934,7 @@ Struct struct = new Struct(schema)
<li><b>UNASSIGNED:</b> The connector/task has not yet been assigned to a
worker.</li>
<li><b>RUNNING:</b> The connector/task is running.</li>
<li><b>PAUSED:</b> The connector/task has been administratively
paused.</li>
+ <li><b>STOPPED:</b> The connector has been stopped. Note that this state
is not applicable to tasks because the tasks for a stopped connector are shut
down and won't be visible in the status API.</li>
<li><b>FAILED:</b> The connector/task has failed (usually by raising an
exception, which is reported in the status output).</li>
<li><b>RESTARTING:</b> The connector/task is either actively restarting or
is expected to restart soon</li>
</ul>
@@ -949,6 +950,10 @@ Struct struct = new Struct(schema)
<p>
It's sometimes useful to temporarily stop the message processing of a
connector. For example, if the remote system is undergoing maintenance, it
would be preferable for source connectors to stop polling it for new data
instead of filling logs with exception spam. For this use case, Connect offers
a pause/resume API. While a source connector is paused, Connect will stop
polling it for additional records. While a sink connector is paused, Connect
will stop pushing new messages to it. T [...]
</p>
+
+ <p>
+ In 3.5.0, Connect introduced a stop API that completely shuts down the
tasks for a connector and deallocates any resources claimed by them. This is
different from pausing a connector where tasks are left idling and any
resources claimed by them are left allocated (which allows the connector to
begin processing data quickly once it is resumed). Stopping a connector is more
efficient from a resource usage standpoint than pausing it, but can cause it to
take longer to begin processing d [...]
+ </p>
</script>
<div class="p-connect"></div>
