Skip to content

KAFKA-14933: Document Kafka Connect's log level REST APIs added in KIP-495 #13636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mimaison merged 1 commit into from
Apr 25, 2023
+20 −2
Merged

KAFKA-14933: Document Kafka Connect's log level REST APIs added in KIP-495 #13636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...untime/src/main/java/org/apache/kafka/connect/runtime/rest/resources/LoggingResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Copy link
Copy Markdown
Contributor

@machi1990 machi1990 Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch!

public Response setLevel(final @PathParam("logger") String namedLogger,
final Map<String, String> levelMap) {
String desiredLevelStr = levelMap.get("level");
Expand Down
20 changes: 19 additions & 1 deletion docs/connect.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,25 @@ <h4><a id="connect_rest" href="#connect_rest">REST API</a></h4>
<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>
Copy link
Copy Markdown
Contributor

@machi1990 machi1990 Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we add a note that, this only works with when log4j 1.x is used to log messages and is available on classpath and other loggers won't work, WDYT?

Copy link
Copy Markdown
Contributor Author

@yashmayya yashmayya Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the other REST APIs documented in https://kafka.apache.org/documentation/#connect_rest also seem to have a pretty brief description, so that's the pattern I followed. I made sure to include the reference to KIP-495 so that some of the finer details and limitations would be easily accessible. Also, since log4j 1.x is what is shipped by default in AK and is also on the classpath for Connect workers by default, I don't think we really need to call it out as an explicit limitation in the public documentation.

Copy link
Copy Markdown
Contributor

@machi1990 machi1990 Apr 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the reply @yashmayya . What you said makes sense!


<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>

Expand Down