9 November 2015

We've deprecated this Diagnostics Plugin guide, because the Diagnostics Plugin has been removed from the Atlassian Marketplace and is no longer being actively developed.

But there's good news! We've released a whole better diagnostics experience for application links. You get the new application links diagnostics with the recent version of Atlassian products.

Some teasers...

Built-in

The new diagnostics experience is built in to the Application Links plugin, so is available right out of the box.
You don't have to install or maintain a separate plugin.

Full product support

The new diagnostics experience supports all Atlassian products that use application links, including Jira 7 and Bamboo
(neither of which are supported by the old Diagnostics Plugin).

If you're having trouble with application links, see our Application Links troubleshooting guide.

 

 

Overview

This test verifies if the AppLinks plugin is installed and enabled on the target application. It does this by echoing the HTTP headers it receives from the target AppLinks plugin. This test will not be able to complete successfully if that plugin is not installed in both applications.

Understanding the Results

IconText resultWhat this means
SUCCESSThe test was successful.
WARNINGSome of the component tests failed and needs troubleshooting.
FAILThe test was not successful and needs troubleshooting.

Troubleshooting

HTTP Echo Test

  • URL path tested: <URL>/plugins/servlet/applinksDiagnostics/echo
  • Valid HTTP success codes: 200, 401
Error(s)How to resolve
The AppLinks Diagnostic Plugin does not appear to be installed in <Application Name>
Echo response is inconsistent with request
  • This is a general error message that implies the connection has failed - it is likely due to one of the errors below.
  • Access the diagnostics tab and check for any of the below errors.
Redirect count from <Application URL> exceeded maximum of 3
Request URL is inconsistent. Sent [<URL>] Received [<URL>]
  • This indicates there is something wrong with the way requests are being sent and received between the two AppLink Diagnostics plugins.
  • Could be caused by a mismatch in versions. Please ensure both AppLink Diagnostics plugins are on the most recent version.
  • This could be caused due to proxy or load-balancer incorrectly rewriting the HTTP requests. Please verify the configuration.
Unable to get response body
  • An IOException was thrown when trying to connect to the target application.
  • This indicates there was a failure in the connection such as a timeout or connection reset.
  • Essentially the target application could not resolve the URL that it was trying to connect to.
  • Verify if you can connect to the URL in the browser.
Unable to parse response [<Response>] [<Exception>]
  • A JSONException was thrown when trying to connect to the target application.
  • Indicates the connection could be established however the JSON was garbled when trying to parse it.
  • Verify any proxy/load-balancer configurations.
  • Verify that compression is not enabled on both the proxy and the target application as this can cause problems.

Got HTTP <status code> redirect from <URL> but no redirect location was specified

  • There is a redirect setup on the target application, however it is not redirecting to a valid location.
  • Attempt to access the URL in the browser and see if there is a more descriptive error.
  • Verify any proxy/load-balancer configurations.

Basic Checks

Error(s)Steps to Resolve
  • Application Link is NULL
  • The Application Link has been corrupted, please recreate it.
  • Application URL is NULL
  • This means the application URL is empty. Try to edit the link and see if this can be fixed.
  • This shouldn't happen, the Application Link will probably need to be recreated.

Providing Information to Support

Atlassian applications allow the use of reverse-proxies within our products, however Atlassian Support does not provide assistance for configuring them. Consequently, Atlassian can not guarantee providing any support for them.

If assistance with configuration is required, please raise a question on Atlassian Community.

In case you are unable to troubleshoot and fix the problem by yourself, please create a support ticket at support.atlassian.com and attach the following information to the ticket:

  1. Copy and save the contents of the 'Diagnostics' tab as a text file.

  2. Screenshots of the Application Links configuration.

  3. Support ZIP.