Azure PaaS Cache Optimization

> App Services benefit greatly from proper configuration

April 16, 2024

Cache yourself before you wreck yourself. - Cache Cube

Caching in Sitecore: the source of much confusion amongst developers and content authors alike.

The cache settings in Sitecore are a critical part of the performance tuning process, and they can be a bit tricky to get right. In this post, we'll cover the basics of caching in Sitecore and how to optimize your cache settings for Azure PaaS.

High Level Optimization Steps

Become familiar with the default cache sizes (the default cache sizes are smaller than what Sitecore recommends as a starting point)
Set Caching.DisableCacheSizeLimits to true on your local environment to get a feel for how large your caches naturally grow to
Review any existing optimizations that your solution may already have
Identify caches that are too small on your upstream environments
Push configuration changes to your environments
Monitor logs, memory usage, and database usage
Iterate and increase / decrease sizes as needed
Set up continuous monitoring or schedule regular reviews of cache sizes and infrastructure load

Search Application Insights for Offending Caches

The most reliable way to find the caches that are too small is to look at the logs in Application Insights. You can use the following Kusto Query Language (KQL) to find the offending caches:

union isfuzzy=true traces
| where timestamp > ago(90d)
| where message contains "DefaultScavengeStrategy"
| extend SubstringMessage = substring(message, 0, 65)
| extend Role = tostring(customDimensions["Role"])
| summarize Count=count(),
            MessageAny=take_any(message)
          by SubstringMessage, Role
| project Count, SubstringMessage, Role
| order by SubstringMessage asc, Count desc, Role desc

This query identifies which caches were automatically cleared via the DefaultScavengeStrategy due to hitting the max size limit, on which role (CM/CD), and how many times over the specified time period.

Mapping the Settings / Example Config

I did the hard work for you and did all the research required to map out which cache names on cache.aspx map to which settings in the Sitecore configuration. This config also separates out the cache sizes by role and database.

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"
			   xmlns:role="http://www.sitecore.net/xmlconfig/role/"
			   xmlns:set="http://www.sitecore.net/xmlconfig/set/">
	<sitecore>
		<databases>
			<database id="web">
				<cacheSizes role:require="ContentDelivery">
				  <!-- web[paths] -->
				  <paths>4MB</paths>
				  <!-- web[standardValues] -->
				  <standardValues>4MB</standardValues>
				</cacheSizes>
				<cacheSizes role:require="ContentManagement or ContentDelivery">
					<!-- web[items] -->
					<items>760MB</items>
				</cacheSizes>
				<dataProviders>
					<dataProvider>
						<param desc="headProvider">
							<dataProvider>
								<prefetch>
									<!-- SqlDataProvider - Prefetch data(web) -->
									<cacheSize>870MB</cacheSize>
								</prefetch>
							</dataProvider>
						</param>
					</dataProvider>
				</dataProviders>
			</database>
			<database id="master" role:require="ContentManagement">
				<cacheSizes>
					<!-- master[items] -->
					<items>760MB</items>
					<!-- master[data] -->
					<data>170MB</data>
					<standardValues>4MB</standardValues>
					<!-- master[itempaths] NOTE: itempaths needs to remain fully lowercase to work -->
					<itempaths>75MB</itempaths>
				</cacheSizes>
				<dataProviders>
					<dataProvider>
						<param desc="headProvider">
							<dataProvider>
								<prefetch>
									<!-- SqlDataProvider - Prefetch data(master) -->
									<cacheSize>1000MB</cacheSize>
								</prefetch>
							</dataProvider>
						</param>
					</dataProvider>
				</dataProviders>
			</database>
		</databases>
		<settings role:require="ContentDelivery">
			<!-- Log singles -->
			<setting name="Caching.SmallCacheSize" value="2MB" />
		</settings>
		<settings role:require="ContentManagement">
			<!-- QueryStringCache -->
			<setting name="Caching.TinyCacheSize" value="300KB" />
			<!-- clientData -->
			<setting name="Caching.DefaultClientDataCacheSize" value="30MB"/>
		</settings>
		<settings role:require="ContentManagement or ContentDelivery">
			<!-- master[isLanguageFallbackValid], web[isLanguageFallbackValid] -->
			<setting name="Caching.IsFallbackValid.DefaultCacheSize" value="30MB" />
			<!-- AccessResultCache -->
			<setting name="Caching.AccessResultCacheSize" value="1000MB" />
		</settings>
		<sites>
			<site name="shell" role:require="ContentManagement">
				<!-- shell[viewState] -->
				<patch:attribute name="viewStateCacheSize">1600KB</patch:attribute>
			</site>
		</sites>
	</sitecore>
</configuration>

Adjust as needed for your solution.

Decimals don't work in cache sizes. Sitecore essentially performs a string replace on dots within values, so if you use decimals, your cache size will be set to at least 10x more than you were intending.

Stay cachey, San Diego.

-MG

Azure PaaS Cache Optimization

High Level Optimization Steps

Search Application Insights for Offending Caches

Mapping the Settings / Example Config

More Stories