Identify and Resolve Vault render cache issues
UPDATED: September 7, 2017
Identify and Resolve Vault render cache issues
Rendering Engine cache mechanism is used to improve Rendering Engine performance. There are types of cache, one is for local cache, another one is for global render cache. See below descriptions.
Rendering Engine Cache types and settings
1. Cache component enable/disable setting
maxagesuccess : Maximum cache age for a “hit” to be considered valid instead of re-executing the command. Setting maxagesuccess=0 effectively disables the cache, which can be
useful in testing or troubleshooting, but should not be used in production for
Maxagefailure : Maximum cache age for a cached “failure” message to be considered valid instead of re-executing the command.
size : Size of the cache in Megabytes.
debug : Enable debug logging messages.
2. Rendering cache filtering
This enables you to control some of the elements that are stored in various Vault cache lists. Cache filtering allows you to specify which Vault data elements will not be cached for a Vault server, renderer, router, or loader.
The settings are inside ini files respectively ( e2renderd.ini -> [cache1], e2serverd.ini-> [cache1], ...)
For rendering engine :
filter.storage.docdata: if set to 1, results of requests for the report list and properties of a document are not cached.
filter.storage.docpage: if set to 1, the raw internal data for a document page is not cached.
filter.storage.filedata: if set to 1, the metadata associated with a compressed file is not cached.
filter.storage.filepage: if set to 1, the raw page data from a compressed file is not cached.
filter.render.transform: if set to 1, then the results of a render request will not be cached. Examples of this include PDF output, GIF output and text.
The default values of the above parameters are 0 .
3. Rendering Engine Resources cache
Separating resources from the base directory. The resource component can redirect the location it uses to store resource sets at the rendering engine. This is useful if you want to separate resources from the base directory.
The directory can be controlled by setting the subdir= setting on the resource component in the rendering engine's “.ini” file.
By default, resource set directories will be created in the same directory as the rendering engine executable (equivalent to subdir being the empty string).
Setting the maximum size of the rendering resource cache
The rendering resource cache is primarily used to manage font-related resources. The default size of the cache is 256MB. If you use a large number of font resources, consider increasing the size of the cache to reduce swapping of font resources that are contained in memory. The size of the rendering resource cache should be balanced to avoid running out of memory for rendering and font resources.
To change the cache size, add this setting:
resourcecachesize= 256 (default size in megabytes, minimum of 1)
4. JPEG image cache
The Vault rendering component uses a cache to improve rendering performance of JPEG compressed images. This cache resides in the cache directory and contains decoded (.vjd) and encoded (.vje) image files. Normally, this cache is persistent and accumulates image files over time. In many cases, the Vault images store reaches its limit and never grows beyond that point. However, some installations make use of features that create document-specific images. Features like this include attachments and advanced charts. Since these images are created per document, the total number of images stored in the cache grows quickly, consuming more disk space than is desirable. To prevent this, cached files can be removed. If the image is needed again, the rendering process regenerates the files. To automate this process, set the grooming process to scan the cached image files and remove unused images.
JPEGCacheGroomRetention=<N> This setting controls how long in hours cached items are retained in the JPEG image cache (default: disabled).
JPEGCacheGroomInterval=<N> This setting controls how long in hours between JPEG cache grooming cycles (default: 24).
JPEGCacheGroomDebug=0/1 When set to 1, the JPEG image cache logs more details of the cached items being removed (default : 0)
For example, to groom the image store every two days and remove cached images older than 10 days:
Edit e2renderd.ini as follows:
When the grooming process runs, the e2renderd log file records the results:
12:25:26 <render1> begin jpeg cache grooming, retention 
12:25:59 <render1> end jpeg cache grooming, total files , total bytes , deleted files , deleted bytes , elapsed 
5. Rendering Engine Global cache
The Rendering Engine converts mainframe documents into image formats, such as GIF, PDF,
TIFF and so on. Multiple Rendering Engines can be configured on the same machine or across
a network. Each Rendering Engine has a local cache mechanism, but the cache is only for the
Rendering Engine that defined the local cache.
The Rendering Engine global cache spans multiple Rendering Engines for reusing and sharing
rendered documents across all of the Rendering Engines.
Global Render Cache settings
(1). Global Rendering Cache settings are based on the [render1] section in e2renderd.ini.
(2). The naming convention is:
- the prefix of GlobalCache is for global render cache settings.
- the prefix of GlobalCacheGroom is for global render cache grooming settings.
(3). The settings in the [render1] section in e2renderd.ini should match across all Rendering
(4). In a multi-renderer environment, only one renderer should be set up for global cache
grooming and the others should disable grooming.
Global Render Cache parameters
GlobalCacheEnable: Enable global render cache feature, 0=disabled, 1=enabled. The default is 0.
GlobalCacheDebug: Display/log debug message, 0=disable display/log messages (quiet mode), 1=enabled (verbose mode). The default is 0.
GlobalCachePath: The global render cache path. There is no default.
GlobalCacheRetryCount: The number of times a rendering engine tests to see if a document is finished rendering to the global cache. The default is 3.
GlobalCacheRetryInterval: Global render cache retry interval when trying to read a cached file. the default is 5 seconds.
GlobalCacheMaxPageCount: Controls global render cache when real page count is less than or equal to GlobalCacheMaxPageCount. See notes below for more information.
GlobalCacheMinPageCount: Controls to do cache when real page count is greater than or equal to GlobalCacheMinPageCount. See notes below for more information.
GlobalCacheMaxPageCount and GlobalCacheMinPageCount parameters work together to control these scenarios and order. Supports PDF output only.
(1). if both GlobalCacheMaxPageCount and GlobalCacheMinPageCount are defined, and the values are valid (the values are great than 0 and GlobalCacheMaxPageCount is great than GlobalCacheMinPagecount), then do cache when the real page count is inside the range of [GlobalCacheMinPageCount, GlobalCacheMaxPageCount]; otherwise will not do cache.
(2). if only GlobalCacheMinPageCount is defined, and the value is valid (>0), then do cache when the real page count is great than and equals to GlobalCacheMinPageCount; otherwise will not do cache
(3). if only GlobalCacheCacheMaxPageCount is defined, and the value is valid (>0), then do cache when the real page count is less than and equals to GlobalCacheMaxPageCount; otherwise will not do cache.
(4). if anyone or both of GlobalCacheMaxPageCount and GlobalCacheMinPageCount are defined, then it is to do cache as always, this is default.
Global Render Cache Grooming settings
GlobalCacheGroomEnable: Enables feature, 0=disabled, 1=enabled. The default is 1.
GlobalCacheGroomDebug: Display/log debug message, 0=disable display/log messages (quiet mode), 1=enabled (verbose mode). The default is 0.
GlobalCacheGroomStartupClean: Set whether a grooming cycle should be attempted when the rendering engine first starts. 0=disabled, 1=enabled. The default is 0; when enabled, the start of the rendering component may be delayed if there are a large number of files to groom.
GlobalCacheGroomInterval: The number of intervals between render cache grooming attempts. The elapsed time depends on GlobalCacheGroomIntervalScale value. The default value is 24.
GlobalCacheGroomIntervalScale: The interval scale unit of GlobalCacheGroomInterval. The unit is seconds and the default value is 3600 (one hour).
GlobalCacheGroomRetention: The retention period in hours. Files selected for grooming if they are older than the retention time. The default is 24.
(1). Global Render Cache requires these two parameters for minimum operation:
(2). The default setting for GlobalCacheGroomEnable is 1 (enabled). However, when GlobalCacheEnable is 0 (disabled), GlobalCacheGroomEnable will be 0 (disabled).
- No Downloads