Advanced configuration
Other plugin settings.
Cache time
To speed up the issues rendering and reduce the network usage, the plugin relies on a in-memory cache.
The cache stores the issues data and the JQL search results. Every time a component is rendered, the plugin first check if the data is available in the cache and if not, it retrieves the data from the Jira server.
The items stored in the in-memory cache have an expiration date in order to periodically download updated information on the issues status and the search results. The default value is 15m.
The syntax used to fill this field must be compatible with the JavaScript library ms.
Examples
| Example | Description |
|---|---|
5s | 5 seconds |
1m | 1 minute |
2h | 2 hours |
1d | 1 day |
Request timeout
How long the plugin waits for Jira to answer a request. After that the request counts as failed, and issues, searches and counts show the last data loaded successfully, marked with a !. Without a timeout, a request sent on a connection that stopped working (for example right after switching VPN) could stay on "Loading ..." forever.
The default value is 20s. It uses the same syntax as the cache time, except that a number without unit means seconds. Values under 1 second are raised to 1 second, and values over about 25 days are lowered to that, the longest delay a timer supports. Increase it if large searches on a slow Jira server time out.
Saved issue data
To keep showing issues, searches and counts when Jira can't be reached, the plugin saves the last data it loaded successfully in issues-cache.json, in the plugin folder of your vault.
This file contains Jira data: issue keys, summaries and statuses, and for search tables the fields shown by their columns (for example descriptions, if the table has a description column). People are saved by display name only. Since the file is part of the vault, it is synced and backed up together with it.
Entries that could not be refreshed for 30 days are dropped, the file keeps at most 500 entries, and entries of removed accounts are dropped too. The Clear cache command empties the file.
Debug mode
In order to help users debug authentication issues and provide useful information when submitting new Issues on GitHub, the plugin provides a way to increase the debug information in the Obsidian.md console.
The Log Requests and Responses option allow to display in the console all the request and responses exchanged with the Jira Server.