Simplify status line plus add detailed and silent status reporters #20
Conversation
| Log.status(report()) | ||
| reporter = { | ||
| val r = reportType match { | ||
| case Detailed => new DetailedReporter(Stats.reg) |
There was a problem hiding this comment.
What about make the report type construct the reporter? Is it too much OO?
There was a problem hiding this comment.
Well, considering the implementation details are all private, It really is a matter of code style at this point.
Polymorphism here would make the type definition a bit verbose:
sealed trait ReportType {
private[report] def reporter: StatsReporter
}
object ReportType {
final case object Inline extends ReportType {
private[report] def reporter: StatsReporter =
new InlineReporter()
}
final case object Detailed extends ReportType {
private[report] def reporter: StatsReporter =
new DetailedReporter(Stats.reg)
}
final case object Silent extends ReportType {
private[report] def reporter: StatsReporter =
new SilentReporter()
}
}Note the private[report]. Since StatsReporter is private, I also have to protect the scope of the reporter method.
Considering ReportType is sealed, which makes pattern matching secure at compile time, a patter match looks simpler, IMO.
But I would argue in favor of polymorphic definition in case of a public reusable API, if we'd have one.
| @@ -92,6 +93,17 @@ object CmdArgs { | |||
| case "continue" => c.config += OnError(ErrorStrategy.DoNotStop) | |||
| } | |||
|
|
|||
| opt[String]("report-type") | |||
| .text("Progress report strategy to use") | |||
| .valueName(s"<inline|detailed|silent>") | |||
There was a problem hiding this comment.
besides the amount of info logged, what is the difference between inline and detailed? As far as I could see, detailed is logging using log4j and inline is logging using a scheduler and Log.status, is it mapped to the console?
There was a problem hiding this comment.
Inline uses Log.status which is a fixed status line at the end of the console output that gets rewritten at every update. It does not append \n so, it doesn't make you console scroll down.
Detailed uses the default log4j metrics reporter. It's quite verbose and it logs one metric per line but, it's useful when you need more information about the process' performance or when your output stream doesn't allow you to move the cursor around.
Closes: #14