Allow logging to be disabled for individual classes #3
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 |
|---|---|---|
|
|
@@ -16,69 +16,157 @@ | |
|
|
||
| package com.permutive.logging.dynamic.odin | ||
|
|
||
| import cats.effect.{IO, Resource} | ||
| import com.permutive.logging.dynamic.odin.DynamicOdinConsoleLogger.{ | ||
| LevelConfig, | ||
| RuntimeConfig | ||
| } | ||
| import com.permutive.logging.odin.testing.OdinRefLogger | ||
| import io.odin.formatter.Formatter | ||
| import io.odin.meta.Position | ||
| import io.odin.{Level, LoggerMessage} | ||
| import munit.{CatsEffectSuite, ScalaCheckEffectSuite} | ||
| import org.scalacheck.Arbitrary | ||
| import org.scalacheck.effect.PropF | ||
|
|
||
| import scala.collection.immutable.Queue | ||
| import scala.concurrent.duration._ | ||
|
|
||
| class DynamicOdinLoggerSpec extends CatsEffectSuite with ScalaCheckEffectSuite { | ||
|
|
||
| private implicit val arbPosition: Arbitrary[Position] = | ||
| Arbitrary( | ||
| Arbitrary | ||
| .arbitrary[(String, String, String, Int)] | ||
| .map((Position.apply _).tupled) | ||
| ) | ||
|
|
||
| private val defaultConfig = RuntimeConfig(Level.Info) | ||
|
|
||
| test("record only messages at the min level") { | ||
| PropF.forAllF { (debugMessage: String, infoMessage: String) => | ||
| val messages = runTest()(logger => | ||
| logger.debug(debugMessage) >> | ||
| logger.info(infoMessage) | ||
| ) | ||
|
|
||
| messages | ||
| .map(_.map(_.message.value).toList) | ||
| .assertEquals(List(infoMessage)) | ||
| } | ||
| } | ||
|
|
||
| test("disable logging for a particular enclosure") { | ||
| PropF.forAllF { | ||
| ( | ||
| pos1Msg: String, | ||
| pos2Msg: String, | ||
| position1: Position | ||
| ) => | ||
| val position2 = | ||
| position1.copy(enclosureName = position1.enclosureName + "2") | ||
| val messages = runTest( | ||
| RuntimeConfig( | ||
| Level.Info, | ||
| Map( | ||
| position2.enclosureName -> LevelConfig.Off | ||
| ) | ||
| ) | ||
| )(logger => | ||
| logger.info(pos1Msg)(implicitly, position1) >> | ||
| logger.error(pos2Msg)(implicitly, position2) | ||
| ) | ||
|
|
||
| messages | ||
| .map(_.map(_.message.value).toList) | ||
| .assertEquals(List(pos1Msg)) | ||
| } | ||
| } | ||
|
|
||
| test("raises default-level config") { | ||
| PropF.forAllF { (messageBeforeChange: String, messageAfterChange: String) => | ||
| val messages = runTest() { logger => | ||
| logger.info(messageBeforeChange) >> | ||
| IO.sleep(10.millis) >> | ||
| logger.update(RuntimeConfig(defaultLevel = Level.Warn)) >> | ||
| logger.info(messageAfterChange) | ||
| } | ||
| messages | ||
| .map(_.map(_.message.value).toList) | ||
| .assertEquals(List(messageBeforeChange)) | ||
| } | ||
| } | ||
|
|
||
| test("lowers default-level config") { | ||
| PropF.forAllF { (messageBeforeChange: String, messageAfterChange: String) => | ||
| val messages = runTest() { logger => | ||
| logger.info(messageBeforeChange) >> | ||
| IO.sleep(10.millis) >> | ||
| logger.update(RuntimeConfig(defaultLevel = Level.Debug)) >> | ||
| logger.debug(messageAfterChange) | ||
| } | ||
| messages | ||
| .map(_.map(_.message.value).toList) | ||
| .assertEquals(List(messageBeforeChange, messageAfterChange)) | ||
| } | ||
|
Comment on lines
+100
to
111
Contributor
There was a problem hiding this comment. This would have failed in the old implementation as the logging level of The knock on effect of this change is covered in this comment |
||
| } | ||
|
|
||
| test("overrides default level for a certain package") { | ||
| PropF.forAllF { (message: String) => | ||
| val messages = runTest( | ||
| RuntimeConfig( | ||
| defaultLevel = Level.Warn, | ||
| Map("com.permutive.logging.dynamic.odin" -> LevelConfig.Debug) | ||
| ) | ||
| ) { logger => | ||
| logger.debug(message) | ||
| } | ||
| messages | ||
| .map(_.map(_.message.value).toList) | ||
| .assertEquals(List(message)) | ||
| } | ||
| } | ||
|
|
||
| test("update enclosure log level") { | ||
| PropF.forAllNoShrinkF { | ||
| ( | ||
| infoMsg1Pos1: String, | ||
| infoMsg2Pos1: String, | ||
| warnMsg1Pos1: String, | ||
| infoMsg2Pos2: String, | ||
| position1: Position, | ||
| position2: Position | ||
| ) => | ||
| val messages = runTest() { logger => | ||
| val positionWhichChangesLevel = | ||
| position1.copy(enclosureName = position1.enclosureName + "changes") | ||
| logger.info(infoMsg1Pos1)(implicitly, positionWhichChangesLevel) >> | ||
| IO.sleep(10.millis) >> | ||
| logger.update( | ||
| RuntimeConfig( | ||
| Level.Info, | ||
| Map(positionWhichChangesLevel.enclosureName -> LevelConfig.Warn) | ||
| ) | ||
| ) >> | ||
| logger.info(infoMsg2Pos1)(implicitly, positionWhichChangesLevel) >> | ||
| logger.warn(warnMsg1Pos1)(implicitly, positionWhichChangesLevel) >> | ||
| logger.info(infoMsg2Pos2)(implicitly, position2) | ||
| } | ||
| messages | ||
| .map(_.map(_.message.value).toList) | ||
| .assertEquals(List(infoMsg1Pos1, warnMsg1Pos1, infoMsg2Pos2)) | ||
| } | ||
| } | ||
|
|
||
| private def runTest(initialConfig: RuntimeConfig = defaultConfig)( | ||
| useLogger: DynamicOdinConsoleLogger[IO] => IO[Unit] | ||
| ): IO[Queue[LoggerMessage]] = (for { | ||
| testLogger <- Resource.eval(OdinRefLogger.create[IO]()) | ||
| dynamic <- DynamicOdinConsoleLogger.create[IO]( | ||
| DynamicOdinConsoleLogger | ||
| .Config(formatter = Formatter.default, asyncTimeWindow = 0.nanos), | ||
| initialConfig | ||
| )(config => testLogger.withMinimalLevel(config.defaultLevel)) | ||
| _ <- Resource.eval(useLogger(dynamic)) | ||
| } yield testLogger) | ||
| .use { testLogger => | ||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
This feels a bit dangerous. With this being set, we will inspect the
refon every log message, but it does at least mean that the level mapping can override the default level setting.I.e. every trace/debug message will hit the ref via the
submitimplementation below, rather than being filtered beforehand by this level here.I'm wondering whether we should re-introduce
minLevelwhich is the "absolute" minimum and cannot be lowered at runtime to prevent trace messages from hitting the ref.