forked from apache/spark
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request apache#70 from ashangit/criteo-2.2
[SPARK-18364][YARN] Expose metrics for YarnShuffleService
- Loading branch information
Showing
3 changed files
with
242 additions
and
9 deletions.
There are no files selected for viewing
This file contains 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
137 changes: 137 additions & 0 deletions
137
...n/network-yarn/src/main/java/org/apache/spark/network/yarn/YarnShuffleServiceMetrics.java
This file contains 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,137 @@ | ||
| /* | ||
| * 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) { | ||
| MetricsRecordBuilder metricsRecordBuilder = collector.addRecord("shuffleService"); | ||
|
|
||
| for (Map.Entry<String, Metric> entry : metricSet.getMetrics().entrySet()) { | ||
| collectMetric(metricsRecordBuilder, entry.getKey(), entry.getValue()); | ||
| } | ||
| } | ||
|
|
||
| public static void collectMetric(MetricsRecordBuilder metricsRecordBuilder, String name, Metric metric) { | ||
|
|
||
| // 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; | ||
| metricsRecordBuilder | ||
| .addGauge(new ShuffleServiceMetricsInfo(name, "Integer value of " + | ||
| "gauge " + name), intValue.intValue()); | ||
| } else if (gaugeValue instanceof Float) { | ||
| Float floatValue = (Float) gaugeValue; | ||
| metricsRecordBuilder | ||
| .addGauge(new ShuffleServiceMetricsInfo(name, "Float value of " + | ||
| "gauge " + name), floatValue.floatValue()); | ||
| } else if (gaugeValue instanceof Long) { | ||
| Long longValue = (Long) gaugeValue; | ||
| metricsRecordBuilder | ||
| .addGauge(new ShuffleServiceMetricsInfo(name, "Long value of " + | ||
| "gauge " + name), longValue.longValue()); | ||
| } else if (gaugeValue instanceof Double) { | ||
| Double doubleValue = (Double) gaugeValue; | ||
| metricsRecordBuilder | ||
| .addGauge(new ShuffleServiceMetricsInfo(name, "Double value of " + | ||
| "gauge " + name), doubleValue.doubleValue()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| 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; | ||
| } | ||
| } | ||
| } |
75 changes: 75 additions & 0 deletions
75
...rs/yarn/src/test/scala/org/apache/spark/network/yarn/YarnShuffleServiceMetricsSuite.scala
This file contains 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()) | ||
| } | ||
| } |