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

The usual configuration is to have the display URL and the application URL as the same, which is the base URL from the target application. However, they could different in the following scenarios:

  • Both applications are behind reverse proxies within a secure trusted network. End users access the applications using the display URL, where as application links use the direct URL to have direct connection to the target application bypassing the proxy.
  • There are multiple <Connector> configured in the Tomcat server.xml, of which one is used by the reverse proxy or different network and the other by the application link.

The recommended configuration for application links when the application URL and display URL are different is as follows:

  • The Display URL should point to the Base URL configured in the target application.
  • The Application URL will be either be the direct (not using proxy) URL or the URL pointing to a different connector specified in Tomcat server.xml.

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

It is possible that the Display URL HTTP Connectivity Test could fail if the display URL and application URL are different. This is because the display URL may be used to access the application from a different network through a proxy server where as the diagnostic tests are done from a different network.


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.

HTTP Connectivity

  • URL path tested: <URL>/rest/applinks/1.0/applicationlink
  • Valid HTTP success codes: 200, 401
Error(s)Steps to Resolve
  • Invalid URI
  • Is the URL valid?
  • Is the display URL same as the base URL configured in the target application?
  • Can you connect to the target application URL from the server running the diagnostics?
  • Unknown Host
  • java.net.ConnectException: Connection refused
  • Is the server running the target application reachable?

  • Check if you can ping the target server from the server that is running the AppLinks diagnostics plugin.

  • For example, when trying to verify if Confluence can access JIRA, execute the following on the Confluence server:

    ping jira.atlassian.com

    (info) Replace jira.atlassian.com with the display URL of the target instance.

  • Redirect count from <URL> exceeded maximum of <maximum>.
  • Received HTTP <status code> redirect...
  • Got HTTP <status code> redirect from <URL> but no redirect location was specified.
  • Failed to ping <Application>.
  • Received unexpected HTTP <status code> response from <URL> using...
  • Is the target application accessible at the display/application URL?
  • Try connecting to the application using the display URL and verify if the application is available and you are able to log in.

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. A Support ZIP.

Unknown macro: {dynamiccontentbylabel}

 




 

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.