Measure-CachePerformance
This PowerShell cmdlet measures and reports the performance of cache operations for a specified cache. It gives insight into the cache's efficiency by displaying the key metrics such as ReadWriteRatio, ThreadCount, and Duration. It is different from the Test-Stress cmdlet, as the output includes average Read/Write time and Requests/sec.
Warning
The performance metrics provided are indicative and reflect the relative performance of the NCache server under the specified test conditions. Actual performance may vary due to factors such as machine hardware, network conditions, and the nature of the data being processed.
Measure-CachePerformance -CacheName -Server `
[-ObjectSize] [-ReadWriteRatio] `
[-Duration] [-ThreadCount] `
[-TlsCertPath] [-TlsCertPassword] `
[-AbsoluteExpiration] [-Credentials]
Examples
- This command measures performance of a cache named defaultCache on server 20.200.20.11 with default settings of object size 100 bytes, read-write ratio 4, duration 120 seconds, thread count 1, and absolute expiration 300 seconds.
Measure-CachePerformance -Server 20.200.20.11 -CacheName defaultCache
- This command measures performance of the defaultCache with object size 10 bytes, read-write ratio 4, duration 60 seconds, and thread count 1.
Measure-CachePerformance -Server 20.200.20.11 -CacheName defaultCache `
-ObjectSize 10 -Duration 60
- This command measures performance of the defaultCache with object size 5 bytes, read-write ratio 3, duration 30 seconds, and thread count 10.
Measure-CachePerformance -Server 20.200.20.11 -CacheName defaultCache `
-ObjectSize 5 -ReadWriteRatio 3 `
-Duration 30 -ThreadCount 10
- This command measures the performance of defaultCache on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses
C:\certs\client.pemto authenticate the machine running the cmdlet. The-TlsCertPasswordparameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Measure-CachePerformance -Server "20.200.20.11" -CacheName defaultCache `
-TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
- This command measures performance of a cache named defaultCache on server 20.200.20.11 with default settings of object size 100 bytes, read-write ratio 4, duration 120 seconds, thread count 1, and absolute expiration 300 seconds, using security credentials.
Measure-CachePerformance -Server 20.200.20.11 -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 you want to measure performance. | - |
-Server* |
<String> |
Specifies one or more server IP addresses where the cache is running. | IP of local machine |
-ObjectSize |
<Integer> |
Specifies the size of objects in bytes to be used in the performance test. | 100 |
-ReadWriteRatio |
<Integer> |
Specifies the ratio of read to write operations. | 4 |
-Duration |
<Integer> |
Specifies the duration in seconds for which the performance test should run. The value can range from 1-2147483647. | 120 |
-ThreadCount |
<Integer> |
Specifies the number of threads to be used for the test. | 1 |
-AbsoluteExpiration |
<Double> |
Specifies absolute expiration for a cache item in seconds. | 300 seconds |
-Credentials |
<pscredential> |
Specifies the user credentials required to authorize access for the specified operation. The credentials should belong to a user with appropriate permissions at the node. | - |
-TlsCertPath |
<string> |
Specifies the path to the client PEM certificate used to authenticate this cmdlet when the target NCache server requires Mutual TLS. This parameter is required for Mutual TLS connections even when the cmdlet runs on an NCache server. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. Relative paths are resolved against the current PowerShell location, and the file must exist. You can generate a client certificate using New-NCacheTlsCertificate. | - |
-TlsCertPassword |
<string> |
Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration. |
- |