AndrewJSchofield commented on code in PR #14684:
URL: https://github.com/apache/kafka/pull/14684#discussion_r1378645692
##########
clients/src/main/java/org/apache/kafka/server/telemetry/ClientTelemetryPayload.java:
##########
@@ -22,31 +22,37 @@
import java.nio.ByteBuffer;
+/**
+ * A client telemetry payload as sent by the client to the telemetry receiver.
The payload is
+ * received by the broker's {@link ClientTelemetryReceiver} implementation.
+ */
@InterfaceStability.Evolving
public interface ClientTelemetryPayload {
/**
+ * Method returns the client's instance id.
+ *
* @return Client's instance id.
*/
Uuid clientInstanceId();
/**
* Indicates whether client is terminating, e.g., the last metrics push
from this client instance.
- * <p>
- *To avoid the receiving broker’s metrics rate-limiter discarding this
out-of-profile push, the
- * PushTelemetryRequest.Terminating field must be set to true. A broker
must only allow one such
- * unthrottled metrics push for each combination of client instance ID and
SubscriptionId.
*
* @return {@code true} if client is terminating, else false
*/
boolean isTerminating();
/**
+ * Method returns the content-typ format of the metrics data which is
being sent by the client.
Review Comment:
Typo. Should be `content-type`.
##########
clients/src/main/java/org/apache/kafka/server/telemetry/ClientTelemetryPayload.java:
##########
@@ -22,31 +22,37 @@
import java.nio.ByteBuffer;
+/**
+ * A client telemetry payload as sent by the client to the telemetry receiver.
The payload is
+ * received by the broker's {@link ClientTelemetryReceiver} implementation.
+ */
@InterfaceStability.Evolving
public interface ClientTelemetryPayload {
/**
+ * Method returns the client's instance id.
+ *
* @return Client's instance id.
*/
Uuid clientInstanceId();
/**
* Indicates whether client is terminating, e.g., the last metrics push
from this client instance.
Review Comment:
"Indicates whether the client is terminating and thus making its last
metrics push."
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
