You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/05/05 07:41:25 UTC
[GitHub] [flink] fapaul opened a new pull request, #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
fapaul opened a new pull request, #19649:
URL: https://github.com/apache/flink/pull/19649
… others
<!--
*Thank you very much for contributing to Apache Flink - we are happy that you want to help us improve Flink. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes. You can set up Azure Pipelines CI to do that following [this guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message (including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
With the upgrade to Kafka 2.8, we introduced a regression in the metrics of our Kafka connector. Previously, we relied on a now deprecated and in the future removed method to forward the metrics of the `KafkaConsumer` and `KafkaProducer` to Flink's metric system. This PR implements the original logic that only measurable metrics are displayed and all other metrics are `0.0`.
## Brief change log
Check the type of the returned metric value and only cast to Double if possible.
## Verifying this change
Added a test that creates a KafkaConsumer and KafkaProducer and tried to retrieve all available metric values.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (yes / **no**)
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (yes / **no**)
- The serializers: (yes / **no** / don't know)
- The runtime per-record code paths (performance sensitive): (yes / **no** / don't know)
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / **no** / don't know)
- The S3 file system connector: (yes / **no** / don't know)
## Documentation
- Does this pull request introduce a new feature? (yes / **no**)
- If yes, how is the feature documented? (**not applicable** / docs / JavaDocs / not documented)
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] fapaul commented on pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
fapaul commented on PR #19649:
URL: https://github.com/apache/flink/pull/19649#issuecomment-1119628108
@flinkbot run azure
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] fapaul merged pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
fapaul merged PR #19649:
URL: https://github.com/apache/flink/pull/19649
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] zentol commented on a diff in pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
zentol commented on code in PR #19649:
URL: https://github.com/apache/flink/pull/19649#discussion_r865639059
##########
flink-connectors/flink-connector-kafka/src/test/java/org/apache/flink/streaming/connectors/kafka/internals/metrics/KafkaMetricsITCase.java:
##########
@@ -0,0 +1,90 @@
+/*
+ * 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.flink.streaming.connectors.kafka.internals.metrics;
+
+import org.apache.flink.util.TestLoggerExtension;
+
+import org.apache.kafka.clients.consumer.KafkaConsumer;
+import org.apache.kafka.clients.producer.KafkaProducer;
+import org.apache.kafka.common.serialization.ByteArrayDeserializer;
+import org.apache.kafka.common.serialization.ByteArraySerializer;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testcontainers.containers.KafkaContainer;
+import org.testcontainers.containers.Network;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Properties;
+import java.util.UUID;
+
+import static org.apache.flink.connector.kafka.testutils.KafkaUtil.createKafkaContainer;
+import static org.apache.flink.util.DockerImageVersions.KAFKA;
+
+@Testcontainers
+@ExtendWith(TestLoggerExtension.class)
+class KafkaMetricsITCase {
+
+ private static final Logger LOG = LoggerFactory.getLogger(KafkaMetricsITCase.class);
+ private static final String INTER_CONTAINER_KAFKA_ALIAS = "kafka";
+ private static final Network NETWORK = Network.newNetwork();
+
+ @Container
+ public static final KafkaContainer KAFKA_CONTAINER =
+ createKafkaContainer(KAFKA, LOG)
+ .withEmbeddedZookeeper()
+ .withNetwork(NETWORK)
+ .withNetworkAliases(INTER_CONTAINER_KAFKA_ALIAS);
+
+ @Test
+ void testOnlyMeasurableMetricsAreRegistered() {
+ final Collection<KafkaMetricMutableWrapper> metricWrappers = new ArrayList<>();
+ final KafkaConsumer<?, ?> consumer = new KafkaConsumer<>(getKafkaClientConfiguration());
+ final KafkaProducer<?, ?> producer = new KafkaProducer<>(getKafkaClientConfiguration());
+ consumer.metrics()
+ .forEach(
+ (name, metric) ->
+ metricWrappers.add(new KafkaMetricMutableWrapper(metric)));
+ producer.metrics()
+ .forEach(
+ (name, metric) ->
+ metricWrappers.add(new KafkaMetricMutableWrapper(metric)));
+
+ // Ensure that all values are accessible and return valid double values
+ metricWrappers.forEach(KafkaMetricMutableWrapper::getValue);
Review Comment:
We should also double-check that metricWrappers is not empty.
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] fapaul commented on pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
fapaul commented on PR #19649:
URL: https://github.com/apache/flink/pull/19649#issuecomment-1118260133
I'll backport the change to 1.14/1.15 once approved
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] zentol commented on a diff in pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
zentol commented on code in PR #19649:
URL: https://github.com/apache/flink/pull/19649#discussion_r865640970
##########
flink-connectors/flink-connector-kafka/src/main/java/org/apache/flink/streaming/connectors/kafka/internals/metrics/KafkaMetricMutableWrapper.java:
##########
@@ -34,7 +34,12 @@ public KafkaMetricMutableWrapper(Metric metric) {
@Override
public Double getValue() {
- return (Double) kafkaMetric.metricValue();
+ final Object metricValue = kafkaMetric.metricValue();
+ // Previously KafkaMetric supported KafkaMetric#value that always returned a Double value.
+ // Since this method has been deprecated and is removed in future releases we have to
+ // manually check if the returned value is Double. Internally, KafkaMetric#value also
+ // returned 0.0 for all not "measurable" values, so we restored the original behavior.
+ return metricValue instanceof Double ? (Double) metricValue : 0.0;
Review Comment:
It does restore the original behavior so I'm fine with not doing that, but we do have the option now to expose more kafka metrics.
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] fapaul commented on pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
fapaul commented on PR #19649:
URL: https://github.com/apache/flink/pull/19649#issuecomment-1120766757
@flinkbot run azure
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] fapaul commented on a diff in pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
fapaul commented on code in PR #19649:
URL: https://github.com/apache/flink/pull/19649#discussion_r865655729
##########
flink-connectors/flink-connector-kafka/src/main/java/org/apache/flink/streaming/connectors/kafka/internals/metrics/KafkaMetricMutableWrapper.java:
##########
@@ -34,7 +34,12 @@ public KafkaMetricMutableWrapper(Metric metric) {
@Override
public Double getValue() {
- return (Double) kafkaMetric.metricValue();
+ final Object metricValue = kafkaMetric.metricValue();
+ // Previously KafkaMetric supported KafkaMetric#value that always returned a Double value.
+ // Since this method has been deprecated and is removed in future releases we have to
+ // manually check if the returned value is Double. Internally, KafkaMetric#value also
+ // returned 0.0 for all not "measurable" values, so we restored the original behavior.
+ return metricValue instanceof Double ? (Double) metricValue : 0.0;
Review Comment:
> It does restore the original behavior so I'm fine with not doing that, but we do have the option now to expose more kafka metrics.
Yes, that's true. I opened a follow-up ticket to forward all numeric values. https://issues.apache.org/jira/browse/FLINK-27493. I want to first fix the current regression.
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
flinkbot commented on PR #19649:
URL: https://github.com/apache/flink/pull/19649#issuecomment-1118261988
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "bbe5e70c25a925f34144516308022d23e24ab602",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "bbe5e70c25a925f34144516308022d23e24ab602",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* bbe5e70c25a925f34144516308022d23e24ab602 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] zentol commented on a diff in pull request #19649: [FLINK-27487][kafka] Only forward measurable Kafka metrics and ignore others
Posted by GitBox <gi...@apache.org>.
zentol commented on code in PR #19649:
URL: https://github.com/apache/flink/pull/19649#discussion_r865638433
##########
flink-connectors/flink-connector-kafka/src/main/java/org/apache/flink/streaming/connectors/kafka/internals/metrics/KafkaMetricMutableWrapper.java:
##########
@@ -34,7 +34,12 @@ public KafkaMetricMutableWrapper(Metric metric) {
@Override
public Double getValue() {
- return (Double) kafkaMetric.metricValue();
+ final Object metricValue = kafkaMetric.metricValue();
+ // Previously KafkaMetric supported KafkaMetric#value that always returned a Double value.
+ // Since this method has been deprecated and is removed in future releases we have to
+ // manually check if the returned value is Double. Internally, KafkaMetric#value also
+ // returned 0.0 for all not "measurable" values, so we restored the original behavior.
+ return metricValue instanceof Double ? (Double) metricValue : 0.0;
Review Comment:
Have you considered checking for `Number` and converting that to double?
--
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: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org