7

I have a console application that prints its output using Log4J. This is useful as I can easily implement a switch to optionally also show debug messages, even though they are hidden by default.

This application has some long running actions for which a progress bar would be appropriate.

What is the best way to implement this using either Log4J or LogBack?

Axel Fontaine
  • 34,542
  • 16
  • 106
  • 137
  • I don't understand the question. How would you display a progress bar in a log entry? If you already know the progress, why not print xx% done? – ChrisM Jun 11 '15 at 14:20

1 Answers1

3

To write a progress bar or any sort of updating text to the console, simply end your output with \r (carriage return) instead of \n (new line) so that the next line overwrites it. This question goes into more detail. The F-ANSI library enables you to easily generate nice-looking console output including overwriting the previous line.

But if you are set on using a logging framework, not only is this not possible, but it's not what you want. As ChrisM suggests, the right way to log progress is to log a new line every so often with the percent done so far. This way, you can see both what your program is doing and how far along it is in context.

What it sounds like you want to do is separate your logging from your program's actual output (this is generally a good idea, even disregarding the progress bar issue). Use your logging framework to log information about the program's execution; things you or someone debugging would be interested in. The actual program's output should be written directly to stdout via System.out.

You can then separately decide what you want to do with your logging. It can also be written to stdout, and your logs and output can live together, but better would be to write to stderr (which makes redirecting it much easier) or to a log file (which makes your program's output cleaner, and persists your logs for reference later).

Also, if Java isn't a prerequisite the pv command provides a powerful, customizable progress bar based on the amount of data piped through it.

Community
  • 1
  • 1
dimo414
  • 47,227
  • 18
  • 148
  • 244
  • What is a good way to only print the progress only every so often? I tried using the modulus operator (e.g. `if(progress % 5 == 0) { //... }` but it didn't work since there's no guarantee that the progress will ever be a multiple of 5. – Cardinal System Aug 09 '22 at 15:49
  • 1
    Consider posting a new question with more details like a MCVE (you can drop a link here if you need my input), but I'd consider using the system clock or a separate dedicated counter to throttle the update rate. Guava also has a `RateLimiter` class but that's probably overkill. – dimo414 Aug 09 '22 at 23:12