Troubleshooting Information
In-app troubleshooting information
When raising a problem with our support team, we can use troubleshooting information generated in-app to get a quick overview of how the app is configured and integrating with Jira.
Easy Agile TeamRhythm, Easy Agile Programs and Easy Agile Roadmaps include this Help section.
This is located in the in-app help menu in most Easy Agile apps. Access this in the “…” menu “Help” option:
Clicking on the Info icon in the top right of this shows the following Support information. Copy and paste this to share it with our support team!
This is a JSON-formatted representation of configuration options and statistics that helps us get a quick overview of how the app is working on this page. Understanding the context of your problem with this information helps us help you faster.
Additional help - Javascript Console
Here’s how to get a copy of your Javascript console if requested.
Chrome
Right click and navigate to ‘Inspect’
Select the Console tab.
Right-click on the console and select 'Save as...'. Save the file and then attach it to the support request.
Firefox
Open 'Web Console' from under 'Web Developer'
Then right-click on the console and select 'Export visible messages to' then select 'File'
Obtaining a HAR file
For some support requests we may ask you to send our support team a HAR file.
HAR files are a log of all the data used to display the current page. They can be invaluable for diagnosing an issue but they contain sensitive information. Depending on the page this may include the content of displayed Jira issues and your browser cookies which could allow someone with access to the HAR file to impersonate you.
Easy Agile delete all copies of HAR files received from customers once they've been analysed. If you're unable to send us a HAR file we can alternatively schedule a time with the development team to diagnose an issue remotely over a screen sharing session.
Instructions for generating a HAR file can be found here.
Collecting Jira Data Center / Server Log Files
Sometimes we’ll need to analyse log files from your Jira site to diagnose issues with Easy Agile apps.
A user with Jira Administrator permission can find and make copies of these log files.
In Jira’s global settings, navigate to the “System” tab and then the “Logging and profiling” page:
Under “Default Loggers”, click “Configure logging level for another package.”
In the dialog enter the “Package name” for your Easy Agile app (see table below) and set the logging level to “DEBUG”.
Easy Agile app | Package name |
---|---|
Easy Agile TeamRhythm | com.kretar.jira.plugin.user-story-map |
Easy Agile Programs | com.easyagile.programs |
Easy Agile Roadmaps | com.arijea.easy-agile-roadmaps |
Easy Agile Personas | com.easyagile.personas |
Navigating back to the Easy Agile app, perform the actions that trigger your error.
Locate the Jira log file. This is typically atlassian-jira.log, located in your Jira server home directory. (Please note: if the Jira home directory is not configured, then the logs will be placed into the current working directory instead).
Please remove any unrelated or sensitive information from the log before sending it back to us.
The Easy Agile team will typically be looking for:
Logs in the “Package name” namespace (eg. logs beginning with “com.kretar.jira.plugin.user-story-map”) OR
Logs from Jira itself that are associated with the REST API calls the app makes when fetching data from Jira (eg. logs beginning with “/rest/api/latest/”)
Clearing your browser cache
Chrome
On your computer, open Chrome.
At the top right, click More .
Click More tools Clear browsing data.
At the top, choose a time range. To delete everything, select All time.
Next to "Cookies and other site data" and "Cached images and files," check the boxes.
Click Clear data.
Firefox
Click the menu button and select Preferences
Select the Privacy & Security panel
In the Cookies and Site Data section, click Clear Data
Remove the check mark in front of Cookies and Site Data
With Cached Web Content check marked, click the Clear button
Close the about:preferences page. Any changes you've made will automatically be saved
Safari
Select the first item Safari in the main menu and from the drop-down the item Preferences...
A popup opens. Click on the tab Advanced
Check the option Show Develop menu in menu bar at the bottom. Now you should see a new menu item in the main menu named Develop
If you click on the menu item Develop you can select Empty Caches from the submenu items
Reload the site