The Jeyzer Web Analyzer permits to generate JZR reports through a web interface.
The Jeyzer Web Analyzer is a Vaadin based web application running under Tomcat 9.
Command
To start the Jeyzer Web Analyzer execute the command jeyzer-analyzer-web-server.bat or jeyzer-analyzer-web-server.sh, located under the analyzer\bin directory of your Jeyzer installation.
Note that the browser client start script pointing to the right URL is also provided in the same directory : jeyzer-analyzer-web-client.bat | sh
Installation
Jeyzer Installer : Select the Jeyzer Analyzer Web component.
The Jeyzer Installer will guide you in the high level setup.
Check the quick_start.html at the Jeyzer installation root : it contains useful paths.
Jeyzer Docker image : see the download section.
Configuration
The principal parameters are set through environment variables defined in the Tomcat setenv.bat/sh which is the standard way.
This file is located in the web/apache-tomcat-9.0.41/bin of your Jeyzer installation.
Parameters of interest are :
| Variable | Description | Default value |
| JEYZER_WEB_ANALYZER_WORK_DIR | The Jeyzer web working directory | jeyzer_home/work/web |
| JEYZER_MASTER_PROFILES_DIR_ROOTS | The list of root profile directories to load, comma separated The list of master profiles will be scanned on start up and displayed in the user interface. | External master profiles Jeyzer demo profiles Jeyzer base profiles Jeyzer helper profiles |
| JEYZER_ANALYZER_DEFAULT_PROFILE | The default selected analysis profile | Discovery |
| JEYZER_WEB_PORTAL_PROFILES_DISPLAY | Indicates if the list of master profiles must be displayed. If false, the above default selected analysis profile is automatically selected. | true |
| JEYZER_ANALYZER_TEAM_EMAIL_ENABLED | Indicates if the JZR report must be sent by email to the R&D team Email is configured within the master profile | false |
| JEYZER_MONITOR_ANALYZER_STICKERS | The comma separated list of ambient stickers for the monitoring rules | code_quality, performance, security, environment, analysis |
| JEYZER_WEB_DEFAULT_ISSUE_DESCRIPTION | The default issue description Since v2.2 | Please describe the issue : context, time, symptoms.. |
| JEYZER_WEB_DEFAULT_SUBMITTER_EMAIL | The default submitter email Since v2.1 | optional-email@domain.com |
| JEYZER_WEB_PORTAL_TIME_ZONE_DISPLAY | Indicates if the time zones selection area must be displayed. If false, the time zones will be deduced from the recording or from the analysis profile. Since v2.5 | true |
| JEYZER_WEB_PORTAL_PERIOD_DISPLAY | Indicates if the period selection field must be displayed. If false, it is deduced from the recording. | true |
| JEYZER_WEB_DISPLAY_UFO_STACK_FILE_LINK | Indicates if the UFO stack file must be displayed to the end user. | false |
| JEYZER_WEB_ANALYZER_THREAD_POOL_SIZE | The maximum number of concurrent analysis Adapt the Xmx if you increase it | 3 |
| JEYZER_WEB_UPLOAD_RECORDING_MAX_SIZE | The maximum size limit of the uploaded JZR recordings in Mb | 100 |
| JEYZER_WEB_UPLOAD_RECORDING_UNCOMPRESSED_MAX_SIZE | The maximum size limit of the result of the decompression of the JZR recording in Mb. Recommended to be 15 times the JEYZER_WEB_UPLOAD_RECORDING_MAX_SIZE value. | 1500 |
| JEYZER_WEB_UPLOAD_RECORDING_UNCOMPRESSED_MAX_FILES | The maximum number of files which can be decompressed out of a JZR recording. Cover by default a JZR recording of 24 hours, with a recording period of 30 seconds. | 2882 |
| JEYZER_WEB_TEMP_UPLOAD_DIRECTORY | The upload directory for the JZR recordings | jeyzer_home/work/web/upload |
| JEYZER_WEB_TEMP_UPLOAD_RECORDING_MAX_RETENTION_TIME | The maximum retention time in the upload directory while waiting for analysis | 5 minutes |
The Jeyzer Web Analyzer is started with 2Go of Xmx which is sufficient for three concurrent analysis.
Jeyzer Web Analyzer configuration relies on :
- Analysis profile, part of the master profile
- JZR report
- Monitoring rules
Logging
Jeyzer Web Analyzer relies on the logback framework.
The web-analyzer-logback.xml drives the console and file logging.
It is located in the analyzer/config/log directory of your Jeyzer installation.
Logging is set to INFO by default, which is not invasive.
Logging settings can be changed at runtime (no need to restart).
Log file is generated under the analyzer directory :analyzer/log/jeyzer_web_analyzer.log
Each analysis gets assigned a unique id. Example : 36db612-101
This request id is logged (and also used as a recording file prefix to become finally the report id).
Tomcat log files are generated in the web/apache-tomcat-9.0.41/logs of your Jeyzer installation.
Master profiles
Each Jeyzer analysis requires a master profile.
Master profiles are loaded on the first analysis request, taken out from the root profile directories : see JEYZER_MASTER_PROFILES_DIR_ROOTS.
The end user can select the master profile from the user interface.
Note : the uploaded recording name can trigger the automatic selection of a profile if its name includes the profile one Example : uploading the my-amq-recording.zip will automatically select the AMQ master profile.
To setup generic analyzers – like the Jeyzer Online Analyzer – you may hide the selection list of master profiles (JEYZER_WEB_PORTAL_PROFILES_DISPLAY=false) and rely on the profile redirection mechanism to select the right one. If none is detected, the default one – usually a generic master profile such as Portal – will apply : see JEYZER_ANALYZER_DEFAULT_PROFILE.
Outputs
Web outputs are the JZR report and possibly the UFO stack file (disabled by default).
File system output locations are fully configurable.
Below are the standard paths.
We distinguish two categories of outputs:
- Upload : the Tomcat upload directory for the JZR recordings.
Files are deleted once analyzed. - Analysis : the working directory for the JZR report generation and related resources (UFO stack file, graph pictures…).
The analysis instance # is between 1 and 3.
By default :work/web/analysis/<target profile>/<report id>/<analysis instance #>