z/OSMF Diagnostic Assistant service is a new feature of z/OSMF. User can use this service to set z/OSMF log level and collect diagnostic data as a compressed file package. All of these can be finished very easily with few clicks.
There are lots of plugin in z/OSMF. Sometimes z/OSMF user gets an error when he is using one plugin. User needs to get detailed log to analyze the problem. Usually, he must do some operations in z/OS or download some logs by FTP, which needs several steps to get required logs inconveniently. With z/OSMF Diagnostic Assistant service, all these steps become much easier than before.
Firstly, user can go to Diagnostic Assistant to set log level, then repeat the steps to recreate the error, then use Diagnostic Assistant to download all logs to his workstation. Following is the detailed steps.
1. Login z/OSMF
The z/OSMF desktop style interface is a log-in option. You access it through the z/OSMF login screen by entering your z/OS user ID, then selecting Use desktop interface and clicking Log In.
Input user ID and password, then you will enter the z/OSMF Desktop UI
2. Assess Diagnostic Assistant
Find icon of App Center which is in the left bottom of the page
Click icon of App Center, App center is open, find z/OSMF Diagnostic Assistant
3. Set the z/OSMF logging level
Double click the icon of z/OSMF Diagnostic Assistant, Diagnostic Assistant is open.
In this page, you will see Collect z/OSMF diagnostic data and Set the z/OSMF logging level. Click to open Set the z/OSMF logging, you can set logging level here.
Click Add Service to open Add Service dialog, you can select the z/OSMF services for which logging to be enabled.
Here, for example, user selects z/OS jobs Rest services, click OK to submit. Then one service is added in the table. There is a default package name and log level.
User also can set log level for several components together.
The package name and Log level can both be updated. Here, in order to get detailed log, set log level as FINEST.
Click Set button to send request to set the added z/OSMF log level. If it sets successfully, one message will be showed as the snapshot.
If user wants to save the components and the package level he added, just need to click Save button.
After log level set, user would recreate the issue, then use below function to download the diagnostic data. Also do not forget to set log level back after creating the issue.
4. Collect z/OSMF diagnostic data
Click Collect z/OSMF diagnostic data to open the page, user can select the data that will be exported in the opened page.
Default selection is z/OSMF default diagnostic data, meaning all the useful diagnostic data from z/OSMF data directory path will be collected.
If you want to limit data collection to runtime and server-side logs, select Only include runtime and server side logs. If so, the diagnostic data is obtained from the following directory:<USER_DIR>/data/logs
To include the z/OSMF server job log in the data collected, select z/OSMF server job log. For now, you need to specify the job name and job ID for the z/OSMF server.
Click Export to export the diagnostic data as a compressed (.zip) file. The file name is based on the date and time on which it was generated. Open the file or save it to your workstation.
5. Check compressed log
Now click Open to view compressed log
After clicking Open, log zip file is opened as below. Following is sample data, in user’s environment, real log data is possibly different with snapshot.