Monitor Cache Performance Using Client Statistics

You can monitor cache client statistics using the Get-CacheClientStatistics cmdlet which displays performance metrics for a specified cache. It provides a default list of performance counters that can be extended with custom counters. It helps you save the counters in a .CSV file which can be opened in Microsoft Excel. Moreover, the .CSV file can be converted to .BLG format for viewing counters in the Cache Performance Monitor.

Examples

  • The following command displays the default counters of the client for defaultCache from the local node.
Get-CacheClientStatistics -CacheName defaultCache
  • The following command displays the default counters for the cache defaultCache from the client nodes 20.200.20.11 and 20.200.20.12.
Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12"
  • The following command gets values of specified counter names alongside the default counters for defaultCache.
Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -CounterNames "Compression/sec"
  • The following command displays the values of the specified counter names for defaultCache and does not display the default counters.
Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -CounterNames "Compression/sec" -DoNotShowDefaultCounters
  • The following command gets the 50 samples from defined counters for defaultCache.
Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -CounterNames "Compression/sec" -MaxSamples 50
  • The following command gets values of counters for defaultCache continuously after every 5 seconds.
Get-CacheClientStatistics -CacheName defaultCache -Clients "20.200.20.11,20.200.20.12" `
                          -Continuous -SampleInterval 5
  • The following command gets values of default counters for defaultCache continuously after every 1 second and saves the output in csv format at the given location.
Get-CacheClientStatistics -CacheName defaultCache -Continuous `
                          -SampleInterval 1 -Format CSV | Out-File "C:\stats.csv" `
                          -Encoding ASCII
  • This command displays client statistics for defaultCache using mutual TLS (mTLS). It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Get-CacheClientStatistics -CacheName defaultCache -TlsCertPath "C:\certs\client.pem" `
                          -TlsCertPassword "clientKeyPassword"
  • The following command displays the default counters of the client for defaultCache from the local node using security credentials.
Get-CacheClientStatistics -CacheName defaultCache -Credentials(Get-Credential john_smith)

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters Data Types Description Default Value
-CacheName* <String> Specifies the name of the cache for which counters need to be fetched. -
-Clients <String> Specifies one or more client IP address(es) where the NCache Service is running and client node of specified cache is registered.
NOTE: Comma (,) separated client names are to be specified in case of multiple clients.		 Local Machine
-CounterNames <String> Specifies one or more counter name(s) for which the values should be displayed.
NOTE: Comma (,) separated counter names are to be specified in case of multiple counters. The Perfmon counters mentioned on this page can be fetched by this switch.		 -
-Continuous <SwitchParameter> Specified in order to get the statistics continuously. You can use the SampleInterval parameter to set the interval for continuous sampling. False
-DoNotShowDefaultCounters <SwitchParameter> Specifies whether default counters are to be shown.
NOTE: This should only be used when -CounterNames parameter is used.		 False
-Format <String> Specifies how the values of counters should be displayed. By default, its Tabular. The .CSV is recommended for output redirection to a file. This format can be converted to .blg which can be opened in Windows Performance Monitor. Tabular
-SampleInterval <Integer> Specifies the time between samples in seconds. Minimum value is 3 seconds. 3
-MaxSamples <Integer> Specifies the number of samples to get from each counter. To get samples continuously (no maximum sample size), use the Continuous parameter.
NOTE: The Continuous parameter and the MaxSamples parameter cannot be used in the same command. If sample interval is provided, it will take the next sample after that interval otherwise it will use the default value i.e., 3 seconds.		 1
-NoLogo <SwitchParameter> Suppresses display of the logo banner. False

See Also

Browse Cache Statistics
Monitor Cluster Connectivity
Monitor using Test Stress