Monitor Cache Client Counters using PowerShell
Get-CacheClientStatistics cmdlet displays the statistics of the specified cache. When executed, this cmdlet by default, shows a list of performance counters that can be further extended to get a list of custom counters. You can save this list of counters in a .CSV file which can later be opened in Microsoft Excel. In addition to this, this .CSV file can be converted to a .BLG file to view counters in Performance Monitor.
Get-CacheClientStatistics [-CacheName] [-Clients] [-CounterNames] [-DoNotShowDefaultCounters] [-Continuous] [-Format] [-SampleInterval] [-MaxSamples] [-NoLogo]
Properties of Get-CacheClientStatistics
are explained in the Properties section.
Examples
- This command displays a list of all default counters for the cache demoCache from the default client node.
Get-CacheClientStatistics -CacheName demoCache
- This command displays a list of all default counters for demoCache from the 20.200.20.19 and 29.200.21.20 client nodes.
Get-CacheClientStatistics -CacheName demoCache -Clients "20.200.20.19,20.200.20.20"
- This command does not show any default counters and only shows the specified counters for demoCache.
Get-CacheClientStatistics -CacheName demoCache -DoNotShowDefaultCounters -CounterNames "Compression/sec"
- This command shows a list of both the default and specified counters for the demoCache.
Get-CacheClientStatistics -CacheName demoCache -CounterNames "Compression/sec"
- This command displays the default counters after evey default sample interval continuously for the cache demoCache.
Get-CacheClientStatistics -CacheName demoCache -Continuous
- This command displays default counters after an interval of 3 seconds continuously for the cache demoCache.
Get-CacheClientStatistics -CacheName demoCache -Continuous -SampleInterval 3
- This command displays output of both counters (default and specified) after an interval of 3 seconds continuously in a .CSV format for demoCache.
Get-CacheClientStatistics -CacheName demoCache -Continuous -SampleInterval 3 -Format csv
- This command saves the output of both counters (default and specified) after an interval of 3 seconds continuously in a .CSV file at the provided path for demoCache.
Get-CacheClientStatistics -CacheName demoCache -Continuous -SampleInterval 3 -Format csv | Out-File -Encoding ascii "C:\test.csv"
Properties
Note: The parameters with an asterisk (*) with 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 node name(s) where the NCache service is running 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(s) not included in default counters that 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. | - |
-DoNotShowDefaultCounters |
<SwitchParameter> |
Specifies whether default counters are to be shown. NOTE: This parameter is only valid if Counter Names are provided. |
False |
-Format |
<String> |
By default display format is tabular but it can be set to CSV, and that CSV output can be saved in CSV file for future use. | Tabular |
-SampleInterval |
<Integer> |
Specifies the time between samples in seconds. Minimum value is 3 seconds. | 1 |
-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
Verify Cache Health
Test-Stress Cache
PerfMon Counters
Monitor Cache Using PerfMon
Cache Logs