statcacheResult Structure Definition

The statcacheResult structure defines the return type for statcache API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

cacheList

Pointer to the cache List.


cachestats Structure Definition

The cachestats structure defines the actual return type values for statcache API.

Syntax



Members

clearstats

Clear the statsistics / counters

_nextgenapiresource


cachemaxmemorykb

Largest amount of memory the Citrix ADC can dedicate to caching, up to 50% of available memory. A 0 value disables caching, but the caching module continues to run.

cacherecentpercentsuccessfulrevalidation

Recently recorded percentage of times stored content was successfully revalidated by a 304 response rather than by a full response

cacherecentpercentstoreablemiss

Recently recorded ratio of store-able misses to all misses expressed as percentage.

cacherecentpercentparameterizedhits

Recently recorded ratio of parameterized 304 hits to all parameterized hits expressed as a percentage

cacherecentpercentoriginbandwidthsaved

Bytes served from cache divided by total bytes served to client. This ratio can be greater than 1 because of the assumption that all compression has been done in the Citrix ADC.

cacherecentpercenthit

Recently recorded cache hit ratio expressed as percentage

cacherecentpercentbytehit

Recently recorded cache byte hit ratio expressed as percentage. Here we define byte hit ratio as ((number of bytes served from the cache)/(total number of bytes served to the client)). This is the standard definition of Byte Hit Ratio. If compression is turned ON in NS then this ratio doesn't mean much. This might under or over estimate the origin-to-cache bandwidth saving (depending upon whether bytes served by CMP in Citrix ADC are more or less than compressed bytes served from the cache). If CMP is turned OFF in NS then this ratio is same as cacheRecentPercentOriginBandwidthSaved.

cacherecentpercent304hits

Recently recorded ratio of 304 hits to all hits expressed as percentage

cacheutilizedmemorykb

Amount of memory the integrated cache is currently using.

cachemaxmemoryactivekb

Currently active value of maximum memory

cache64maxmemorykb

Largest amount of memory the Citrix ADC can dedicate to caching, up to 50% of available memory. A 0 value disables caching, but the caching module continues to run.

cachepercentpethits

Percentage of cache hits in content groups that have Poll Every Time enabled, relative to all searches of content groups with Poll Every Time enabled.

cachetotpethits

Number of times a cache hit was found during a search of a content group that has Poll Every Time enabled.

cachepethitsrate

Rate of times a cache hit was found during a search of a content group that has Poll Every Time enabled.

cachepercentparameterized304hits

Percentage of parameterized 304 hits relative to all parameterized hits.

cachetotparameterizedhits

Parameterized requests resulting in either a 304 or non-304 hit.

cacheparameterizedhitsrate

Parameterized requests resulting in either a 304 or non-304 hit.

cachepercentsuccessfulrevalidation

Percentage of times stored content was successfully revalidated by a 304 (Object Not Modifed) response rather than by a full response

cachepercentstoreablemiss

Responses that were fetched from the origin, stored in the cache, and then served to the client, as a percentage of all cache misses.

cachetotfulltoconditionalrequest

Number of user-agent requests for a cached Poll Every Time (PET) response that were sent to the origin server as conditional requests.

cachefulltoconditionalrequestrate

Rate of user-agent requests for a cached Poll Every Time (PET) response that were sent to the origin server as conditional requests.

cachetotsuccessfulrevalidation

Total number of times stored content was successfully revalidated by a 304 Not Modified response from the origin.

cachesuccessfulrevalidationrate

Rate of times stored content was successfully revalidated by a 304 Not Modified response from the origin.

cachetotrevalidationmiss

Responses that an intervening cache revalidated with the integrated cache before serving, as determined by a Cache-Control: Max-Age header configurable in the integrated cache

cacherevalidationmissrate

Responses that an intervening cache revalidated with the integrated cache before serving, as determined by a Cache-Control: Max-Age header configurable in the integrated cache

cachetotnonstoreablemisses

Cache misses for which the fetched response is not stored in the cache. These responses match policies with a NOCACHE action or are affected by Poll Every Time.

cachenonstoreablemissesrate

Cache misses for which the fetched response is not stored in the cache. These responses match policies with a NOCACHE action or are affected by Poll Every Time.

cachetotstoreablemisses

Cache misses for which the fetched response is stored in the cache before serving it to the client. Storable misses conform to a built-in or user-defined caching policy that contains a CACHE action.

cachestoreablemissesrate

Cache misses for which the fetched response is stored in the cache before serving it to the client. Storable misses conform to a built-in or user-defined caching policy that contains a CACHE action.

cachecompressedbytesserved

Number of compressed bytes served from the cache

cachecompressedbytesservedrate

Rate of compressed bytes served from the cache

cachepercentbytehit

Bytes served from the cache divided by total bytes served to the client. If compression is On in the Citrix ADC, this ratio may not reflect the bytes served by the compression module. If the compression is Off, this ratio is the same as cachePercentOriginBandwidthSaved.

cachebytesserved

Total number of bytes served from the integrated cache

cachebytesservedrate

Rate of bytes served from the integrated cache

cachetotresponsebytes

Total number of HTTP response bytes served by Citrix ADC from both the origin and the cache

cacheresponsebytesrate

Rate of HTTP response bytes served by Citrix ADC from both the origin and the cache

cachepercent304hits

304 responses as a percentage of all responses that the Citrix ADC served.

cachenummarker

Marker objects created when a response exceeds the maximum or minimum size for entries in its content group or has not yet received the minimum number of hits required for items in its content group.

cachepercentoriginbandwidthsaved

Percentage of origin bandwidth saved, expressed as number of bytes served from the integrated cache divided by all bytes served. The assumption is that all compression is done in the Citrix ADC.

cachepercenthit

Cache hits as percentage of the total number of requests

cachetotmisses

Intercepted HTTP requests requiring fetches from origin server.

cachemissesrate

Intercepted HTTP requests requiring fetches from origin server.

cachetothits

Responses served from the integrated cache. These responses match a policy with a CACHE action.

cachehitsrate

Responses served from the integrated cache. These responses match a policy with a CACHE action.

cachetotrequests

Total cache hits plus total cache misses.

cachenumcached

Responses currently in integrated cache. Includes responses fully downloaded, in the process of being downloaded, and expired or flushed but not yet removed.

cachecurhits

This number should be close to the number of hits being served currently.

cachecurmisses

Responses fetched from the origin and served from the cache. Should approximate storable misses. Does not include non-storable misses.

cachetotnon304hits

Total number of full (non-304) responses served from the cache. A 304 status code indicates that a response has not been modified since the last time it was served

cachetot304hits

Object not modified responses served from the cache. (Status code 304 served instead of the full response.)

cachetotsqlhits

sql response served from cache

cachetotexpireatlastbyte

Instances of content expiring immediately after receiving the last body byte due to the Expire at Last Byte setting for the content group.

cacheexpireatlastbyterate

Instances of content expiring immediately after receiving the last body byte due to the Expire at Last Byte setting for the content group.

cachetotflashcachemisses

Number of requests to a content group with flash cache enabled that were cache misses. Flash cache distributes the response to all the clients in aqueue.

cacheflashcachemissesrate

Rate of requests to a content group with flash cache enabled that were cache misses. Flash cache distributes the response to all the clients in aqueue.

cachetotflashcachehits

Number of requests to a content group with flash cache enabled that were cache hits. The flash cache setting queues requests that arrive simultaneously and distributes the response to all the clients in the queue.

cacheflashcachehitsrate

Rate of requests to a content group with flash cache enabled that were cache hits. The flash cache setting queues requests that arrive simultaneously and distributes the response to all the clients in the queue.

cachetotparameterizedinvalidationrequests

Requests matching a policy with an invalidation (INVAL) action and a content group that uses an invalidation selector or parameters.

cacheparameterizedinvalidationrequestsrate

Requests matching a policy with an invalidation (INVAL) action and a content group that uses an invalidation selector or parameters.

cachetotnonparameterizedinvalidationrequests

Requests that match an invalidation policy where the invalGroups parameter is configured and expires one or more content groups.

cachenonparameterizedinvalidationrequestsrate

Requests that match an invalidation policy where the invalGroups parameter is configured and expires one or more content groups.

cachetotinvalidationrequests

Requests that match an invalidation policy and result in expiration of specific cached responses or entire content groups.

cacheinvalidationrequestsrate

Requests that match an invalidation policy and result in expiration of specific cached responses or entire content groups.

cachetotparameterizedrequests

Total number of requests where the content group has hit and invalidation parameters or selectors.

cacheparameterizedrequestsrate

Rate of requests where the content group has hit and invalidation parameters or selectors.

cachetotparameterizednon304hits

Parameterized requests resulting in a full response (not status code 304: Object Not Updated) served from the cache.

cachetotparameterized304hits

Parameterized requests resulting in an object not modified (status code 304) response.

cachetotpetrequests

Requests that triggered a search of a content group that has Poll Every Time (PET) enabled (always consult the origin server before serving cached data).

cachepetrequestsrate

Requests that triggered a search of a content group that has Poll Every Time (PET) enabled (always consult the origin server before serving cached data).

cacheerrmemalloc

Total number of times the cache failed to allocate memory to store responses.

cachelargestresponsereceived

Size, in bytes, of largest response sent to client from the cache or the origin server.

comptotaltxbytes

Number of bytes the Citrix ADC sends to the client after compressing the response from the server.

comptotalrxbytes

Number of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server.

httptotrxresponsebytes

Total number of bytes of HTTP response data received.

See Also