Uploaded image for project: 'JBoss Server Migration Tool'
  1. JBoss Server Migration Tool
  2. CMTOOL-171

Improvements to Console/Logging User Experience

XMLWordPrintable

    • Icon: Improvement Improvement
    • Resolution: Done
    • Icon: Major Major
    • 1.1.0.CR1
    • None
    • Core
    • None

      The tool's console/logging has several issues related with User Experience:

      • there is an excessive number of messages displayed on console, most containing low level information that most users have no interest
      • the console logger format/pattern was inherit from WildFly logging configuration and includes fields of little/no interest to a high level user experience, such as the time and logger categories/names
      • logger levels are poorly used, specially by migration tasks, which frequently use the INFO level to log task execution low-level details
      • task logger naming scheme that doesn't reflect the task/subtask relationship, making it hard to understand the message sequences, specially at more verbose logger levels
      • printed paths are absolute, even when there is a clear relative path in content, e.g. server configs to config dir
      • there is no structure defined to organize/separate properly the messages printed by each migration task

      This issue should rework the console/logging existent format, structure and content as a whole for 1.1 first release, solving the user experience issues previously identified:

      • any message not high level, or needed for user interaction, should move to DEBUG level
      • Console log handler should have a minimal format/pattern, hiding time and logger names, shown only on File handler
      • Console log handler should continue with INFO level threshold, while File handler should change to DEBUG
      • Previously core DEBUG level messages should change to TRACE level
      • Paths in a context should always be displayed relative
      • Structure task messages using placeholders, similar to how Maven organizes the console build messages

            emartins@redhat.com Eduardo Martins
            emartins@redhat.com Eduardo Martins
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: