JMWE logs

This page details the most recent events logged by the JMWE add-on for your Jira Cloud instance. You must be logged in as an administrator to view or use this page

Until 1.0.12 you could download your logs from Troubleshooting and Support page under JMWE administration pages. From 1.0.13 onwards you can view and download them in the JMWE Logs page.

On this page:

Logging level

By default, events with a level below INFO are not stored and therefore cannot be included in the logs downloaded or viewed in the table below. However, for troubleshooting purposes, it is possible to temporarily increase the amount of logging by changing the minimum level. The new level set here will remain for one hour, and will thereafter revert to the default level, i.e. the INFO level.

To set a temporary log level:

  • Select the required level from the Temporary log level drop-down
  • Click on Apply.

Click on Reset to revert the log level to the default INFO level.

Log viewer

By default, the Last day logs with a level higher than INFO are displayed in the table. You can filter the logs based on when they were created - When and the Log level - Level. To filter them further, click on More filters to add the below additional filters:

Filters

You can filter log events based on the;

  • message type Eg: security-error, template-error, workflow-warning etc - Message type
  • post-function executed - Post-function
  • name of workflow - Workflow name
  • name of the transition - Transition name
  • Issue key on which the transition was triggered - Issue key
  • username of the user who triggered the transition - Username
  • execution ID that can be copied from Context (explained below) - Execution ID

Click on Apply filters to filter the logs

Entries

Only the 200 most recent events that match your filters are displayed in the table. Each entry has the Timestamp, Level, Post-function, Message Type and Message. In most of the cases, the failure details are displayed in the Message. And if that isn't sufficient enough to debug your problem you need to click on > of a log entry to see the following information:

  • Error details, displays the error details, if any
    • Error code
    • Error message
    • Field error(s): Errors related to fields
  • Context, displays the context of the log entry
    • Username: username of the user who triggered the transition Eg: djohn
    • During: which process the entry was created. Eg: post-function-execution
    • Execution ID: The ID of a specific execution of a post-function. This allows you to search for all events generated by a single execution of a post-function.. You can add this to the filters by clicking on add to filters link.
    • Issue key: issue key of the issue on which the transition was triggered
  • Jira REST API call, displays information on the call made to Jira
    • Method: Method used. Eg: PUT,get
    • Url: REST Url
    • Data: Object or value sent to Jira to set a field
  • Post-function, Configuration of the post-function
    • Post-function: Name of the post-function
    • Transition: Transition name and Workflow name on which the transition was added
    • Configuration

See the examples below to understand how to filter and analyze the logs.

Download logs

Follow these steps to download your filtered logs :

  1. Go to the JMWE Logs page for the Jira Misc Workflow Extensions add-on.
  2. Filter logs using filters provided under Log viewer.
  3. Select a format from the Format drop-down.
    Format: The Format drop-down has options to select the format in which you want to download the logs.
  4. Click on Download logs.

Logs displayed in the table are downloaded. The download is limited to 200 events at most that match your filters selected.

Using logs for troubleshooting

If any of the JMWE post-functions you have used in your workflow does not seem to be working as you would expect, you can investigate the failure from these logs. For example:

1 - Creation of an Epic using Create issue post-function fails

Filtering your logs

  • Go to JMWE Logs page
  • Select Create issue in Post-function
  • Click on Apply filters

The table displays your filtered logs.

Analyzing the log

The first thing you need to do is look at Message, the last column of the table for the error/warning message (if any). 

Message: The post-function failed to create the Epic because the Epic Name was not provided which is mandatory while creating an Epic. 

2 - Set of Component/s to "Backend,Testing" using Set field value post-function fails

Filtering your logs

  • Go to JMWE Logs page
  • Input the Issue key in Issue key filter
  • Click on Apply filters

The table displays your filtered logs.

Analyzing the log

The first thing you need to do is look at Message, the last column of the table for the error/warning message.

Message: The post-function failed to set Component/s field with a component name "Testing". Clicking on > of the log entry and looking at Jira REST API call will display information on what value has been passed to Jira.

Jira REST API call: The Data shows that two components; Backend and Testing were passed to Jira instead of one i.e. "Backend,Testing". The comma(',') was considered as a delimiter in the array of values rather than a part of the component name. So you need to pass the value as JSON object ([{"name":"Backend,Testing"}]) selecting the "Treat value as JSON" option in the post-function configuration.

3 - Know impacted issues when using Set field value of linked issues post-function

While iterating over linked issues to set a field value using Set field value of linked issues post-function, there is no way of knowing which issues were impacted. You might then want to set the Temporary log level to DEBUG and trigger the transition that has the post-function.

Filtering your logs

  • Go to JMWE Logs page
  • Select DEBUG in Level
  • Select Set field value of linked issues in Post-function
  • Click on Apply filters

The table displays your filtered logs.

Analyzing the log

The table now has DEBUG entries indicating the setting of the field on the impacted linked issues.