Bug 1431545

Summary: [RFE] remove the webadmin/userportal debuginfo packages and have automatic deobfuscation
Product: [oVirt] ovirt-engine Reporter: Tomas Jelinek <tjelinek>
Component: Frontend.CoreAssignee: Vojtech Szocs <vszocs>
Status: CLOSED CURRENTRELEASE QA Contact: Lukas Svaty <lsvaty>
Severity: high Docs Contact:
Priority: unspecified    
Version: futureCC: awels, bugs, gshereme, lsvaty, mburman, melewis, mgoldboi, stirabos, vszocs
Target Milestone: ovirt-4.1.3Keywords: FutureFeature
Target Release: 4.1.3.3Flags: rule-engine: ovirt-4.1+
rule-engine: exception+
mgoldboi: planning_ack+
gshereme: devel_ack+
pstehlik: testing_ack+
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
With this update, GWT symbol maps, used to clarify obfuscated client-side (GWT UI) stack traces (/var/log/ovirt-engine/ui.log), are now part of the core Red Hat Virtualization Manager UI packages. The packages are installed by default when the Red Hat Virtualization Manager is installed or upgraded. This update means that the user now has meaningful client-side stack traces in /var/log/ovirt-engine/ui.log without having to install additional packages, which saves time when analyzing UI related issues. This update also reduces the symbol maps size by zipping them. The Administration Portal UI uncompressed GWT symbol maps previously took ~1 GB of disk space. The zipped version consumes only 50 MB. The content of the zipped GWT symbol map files is streamed by the Manager as required and the content is not physically extracted to disk. After the Manager install or upgrade, the GWT symbol maps files use the following location: /usr/share/ovirt-engine/gwt-symbols/webadmin/symbolMaps.zip NOTE: The webadmin-portal-debuginfo package, which previously provided the GWT symbol map files, must now be manually removed prior to engine upgrade, or the upgrade will fail. (This package is an optional install, so you only need to remove it if you've manually installed it.)
 Story Points: ---
Clone Of: Environment:
Last Closed: 2017-07-06 13:09:32 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: UX RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Tomas Jelinek 2017-03-13 08:18:05 UTC 
Description of problem:

The flow is like this:
- the user hits an issue
- we ask for the (ui) logs
- they are obfuscated
- we ask for installing the debuginfo and re-reproduce the issue and add the logs again
- if the user succeeds to reproduce the issue, we will get the readable logs. If not, not...

The problem is that the current logs are not too helpful (yes, can be deobfuscated manually but it takes quite some time which normally the one who does the scrubbing does not want to commit until it is obvious it is a real issue). It would be a huge help to have debuginfos installed by default so all logs are useful by default.

The only drawback I see is potential performance hit (the value of deobfuscation). But considering this happens only if the FE throws an exception which should not be too often I think the value is bigger than the price here.
Comment 1 Yaniv Kaul 2017-03-13 13:02:39 UTC 
Oved and I were just discussing it yesterday.
Comment 2 Greg Sheremeta 2017-03-13 19:59:05 UTC 
@Vojtech or Alexander, do you see any issues with doing this?
Comment 3 Alexander Wels 2017-03-27 12:18:28 UTC 
So the original reason we didn't make these required in the first place is that the symbol maps are fairly large. In the order of around 80 megabytes. Other than that there is no problem IMO.
Comment 4 Greg Sheremeta 2017-04-13 21:38:45 UTC 
Assigning to Vojtech -- he asked to take this over.
Comment 8 Vojtech Szocs 2017-05-19 15:16:15 UTC 
The relevant patch https://gerrit.ovirt.org/#/c/75420/ is now finalized, it has the following implications:

- GWT .symbolMap files are part of the core UI packages:

  # owned by webadmin-portal package
  $PREFIX/share/ovirt-engine/gwt-symbols/webadmin.zip

  # owned by userportal package
  $PREFIX/share/ovirt-engine/gwt-symbols/userportal.zip

- the "debuginfo" packages are removed:

  webadmin-portal-debuginfo
  userportal-debuginfo

- above .zip files have their content streamed as needed (not extracted on disk), reducing the overall disk size of Engine installation
Comment 9 Vojtech Szocs 2017-05-19 15:59:33 UTC 
We should also decide if/how to handle the removal of "debuginfo" packages upon Engine upgrade.
Comment 10 Vojtech Szocs 2017-06-06 20:13:59 UTC 
(In reply to vszocs from comment #9)
> We should also decide if/how to handle the removal of "debuginfo" packages
> upon Engine upgrade.

As stated in the Doc Text: Before upgrading Engine, old "debuginfo" packages must be manually removed first.
Comment 11 rhev-integ 2017-06-09 09:57:48 UTC 
INFO: Bug status wasn't changed from MODIFIED to ON_QA due to the following reason:

[Tag 'ovirt-engine-4.1.3.2' doesn't contain patch 'https://gerrit.ovirt.org/77892']
gitweb: https://gerrit.ovirt.org/gitweb?p=ovirt-engine.git;a=shortlog;h=refs/tags/ovirt-engine-4.1.3.2

For more info please contact: infra
Comment 12 Lukas Svaty 2017-06-21 12:11:47 UTC 
debuginfo packages still available in noarch/ in build
[root@ls-engine2 ~]# yum provides ovirt-engine-webadmin-portal-debuginfo
Loaded plugins: product-id, search-disabled-repos, versionlock
ovirt-engine-webadmin-portal-debuginfo-4.1.3.2-0.1.el7.noarch : Debug
     ...: information for Web Admin Portal of oVirt Engine
Repo        : rhv-4.1.3


This should be removed, I believe, am I right?
Comment 13 Greg Sheremeta 2017-06-21 12:34:38 UTC 
It should be removed. I checked with the build team. Eyal wasn't sure why it was available, but it definitely won't go out with 4.1.3.
Comment 14 Lukas Svaty 2017-06-21 14:29:58 UTC 
packages are still available in repositories, however now installed with engine, which will be solved by not creating errata for them, I was able to verify that deciphered ui.logs exists even without these packages with help of Greg, thus moving to verified 
in version rhevm-4.1.3.4-0.1.el7.noarch