[kafka] branch trunk updated: MINOR: Correct Connect docs on connector/task states (#11914)

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mimaison pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new b9fc893546 MINOR: Correct Connect docs on connector/task states (#11914)
b9fc893546 is described below

commit b9fc8935468e3eaa0385d35e2892d9df228701ec
Author: Chris Egerton <fe...@gmail.com>
AuthorDate: Wed Apr 13 06:51:34 2022 -0400

    MINOR: Correct Connect docs on connector/task states (#11914)
    
    The `DESTROYED` state is represented internally as a tombstone record when running in distributed mode and by the removal of the connector/task from the in-memory status map when running in standalone mode. As a result, it will never appear to users of the REST API, and we should remove mention of it from our docs so that developers creating tooling against the REST API don't write unnecessary logic to account for that state.
    
    Reviewers: Mickael Maison <mi...@gmail.com>
---
 .../java/org/apache/kafka/connect/runtime/ConnectMetricsRegistry.java | 4 ++--
 docs/connect.html                                                     | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectMetricsRegistry.java b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectMetricsRegistry.java
index f301439da8..d8579d44fc 100644
--- a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectMetricsRegistry.java
+++ b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectMetricsRegistry.java
@@ -129,7 +129,7 @@ public class ConnectMetricsRegistry {
 
         connectorStatus = createTemplate("status", CONNECTOR_GROUP_NAME,
                                          "The status of the connector. One of 'unassigned', 'running', 'paused', 'failed', or " +
-                                         "'destroyed'.",
+                                         "'restarting'.",
                                          connectorTags);
         connectorType = createTemplate("connector-type", CONNECTOR_GROUP_NAME, "The type of the connector. One of 'source' or 'sink'.",
                                        connectorTags);
@@ -144,7 +144,7 @@ public class ConnectMetricsRegistry {
 
         taskStatus = createTemplate("status", TASK_GROUP_NAME,
                                     "The status of the connector task. One of 'unassigned', 'running', 'paused', 'failed', or " +
-                                    "'destroyed'.",
+                                    "'restarting'.",
                                     workerTaskTags);
         taskRunningRatio = createTemplate("running-ratio", TASK_GROUP_NAME,
                                           "The fraction of time this task has spent in the running state.", workerTaskTags);
diff --git a/docs/connect.html b/docs/connect.html
index 1251c3ce68..be6a2ac461 100644
--- a/docs/connect.html
+++ b/docs/connect.html
@@ -711,7 +711,7 @@ Struct struct = new Struct(schema)
     <li><b>RUNNING:</b> The connector/task is running.</li>
     <li><b>PAUSED:</b> The connector/task has been administratively paused.</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>DESTROYED:</b> The connector/task has been administratively removed and will stop appearing in the Connect cluster.</li>
+    <li><b>RESTARTING:</b> The connector/task is either actively restarting or is expected to restart soon</li>
     </ul>
 
     <p>