Maintenance
- 1 Summary
- 2 What is a maintenance period?
- 3 Configuring maintenance periods within JEMHC?
- 4 What happens during a scheduled maintenance period within JEMHC?
- 5 What JEMHC automated functions communicate with Jira?
- 6 How long are Completed maintenance periods shown in JEMHC?
- 7 How can JEMHC recover from missing Webhook events from issue updates during maintenance mode?
- 8 My maintenance period finished earlier than expected, I wish to resume processing
Summary
This page covers the maintenance behaviour of JEMHC, along with how to configure maintenance periods and what behaviour is covered during a maintenance period.
What is a maintenance period?
At times, Jira may request downtime of your site in order to perform upgrades. To do this, apps communicating with Jira will temporarily need to be paused. (Keep track of maintenance windows | Atlassian Support).
Configuring maintenance periods within JEMHC?
Navigate to JEMHC > Licensing > Maintenance
Select
+ Add
to add a new maintenance period, input the start date and end date.Save the configuration.
After saving, the new maintenance period will be shown. When the maintenance start date begins, the maintenance period will transition from
UPCOMING
toIN PROGRESS
, and JEMHC processes will be restricted until the maintenance period is complete.After the maintenance end date, the maintenance period will transition from
IN PROGRESS
toCOMPLETED
. JEMHC processes will resume shortly after the end date selected.
Field | Explanation |
---|---|
Maintenance Start Date | The start date of the maintenance period you wish to disable JEMHC for. Must be after the current time. |
Maintenance End Date | The end date of the maintenance period you wish to disable JEMHC for. Must be after the start date. |
Status | The status of the maintenance period. Either Automatically determined, cannot be configured. |
What happens during a scheduled maintenance period within JEMHC?
If a maintenance period has been scheduled, the next maintenance period will be shown at the top of the app:
During this time,
Mail handler polling will be disabled, meaning no new issues are created/updated until the maintenance period is complete.
Webhook event processing is disabled, meaning no outbound mail is processed.
Cleanup tasks for data such as audit events are not cleaned up until maintenance period has completed, allowing JEMHC to communicate with the Jira site again.
Note: In order to prevent issues near the start of the maintenance period, JEMHC will commence maintenance mode shortly before the start time provided to allow current processing tasks to gracefully complete before the maintenance period starts.
After the maintenance period end time, the disabled processes will return online during their next scheduled process - you do not need to manually re-enable this.
What JEMHC automated functions communicate with Jira?
There are a number of JEMHC features that communicate with your Jira site, primarily:
Mail polling - Polling mailboxes and creating/updating Jira issues requires the ability to access your Jira site using the Jira Cloud REST API.
Webhook Event Listening - When updates on Jira issues are made, any webhook events received (with a valid JEMHC email notification mapping) will cause JEMHC to process the webhook event (Allowing outbound email to be sent via JEMHC).
License validation and background tasks - Some regularly scheduled tasks, such as license validation or data privacy cleanup tasks require talking to the Jira site via REST APIs.
How long are Completed maintenance periods shown in JEMHC?
Maintenance periods that have completed maintenance will be removed during the monthly plan reset for your host, when the maintenance end date is older than 30 days.
Only maintenance configuration marked as COMPLETED
are purged.
For example, if a maintenance is scheduled for June 12th, 2am-3am, the maintenance will be listed as COMPLETED
for 30 days and will then be deleted at the start of the next plan refresh (In this example, would be August 1st).
How can JEMHC recover from missing Webhook events from issue updates during maintenance mode?
If webhook events are still triggered form your Jira site during the maintenance period (for example, from issue transitions, post function events, other Jira plugins/apps), JEMHC will not queue these events during maintenance periods.
How are webhooks processed when maintenance mode is enabled?
If the maintenance period finishes before the final retry attempt, JEMHC will process the event as normal when the maintenance period ends.
If the maintenance period is longer, we follow the retry policy of Atlassian webhooks, events that are not handled are retried up to 5 times. If all retry attempts are blocked due to the maintenance period, JEMHC will retrieve these events, known as “failed webhooks”, from the Jira Cloud REST API at it’s earliest convenience.
Failed webhooks are only available from Jira REST APIs for 72 hours.
If your maintenance period exceeds this, JEMHC may be unable to process webhooks triggered during the maintenance period.
My maintenance period finished earlier than expected, I wish to resume processing
To do this, navigate to JEMHC > Licensing > Maintenance, and delete the current maintenance that is marked as In Progress
.
Deleting this record will also delete the historic entry that you scheduled a JEMHC maintenance period. Only do this if you are certain that you can resume JEMHC processing sooner than initially configured.