You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by ce...@apache.org on 2023/05/02 17:57:57 UTC
[kafka-site] branch asf-site updated: Port KAFKA-14933 (Connect admin REST API)
This is an automated email from the ASF dual-hosted git repository.
cegerton pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/kafka-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 262566e4 Port KAFKA-14933 (Connect admin REST API)
262566e4 is described below
commit 262566e4a95e575b6f65866250b53add8ffd392e
Author: Chris Egerton <ch...@aiven.io>
AuthorDate: Tue May 2 13:57:19 2023 -0400
Port KAFKA-14933 (Connect admin REST API)
---
24/connect.html | 18 ++++++++++++++++++
25/connect.html | 18 ++++++++++++++++++
26/connect.html | 18 ++++++++++++++++++
27/connect.html | 18 ++++++++++++++++++
28/connect.html | 18 ++++++++++++++++++
30/connect.html | 18 ++++++++++++++++++
31/connect.html | 18 ++++++++++++++++++
32/connect.html | 18 ++++++++++++++++++
33/connect.html | 20 +++++++++++++++++++-
34/connect.html | 20 +++++++++++++++++++-
10 files changed, 182 insertions(+), 2 deletions(-)
diff --git a/24/connect.html b/24/connect.html
index d3f75c9a..4c07b3aa 100644
--- a/24/connect.html
+++ b/24/connect.html
@@ -241,6 +241,24 @@
<li><code>PUT /connector-plugins/{connector-type}/config/validate</code> - validate the provided configuration values against the configuration definition. This API performs per config validation, returns suggested values and error messages during validation.</li>
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h3><a id="connect_development" href="#connect_development">8.3 Connector Development Guide</a></h3>
<p>This guide describes how developers can write new connectors for Kafka Connect to move data between Kafka and other systems. It briefly reviews a few key concepts and then describes how to create a simple connector.</p>
diff --git a/25/connect.html b/25/connect.html
index ceb25d85..eea70cd2 100644
--- a/25/connect.html
+++ b/25/connect.html
@@ -262,6 +262,24 @@
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h3 class="anchor-heading">
<a class="anchor-link" id="connect_development" href="#connect_development"></a>
<a href="#connect_development">8.3 Connector Development Guide
diff --git a/26/connect.html b/26/connect.html
index a0b129e9..71e27be4 100644
--- a/26/connect.html
+++ b/26/connect.html
@@ -309,6 +309,24 @@
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h4 class="anchor-heading"><a id="connect_errorreporting" class="anchor-link"></a><a href="#connect_errorreporting">Error Reporting in Connect</a></h4>
<p>Kafka Connect provides error reporting to handle errors encountered along various stages of processing. By default, any error encountered during conversion or within transformations will cause the connector to fail. Each connector configuration can also enable tolerating such errors by skipping them, optionally writing each error and the details of the failed operation and problematic record (with various levels of detail) to the Connect application log. These mechanisms also capt [...]
diff --git a/27/connect.html b/27/connect.html
index 797c1fe9..645d5a4e 100644
--- a/27/connect.html
+++ b/27/connect.html
@@ -327,6 +327,24 @@
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h4><a id="connect_errorreporting" href="#connect_errorreporting">Error Reporting in Connect</a></h4>
<p>Kafka Connect provides error reporting to handle errors encountered along various stages of processing. By default, any error encountered during conversion or within transformations will cause the connector to fail. Each connector configuration can also enable tolerating such errors by skipping them, optionally writing each error and the details of the failed operation and problematic record (with various levels of detail) to the Connect application log. These mechanisms also capt [...]
diff --git a/28/connect.html b/28/connect.html
index ef4cfe96..b473211f 100644
--- a/28/connect.html
+++ b/28/connect.html
@@ -327,6 +327,24 @@
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h4><a id="connect_errorreporting" href="#connect_errorreporting">Error Reporting in Connect</a></h4>
<p>Kafka Connect provides error reporting to handle errors encountered along various stages of processing. By default, any error encountered during conversion or within transformations will cause the connector to fail. Each connector configuration can also enable tolerating such errors by skipping them, optionally writing each error and the details of the failed operation and problematic record (with various levels of detail) to the Connect application log. These mechanisms also capt [...]
diff --git a/30/connect.html b/30/connect.html
index 07f8778f..579ac7ea 100644
--- a/30/connect.html
+++ b/30/connect.html
@@ -335,6 +335,24 @@
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h4><a id="connect_errorreporting" href="#connect_errorreporting">Error Reporting in Connect</a></h4>
<p>Kafka Connect provides error reporting to handle errors encountered along various stages of processing. By default, any error encountered during conversion or within transformations will cause the connector to fail. Each connector configuration can also enable tolerating such errors by skipping them, optionally writing each error and the details of the failed operation and problematic record (with various levels of detail) to the Connect application log. These mechanisms also capt [...]
diff --git a/31/connect.html b/31/connect.html
index f1b4da15..2fc38ad2 100644
--- a/31/connect.html
+++ b/31/connect.html
@@ -336,6 +336,24 @@
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h4><a id="connect_errorreporting" href="#connect_errorreporting">Error Reporting in Connect</a></h4>
<p>Kafka Connect provides error reporting to handle errors encountered along various stages of processing. By default, any error encountered during conversion or within transformations will cause the connector to fail. Each connector configuration can also enable tolerating such errors by skipping them, optionally writing each error and the details of the failed operation and problematic record (with various levels of detail) to the Connect application log. These mechanisms also capt [...]
diff --git a/32/connect.html b/32/connect.html
index 1251c3ce..d5f7e4d6 100644
--- a/32/connect.html
+++ b/32/connect.html
@@ -327,6 +327,24 @@ listeners=http://localhost:8080,https://localhost:8443</pre>
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
<h4><a id="connect_errorreporting" href="#connect_errorreporting">Error Reporting in Connect</a></h4>
<p>Kafka Connect provides error reporting to handle errors encountered along various stages of processing. By default, any error encountered during conversion or within transformations will cause the connector to fail. Each connector configuration can also enable tolerating such errors by skipping them, optionally writing each error and the details of the failed operation and problematic record (with various levels of detail) to the Connect application log. These mechanisms also capt [...]
diff --git a/33/connect.html b/33/connect.html
index 05a1ddda..c0ffde62 100644
--- a/33/connect.html
+++ b/33/connect.html
@@ -327,7 +327,25 @@ listeners=http://localhost:8080,https://localhost:8443</pre>
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
- <p>For the complete specification of the REST API, see the <a href="/{{version}}/generated/connect_rest.yaml">OpenAPI documentation</a></p>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
+ <p>For the complete specification of the Kafka Connect REST API, see the <a href="/{{version}}/generated/connect_rest.yaml">OpenAPI documentation</a></p>
<h4><a id="connect_errorreporting" href="#connect_errorreporting">Error Reporting in Connect</a></h4>
diff --git a/34/connect.html b/34/connect.html
index 4c9a8d97..aac6d468 100644
--- a/34/connect.html
+++ b/34/connect.html
@@ -327,7 +327,25 @@ listeners=http://localhost:8080,https://localhost:8443</pre>
<li><code>GET /</code>- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
</ul>
- <p>For the complete specification of the REST API, see the <a href="/{{version}}/generated/connect_rest.yaml">OpenAPI documentation</a></p>
+ <p>The <code>admin.listeners</code> configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the <code>listeners</code> configuration, this field should contain a list of listeners in the following format: <code>protocol://host:port,protocol2://host2:port2</code>. Currently supported protocols are <code>http</code> and <code>https</code>.
+ For example:</p>
+
+ <pre class="brush: text;">
+admin.listeners=http://localhost:8080,https://localhost:8443</pre>
+
+ <p>By default, if <code>admin.listeners</code> is not configured, the admin REST APIs will be available on the regular listeners.</p>
+
+ <p>The following are the currently supported admin REST API endpoints:</p>
+
+ <ul>
+ <li><code>GET /admin/loggers</code> - list the current loggers that have their levels explicitly set and their log levels</li>
+ <li><code>GET /admin/loggers/{name}</code> - get the log level for the specified logger</li>
+ <li><code>PUT /admin/loggers/{name}</code> - set the log level for the specified logger</li>
+ </ul>
+
+ <p>See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-495%3A+Dynamically+Adjust+Log+Levels+in+Connect">KIP-495</a> for more details about the admin logger REST APIs.</p>
+
+ <p>For the complete specification of the Kafka Connect REST API, see the <a href="/{{version}}/generated/connect_rest.yaml">OpenAPI documentation</a></p>
<h4><a id="connect_errorreporting" href="#connect_errorreporting">Error Reporting in Connect</a></h4>