root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

KAFKA-14933: Document Connect's log level REST APIs from KIP-495 (#13636) 

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Manyanda Chitimbo <manyanda.chitimbo@gmail.com>
This commit is contained in:
Yash Mayya 2023-04-25 21:20:35 +05:30 committed by GitHub
parent ea540fa400
commit 4780dc773f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
connect/runtime/src/main/java/org/apache/kafka/connect/runtime/rest/resources/LoggingResource.java
View File

@ -128,7 +128,7 @@ public class LoggingResource implements ConnectResource {
*/
@PUT
@Path("/{logger}")
@Operation(summary = "Set the level for the specified logger")
@Operation(summary = "Set the log level for the specified logger")
public Response setLevel(final @PathParam("logger") String namedLogger,
final Map<String, String> levelMap) {
String desiredLevelStr = levelMap.get("level");

20
docs/connect.html
View File

@ -328,7 +328,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>