|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + * contributor license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright ownership. |
| 5 | + * The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + * (the "License"); you may not use this file except in compliance with |
| 7 | + * the License. You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | + |
| 18 | +package org.apache.spark.sql.catalyst.optimizer |
| 19 | + |
| 20 | +import scala.collection.mutable.ArrayBuffer |
| 21 | + |
| 22 | +import org.apache.log4j.{Appender, AppenderSkeleton, Level, Logger} |
| 23 | +import org.apache.log4j.spi.LoggingEvent |
| 24 | + |
| 25 | +import org.apache.spark.sql.catalyst.dsl.expressions._ |
| 26 | +import org.apache.spark.sql.catalyst.dsl.plans._ |
| 27 | +import org.apache.spark.sql.catalyst.plans.PlanTest |
| 28 | +import org.apache.spark.sql.catalyst.plans.logical.{LocalRelation, LogicalPlan} |
| 29 | +import org.apache.spark.sql.catalyst.rules.RuleExecutor |
| 30 | +import org.apache.spark.sql.internal.SQLConf |
| 31 | + |
| 32 | +class OptimizerLoggingSuite extends PlanTest { |
| 33 | + |
| 34 | + object Optimize extends RuleExecutor[LogicalPlan] { |
| 35 | + val batches = Batch("Optimizer Batch", FixedPoint(100), |
| 36 | + PushDownPredicate, |
| 37 | + ColumnPruning, |
| 38 | + CollapseProject) :: Nil |
| 39 | + } |
| 40 | + |
| 41 | + class MockAppender extends AppenderSkeleton { |
| 42 | + val loggingEvents = new ArrayBuffer[LoggingEvent]() |
| 43 | + |
| 44 | + override def append(loggingEvent: LoggingEvent): Unit = { |
| 45 | + if (loggingEvent.getRenderedMessage().contains("Applying Rule")) { |
| 46 | + loggingEvents.append(loggingEvent) |
| 47 | + } |
| 48 | + } |
| 49 | + |
| 50 | + override def close(): Unit = {} |
| 51 | + override def requiresLayout(): Boolean = false |
| 52 | + } |
| 53 | + |
| 54 | + private def withLogLevelAndAppender(level: Level, appender: Appender)(f: => Unit): Unit = { |
| 55 | + val logger = Logger.getLogger(Optimize.getClass.getName.dropRight(1)) |
| 56 | + val restoreLevel = logger.getLevel |
| 57 | + logger.setLevel(level) |
| 58 | + logger.addAppender(appender) |
| 59 | + try f finally { |
| 60 | + logger.setLevel(restoreLevel) |
| 61 | + logger.removeAppender(appender) |
| 62 | + } |
| 63 | + } |
| 64 | + |
| 65 | + private def verifyLog(expectedLevel: Level, expectedRules: Seq[String]): Unit = { |
| 66 | + val logAppender = new MockAppender() |
| 67 | + withLogLevelAndAppender(Level.TRACE, logAppender) { |
| 68 | + val input = LocalRelation('a.int, 'b.string, 'c.double) |
| 69 | + val query = input.select('a, 'b).select('a).where('a > 1).analyze |
| 70 | + val expected = input.where('a > 1).select('a).analyze |
| 71 | + comparePlans(Optimize.execute(query), expected) |
| 72 | + } |
| 73 | + val logMessages = logAppender.loggingEvents.map(_.getRenderedMessage) |
| 74 | + assert(expectedRules.forall(rule => logMessages.exists(_.contains(rule)))) |
| 75 | + assert(logAppender.loggingEvents.forall(_.getLevel == expectedLevel)) |
| 76 | + } |
| 77 | + |
| 78 | + test("test log level") { |
| 79 | + val levels = Seq( |
| 80 | + "TRACE" -> Level.TRACE, |
| 81 | + "trace" -> Level.TRACE, |
| 82 | + "DEBUG" -> Level.DEBUG, |
| 83 | + "debug" -> Level.DEBUG, |
| 84 | + "INFO" -> Level.INFO, |
| 85 | + "info" -> Level.INFO, |
| 86 | + "WARN" -> Level.WARN, |
| 87 | + "warn" -> Level.WARN, |
| 88 | + "ERROR" -> Level.ERROR, |
| 89 | + "error" -> Level.ERROR, |
| 90 | + "deBUG" -> Level.DEBUG) |
| 91 | + |
| 92 | + levels.foreach { level => |
| 93 | + withSQLConf(SQLConf.OPTIMIZER_PLAN_CHANGE_LOG_LEVEL.key -> level._1) { |
| 94 | + verifyLog( |
| 95 | + level._2, |
| 96 | + Seq( |
| 97 | + PushDownPredicate.ruleName, |
| 98 | + ColumnPruning.ruleName, |
| 99 | + CollapseProject.ruleName)) |
| 100 | + } |
| 101 | + } |
| 102 | + } |
| 103 | + |
| 104 | + test("test invalid log level conf") { |
| 105 | + val levels = Seq( |
| 106 | + "", |
| 107 | + "*d_", |
| 108 | + "infoo") |
| 109 | + |
| 110 | + levels.foreach { level => |
| 111 | + val error = intercept[IllegalArgumentException] { |
| 112 | + withSQLConf(SQLConf.OPTIMIZER_PLAN_CHANGE_LOG_LEVEL.key -> level) {} |
| 113 | + } |
| 114 | + assert(error.getMessage.contains( |
| 115 | + "Invalid value for 'spark.sql.optimizer.planChangeLog.level'.")) |
| 116 | + } |
| 117 | + } |
| 118 | + |
| 119 | + test("test log rules") { |
| 120 | + val rulesSeq = Seq( |
| 121 | + Seq(PushDownPredicate.ruleName, |
| 122 | + ColumnPruning.ruleName, |
| 123 | + CollapseProject.ruleName).reduce(_ + "," + _) -> |
| 124 | + Seq(PushDownPredicate.ruleName, |
| 125 | + ColumnPruning.ruleName, |
| 126 | + CollapseProject.ruleName), |
| 127 | + Seq(PushDownPredicate.ruleName, |
| 128 | + ColumnPruning.ruleName).reduce(_ + "," + _) -> |
| 129 | + Seq(PushDownPredicate.ruleName, |
| 130 | + ColumnPruning.ruleName), |
| 131 | + CollapseProject.ruleName -> |
| 132 | + Seq(CollapseProject.ruleName), |
| 133 | + Seq(ColumnPruning.ruleName, |
| 134 | + "DummyRule").reduce(_ + "," + _) -> |
| 135 | + Seq(ColumnPruning.ruleName), |
| 136 | + "DummyRule" -> Seq(), |
| 137 | + "" -> Seq() |
| 138 | + ) |
| 139 | + |
| 140 | + rulesSeq.foreach { case (rulesConf, expectedRules) => |
| 141 | + withSQLConf( |
| 142 | + SQLConf.OPTIMIZER_PLAN_CHANGE_LOG_RULES.key -> rulesConf, |
| 143 | + SQLConf.OPTIMIZER_PLAN_CHANGE_LOG_LEVEL.key -> "INFO") { |
| 144 | + verifyLog(Level.INFO, expectedRules) |
| 145 | + } |
| 146 | + } |
| 147 | + } |
| 148 | +} |
0 commit comments