[SPARK-18364][YARN] Expose metrics for YarnShuffleService #17401
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /* | ||
| * 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.spark.network.yarn; | ||
|
|
||
| import com.codahale.metrics.*; | ||
| import com.google.common.annotations.VisibleForTesting; | ||
| import org.apache.hadoop.metrics2.MetricsCollector; | ||
| import org.apache.hadoop.metrics2.MetricsInfo; | ||
| import org.apache.hadoop.metrics2.MetricsRecordBuilder; | ||
| import org.apache.hadoop.metrics2.MetricsSource; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Modeled off of YARN's NodeManagerMetrics. | ||
| */ | ||
| public class YarnShuffleServiceMetrics implements MetricsSource { | ||
|
|
||
| private final MetricSet metricSet; | ||
|
|
||
| public YarnShuffleServiceMetrics(MetricSet metricSet) { | ||
| this.metricSet = metricSet; | ||
| } | ||
|
|
||
| /** | ||
| * Get metrics from the source | ||
| * | ||
| * @param collector to contain the resulting metrics snapshot | ||
| * @param all if true, return all metrics even if unchanged. | ||
| */ | ||
| @Override | ||
| public void getMetrics(MetricsCollector collector, boolean all) { | ||
|
Contributor
There was a problem hiding this comment. Is it possible to add a unit test to verify the correctness of converting codahale metrics to Hadoop metrics?
Contributor
Author
There was a problem hiding this comment. should be able to, I'm working on creating one now. By correctness, I think you mostly mean that the values passed through are the same, even though the naming schemes are different?
Contributor
There was a problem hiding this comment. Yes, you're right. From my understanding the correctness means |
||
| MetricsRecordBuilder metricsRecordBuilder = collector.addRecord("shuffleService"); | ||
|
|
||
| for (Map.Entry<String, Metric> entry : metricSet.getMetrics().entrySet()) { | ||
| collectMetric(metricsRecordBuilder, entry.getKey(), entry.getValue()); | ||
| } | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
|
|
||
| public static void collectMetric(MetricsRecordBuilder metricsRecordBuilder, String name, Metric metric) { | ||
|
Contributor
There was a problem hiding this comment. Is it necessary to use
Contributor
Author
There was a problem hiding this comment. I use |
||
|
|
||
| // The metric types used in ExternalShuffleBlockHandler.ShuffleMetrics | ||
| if (metric instanceof Timer) { | ||
| Timer t = (Timer) metric; | ||
| metricsRecordBuilder | ||
| .addCounter(new ShuffleServiceMetricsInfo(name + "_count", "Count of timer " + name), | ||
| t.getCount()) | ||
| .addGauge( | ||
| new ShuffleServiceMetricsInfo(name + "_rate15", "15 minute rate of timer " + name), | ||
| t.getFifteenMinuteRate()) | ||
| .addGauge( | ||
| new ShuffleServiceMetricsInfo(name + "_rate5", "5 minute rate of timer " + name), | ||
| t.getFiveMinuteRate()) | ||
| .addGauge( | ||
| new ShuffleServiceMetricsInfo(name + "_rate1", "1 minute rate of timer " + name), | ||
| t.getOneMinuteRate()) | ||
| .addGauge(new ShuffleServiceMetricsInfo(name + "_rateMean", "Mean rate of timer " + name), | ||
| t.getMeanRate()); | ||
| } else if (metric instanceof Meter) { | ||
| Meter m = (Meter) metric; | ||
| metricsRecordBuilder | ||
| .addCounter(new ShuffleServiceMetricsInfo(name + "_count", "Count of meter " + name), | ||
| m.getCount()) | ||
| .addGauge( | ||
| new ShuffleServiceMetricsInfo(name + "_rate15", "15 minute rate of meter " + name), | ||
| m.getFifteenMinuteRate()) | ||
| .addGauge( | ||
| new ShuffleServiceMetricsInfo(name + "_rate5", "5 minute rate of meter " + name), | ||
| m.getFiveMinuteRate()) | ||
| .addGauge( | ||
| new ShuffleServiceMetricsInfo(name + "_rate1", "1 minute rate of meter " + name), | ||
| m.getOneMinuteRate()) | ||
| .addGauge(new ShuffleServiceMetricsInfo(name + "_rateMean", "Mean rate of meter " + name), | ||
| m.getMeanRate()); | ||
| } else if (metric instanceof Gauge) { | ||
| Gauge m = (Gauge) metric; | ||
| Object gaugeValue = m.getValue(); | ||
| if (gaugeValue instanceof Integer) { | ||
| Integer intValue = (Integer) gaugeValue; | ||
|
Contributor
There was a problem hiding this comment. Does it mean that we could only handle integer Gauge, what if later on we add different metric in |
||
| metricsRecordBuilder | ||
| .addGauge(new ShuffleServiceMetricsInfo(name, "Integer value of " + | ||
| "gauge " + name), intValue.intValue()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static class ShuffleServiceMetricsInfo implements MetricsInfo { | ||
|
|
||
| private final String name; | ||
| private final String description; | ||
|
|
||
| ShuffleServiceMetricsInfo(String name, String description) { | ||
| this.name = name; | ||
| this.description = description; | ||
| } | ||
|
|
||
| @Override | ||
| public String name() { | ||
| return name; | ||
| } | ||
|
|
||
| @Override | ||
| public String description() { | ||
| return description; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * 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.spark.network.yarn | ||
|
|
||
| import scala.collection.JavaConverters._ | ||
|
|
||
| import org.apache.hadoop.metrics2.MetricsRecordBuilder | ||
| import org.mockito.Matchers._ | ||
| import org.mockito.Mockito.{mock, times, verify, when} | ||
| import org.scalatest.Matchers | ||
|
|
||
| import org.apache.spark.SparkFunSuite | ||
| import org.apache.spark.network.server.OneForOneStreamManager | ||
| import org.apache.spark.network.shuffle.{ExternalShuffleBlockHandler, ExternalShuffleBlockResolver} | ||
|
|
||
| class YarnShuffleServiceMetricsSuite extends SparkFunSuite with Matchers { | ||
|
|
||
| val streamManager = mock(classOf[OneForOneStreamManager]) | ||
| val blockResolver = mock(classOf[ExternalShuffleBlockResolver]) | ||
| when(blockResolver.getRegisteredExecutorsSize).thenReturn(42) | ||
|
|
||
| val metrics = new ExternalShuffleBlockHandler(streamManager, blockResolver).getAllMetrics | ||
|
|
||
| test("metrics named as expected") { | ||
| val allMetrics = Set( | ||
| "openBlockRequestLatencyMillis", "registerExecutorRequestLatencyMillis", | ||
| "blockTransferRateBytes", "registeredExecutorsSize") | ||
|
|
||
| metrics.getMetrics.keySet().asScala should be (allMetrics) | ||
| } | ||
|
|
||
| // these three metrics have the same effect on the collector | ||
| for (testname <- Seq("openBlockRequestLatencyMillis", | ||
| "registerExecutorRequestLatencyMillis", | ||
| "blockTransferRateBytes")) { | ||
| test(s"$testname - collector receives correct types") { | ||
| val builder = mock(classOf[MetricsRecordBuilder]) | ||
| when(builder.addCounter(any(), anyLong())).thenReturn(builder) | ||
| when(builder.addGauge(any(), anyDouble())).thenReturn(builder) | ||
|
|
||
| YarnShuffleServiceMetrics.collectMetric(builder, testname, | ||
| metrics.getMetrics.get(testname)) | ||
|
|
||
| verify(builder).addCounter(anyObject(), anyLong()) | ||
| verify(builder, times(4)).addGauge(anyObject(), anyDouble()) | ||
| } | ||
| } | ||
|
|
||
| // this metric writes only one gauge to the collector | ||
| test("registeredExecutorsSize - collector receives correct types") { | ||
| val builder = mock(classOf[MetricsRecordBuilder]) | ||
| when(builder.addCounter(any(), anyLong())).thenReturn(builder) | ||
| when(builder.addGauge(any(), anyDouble())).thenReturn(builder) | ||
|
|
||
| YarnShuffleServiceMetrics.collectMetric(builder, "registeredExecutorsSize", | ||
| metrics.getMetrics.get("registeredExecutorsSize")) | ||
|
|
||
| // only one | ||
| verify(builder).addGauge(anyObject(), anyInt()) | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@VisibleForTestingcauses classpath issues. Please note this in the java doc instead (SPARK-11615).This is a scalastyle output, would be better to remove this annotation.