From 176a33f2d66ca3acf78019e993ba8a94348f0251 Mon Sep 17 00:00:00 2001 From: Yash Mayya Date: Tue, 25 Apr 2023 14:08:59 +0530 Subject: [PATCH] KAFKA-14933: Document Kafka Connect's log level REST APIs added in KIP-495 --- .../rest/resources/LoggingResource.java | 2 +- docs/connect.html | 20 ++++++++++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/rest/resources/LoggingResource.java b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/rest/resources/LoggingResource.java index 1b31c51c36b4b..812cf696563cc 100644 --- a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/rest/resources/LoggingResource.java +++ b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/rest/resources/LoggingResource.java @@ -128,7 +128,7 @@ public Response getLogger(final @PathParam("logger") String namedLogger) { */ @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 levelMap) { String desiredLevelStr = levelMap.get("level"); diff --git a/docs/connect.html b/docs/connect.html index 75fc2662d097c..b947bea3832a2 100644 --- a/docs/connect.html +++ b/docs/connect.html @@ -328,7 +328,25 @@

REST API

  • GET /- 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. -

    For the complete specification of the REST API, see the OpenAPI documentation

    +

    The admin.listeners configuration can be used to configure admin REST APIs on Kafka Connect's REST API server. Similar to the listeners configuration, this field should contain a list of listeners in the following format: protocol://host:port,protocol2://host2:port2. Currently supported protocols are http and https. + For example:

    + +
    +admin.listeners=http://localhost:8080,https://localhost:8443
    + +

    By default, if admin.listeners is not configured, the admin REST APIs will be available on the regular listeners.

    + +

    The following are the currently supported admin REST API endpoints:

    + +
      +
    • GET /admin/loggers - list the current loggers that have their levels explicitly set and their log levels
    • +
    • GET /admin/loggers/{name} - get the log level for the specified logger
    • +
    • PUT /admin/loggers/{name} - set the log level for the specified logger
    • +
    + +

    See KIP-495 for more details about the admin logger REST APIs.

    + +

    For the complete specification of the Kafka Connect REST API, see the OpenAPI documentation

    Error Reporting in Connect