feat(130): Introduces SEQREPO_FD_CACHE_MAXSIZE env var #131
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ternal fd_cache_size to allow for increased performance with forcing code changes to any SeqRepo clients.
andreasprlic
reviewed
Jan 9, 2024
| SEQREPO_FD_CACHE_MAXSIZE sets the lru_cache size for file handler caching during FASTA sequence retrievals. | ||
| It defaults to 0 to disable any caching, but can be set to a specific value or "none" to be unlimited. Using | ||
| a moderate value (>10) will greatly increase performance of sequence retrieval. | ||
|
|
There was a problem hiding this comment.
What is the downside of increasing this value?
There was a problem hiding this comment.
I think the only downside is in the potential for resource exhaustion on the system? But I'd defer to the discussion in #112 for additional information. Should I add a statement that states if the value is too large, there is a risk for exhaustion?
|
I think the mentioned setup issue will require a change similar to this. That appears to be a problem we need to fix across all biocommons packages. |
andreasprlic
deleted the
130-make-fd_cache_size-configureable-via-env-variable
branch
This was referenced Mar 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces
SEQREPO_FD_CACHE_MAXSIZEenv var to override the internalfd_cache_sizeto allow for increased performance without forcing code changes to any SeqRepo clients.Example:
We are using SeqRepo in an internal library and noticed a 10x decrease in performance with seqrepo 0.6.6 because the internal
fd_cache_sizeis being set to 0 ( no caching ). Rather than forcing clients of SeqRepo to set this value in code and release new versions, it'd be nice to control this value via an env var likeSEQREPO_LRU_CACHE_MAXSIZENote:
Now that there are two env vars, the old var
SEQREPO_LRU_CACHE_MAXSIZEfeels incorrectly named as it's unclear which LRU cache it's controlling. I didn't want to introduce any changes to existing code, but maybe this should be renamed to something likeSEQREPO_DB_CACHE_MAXSIZEor something to indicate what is being cached and deprecateSEQREPO_LRU_CACHE_MAXSIZEor allow the one env to control all the caches?Also is it worth providing a better default other than 0 (no cache)? Something small'ish like ~25 or so would at least give a significant performance boost without risking resource exhaustion