Status URL for monitoring?

[IT Support]

Is there an API call or other URL I can visit to get a status from JIRA and Confluence? I'm working on setting up monitoing with Nagios / Icinga. I can do a generic "hit the main page and check for 200", type of thing, I'd rather get an authoritative value back from the service itself.

[David Hergert _PAYX_ · Accepted solution]

In JIRA, you can hit the URL /status and it will return 

{
   state: "RUNNING"
}

and eventually in 7.1, it will also return "MAINTENANCE" if you are doing something like performing a foreground index. https://jira.atlassian.com/browse/JRA-46458

This is a nice way too since it does not require authentication and also does not create a session on the JIRA server unnecessarily. 

Confluence also has a /status page that returns the same result.

[dmitri]

Is there documentation on all possible responses from this endpoint?

So far we've observed:

• STARTING
• ERROR
• RUNNING
• MAINTENANCE

Mainly we're curious what to do when it's ERROR (generally this is on startup and seems to not necessarily recur on a restart).

[David Hergert _PAYX_]

For JIRA, doesn't appear there is much besides https://confluence.atlassian.com/enterprise/jira-data-center-load-balancer-examples-781200827.html.  

For Confluence, someone submitted https://jira.atlassian.com/browse/CONF-41395 which ended up getting the Load Balancing section of https://confluence.atlassian.com/enterprise/confluence-data-center-technical-overview-612959401.html updated.  I would assume the JIRA statuses are similar, if not identical.

I submitted a similar story just now (https://jira.atlassian.com/browse/JRA-63928) to possible bolster the documentation for JIRA's statuses.  But here are the ones from Confluence, and I am guessing they are similar.

HTTP Status Code	Response entity	Description
200	{"state":"RUNNING"}	Running normally
500	{"state":"ERROR"}	An error state
503	{"state":"STARTING"}	Application is starting
503	{"state":"STOPPING"}	Application is stopping
200	{"state":"FIRST_RUN"}	Application is running for the first time and has not yet been configured
404		Application failed to start up in an unexpected way (the web application failed to deploy)

[TimP · Accepted solution]

There isn't a formal status API that I'm aware of, but the AppLinks Manifest end-point is a good URL you can hit for most of our products (JIRA, Confluence, Stash, Bamboo, FishEye and Crucible). If it returns a 200, your server is probably in good shape.

It does not require authentication and is available at:

/rest/applinks/latest/manifest

in all products.

e.g.

https://jira.atlassian.com/rest/applinks/latest/manifest

https://confluence.atlassian.com/rest/applinks/latest/manifest

cheers,

Tim

[IT Support]

Thanks, I think this will work.

[Raj Adluru]

Tim Pettersen [Atlassian]

i tried above manifest, it is showing lot of other info, but not status.

how to get status of Bamboo and Crowd, like we get for JIRA and confluence - <url>/status ? if it is not there, can  you please add a enhancement request or let us know any workaround for this.

we need this, we use to show status of all our Atlassian apps.

Thanks for your help.

[Davin Studer]

Not really, but getting a 200 response from the site main page should be pretty authoritative, no?

[Brandon Parncutt]

A 200 from a page that makes a DB call and/or runs a basic health check would suffice...but any successfully loading page? I wouldn't call that a proper status check.