Uploaded image for project: 'JBoss Enterprise Application Platform'
  1. JBoss Enterprise Application Platform
  2. JBEAP-31603

Improve the log message report channel manifest versions used in the installation

XMLWordPrintable

      When the prospero SPI impl packages are integrated we log information about the channel manifest versions used in provisioning the installation. For example, for an EAP XP 6 installation:

      18:20:02,156 INFO  [org.wildfly.core.installationmanager] (MSC service thread 1-3) WFLYIM0023: Installation was provisioned using the following channel versions: '
      [ManifestVersion{channelId='org.jboss.eap.channels:eap-xp-6.0', description='EAP XP 6.0', version='1.0.0.GA-redhat-00015'}, 
      ManifestVersion{channelId='org.jboss.eap.channels:eap-8.1', description='EAP 8.1 Update 2.0', version='1.2.0.GA-redhat-00004'}]'
      

      This is harder to understand than it needs to be, partly because it uses ManifestVersion.toString() which results in lots of filler content common to any 'toString' impl. So we should strip that out.

      But it's also hard to understand because the pieces of data and their descriptors (i.e. the field names like channelId) are not presenting the information in an intuitively understandable way.

      There are two fundamental pieces of info we need to present for each channel manifest:

      1) Specific identifying info for the particular manifest.yaml file that was used. In the example above it's the GAV of manifest's maven component. For non-Maven manifests it could also be the URL that provided the manifest.yaml + the file's hash.

      2) The user friendly description of what the manifest content logically represents (i.e. 'EAP XP 6.0' and 'EAP 8.1 Update 2.0').

      So we should organize the content into two pieces of data for each channel, not three. And only include keys like 'channelId' describing the 'type' of each piece of data if we can come up with keys that clearly improve readability and understandability.

      Also the listed items appear to be organized as if we were recording things popped off a stack, where the bottom of the stack (EAP 8.1 Update 2.0) is last. It seems better to reverse this in the logging. The bottom of the stack is the most fundamental, and thus most noteworthy, piece of information, so it should come first.

      A possible representation:

      18:20:02,156 INFO  [org.wildfly.core.installationmanager] (MSC service thread 1-3) WFLYIM0023: Installation was provisioned using the following channel manifest versions: org.jboss.eap.channels:eap-8.1:1.2.0.GA-redhat-00004 (EAP 8.1 Update 2.0), org.jboss.eap.channels:eap-xp-6.0:1.0.0.GA-redhat-00015 (EAP XP 6.0)
      

      Here I omit 'keys' as they would only distract. The message says we will enumerate 'channel manifest versions' and then we the list things like look like versions to anyone familiar with Maven, followed parenthetically by the critical info explaining what that manifest version represents.

              bstansbe@redhat.com Brian Stansberry
              bstansbe@redhat.com Brian Stansberry
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: