kirktrue commented on code in PR #14566: URL: https://github.com/apache/kafka/pull/14566#discussion_r1364347784
########## clients/src/main/java/org/apache/kafka/common/telemetry/ClientTelemetryState.java: ########## @@ -0,0 +1,166 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.kafka.common.telemetry; + +import org.apache.kafka.common.utils.Utils; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumMap; +import java.util.List; +import java.util.Map; + +/** + * State that helps determine where client exists in the telemetry state i.e. subscribe->wait->push loop. + */ +public enum ClientTelemetryState { + + /** + * Client needs subscription from the broker. + */ + SUBSCRIPTION_NEEDED, + + /** + * Network I/O is in progress to retrieve subscription. + */ + SUBSCRIPTION_IN_PROGRESS, + + /** + * Awaiting telemetry interval for pushing metrics to broker. + */ + PUSH_NEEDED, Review Comment: I always felt that the state `PUSH_NEEDED` was a bit confusing and conflated two different states. Currently, the state transitions is: > `SUBSCRIPTION_IN_PROGRESS`→`PUSH_NEEDED` My brain kind of wants it to be more like this: > `SUBSCRIPTION_IN_PROGRESS`→`CALMLY_COLLECTING_METRICS`→`PUSH_NEEDED` The `CALMLY_COLLECTING_METRICS` state is one of tranquil respite from the laborious grind of subscription lookup and telemetry pushing. It's the stable state between receiving the subscription set and waiting for the telemetry push interval to elapse. We would transition from `CALMLY_COLLECTING_METRICS` to `PUSH_NEEDED` once the push interval has passed and we need to prepare to send the data to the broker. I guess the idea of going directly from `SUBSCRIPTION_IN_PROGRESS` to `PUSH_NEEDED` just makes me feel rushed 🏃♂️ ########## clients/src/main/java/org/apache/kafka/common/telemetry/ClientTelemetryState.java: ########## @@ -0,0 +1,166 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.kafka.common.telemetry; + +import org.apache.kafka.common.utils.Utils; + +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumMap; +import java.util.List; +import java.util.Map; + +/** + * State that helps determine where client exists in the telemetry state i.e. subscribe->wait->push loop. + */ +public enum ClientTelemetryState { + + /** + * Client needs subscription from the broker. + */ + SUBSCRIPTION_NEEDED, + + /** + * Network I/O is in progress to retrieve subscription. + */ + SUBSCRIPTION_IN_PROGRESS, + + /** + * Awaiting telemetry interval for pushing metrics to broker. + */ + PUSH_NEEDED, Review Comment: I always felt that the state `PUSH_NEEDED` was a bit confusing and conflated two different states. Currently, the state transitions is: > `SUBSCRIPTION_IN_PROGRESS`→`PUSH_NEEDED` My brain kind of wants it to be more like this: > `SUBSCRIPTION_IN_PROGRESS`→`CALMLY_COLLECTING_METRICS`→`PUSH_NEEDED` The `CALMLY_COLLECTING_METRICS` state is one of tranquil respite from the laborious grind of subscription lookup and telemetry pushing. It's the stable state between receiving the subscription set and waiting for the telemetry push interval to elapse. We would transition from `CALMLY_COLLECTING_METRICS` to `PUSH_NEEDED` once the push interval has passed and we need to prepare to send the data to the broker. I guess the idea of going directly from `SUBSCRIPTION_IN_PROGRESS` to `PUSH_NEEDED` just makes me feel rushed 🏃♂️ -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
