Potential safeguards limit impact on worklogs visibility in Jira

Jira Development Jira Server
, ,
1

Hi,

We are working on a feature where we want to notify users about the possibility of not displaying all worklogs when Jira’s safeguards limit is hit. However, we’ve encountered two key questions in our investigation and would appreciate some insights:

  1. No missing data in developer instance: Despite testing on Jira versions 8.22.4 and 9.0.0 (where the default safeguard limit should be in place), we haven’t experienced any missing worklogs in our JQL search queries, even for issues with more than 100 worklogs. Is there a specific configuration or circumstance under which this limit is enforced? We expected some worklogs to not be indexed, but everything seems to be visible.
  2. Detecting when the limit is hit: In cases where the safeguards limit is hit and some worklogs are not indexed, how can we detect this? Specifically, if an issue is excluded entirely from a JQL search due to unindexed worklogs, is there any way to determine that the issue was skipped due to hitting the limit?

Any guidance would be greatly appreciated!

2

Hi Paulina,
I believe Jira will index the latest 100 change history items and worklogs

3

Hello Paulina,
Let’s me address your questions one by one:

No Missing Data in Developer Instance

It’s possible that the default safeguard limit isn’t enforced in your developer instance. The safeguard limits are configurable, and the default values might not be set1. To enforce the safeguard limit, you can configure it in Jira. Here’s how:

  1. Navigate to Jira Administration: Go to Administration > System.
  2. Advanced Settings: Select Advanced Settings.
  3. Configure Safeguards: Look for the jira.safeguards.indexing.issue.worklogs property and set it to a value that enforces the limit. The default value is usually 1001.

Detecting When the Limit is Hit

To detect when the safeguard limit is hit, you can monitor the audit logs and email notifications. Jira sends email notifications to System Administrators when the limit is reached or breached1. Additionally, you can check the audit logs for entries related to safeguard limit breaches.

Here’s a way to detect if an issue is excluded due to hitting the limit:

  1. Check Audit Logs: Look for entries related to safeguard limit breaches.
  2. Monitor Email Notifications: Set up email notifications to alert you when the limit is reached.
  3. Custom Monitoring: Implement custom monitoring in your application to check for these audit log entries or email notifications.

Maybe it helps :slight_smile:

Best regards,
Daniel