Share via


LoadTestGoalBasedLoadProfile.CounterName Property

Gets or sets the performance counter to monitor.

Namespace:  Microsoft.VisualStudio.TestTools.LoadTesting
Assembly:  Microsoft.VisualStudio.QualityTools.LoadTestFramework (in Microsoft.VisualStudio.QualityTools.LoadTestFramework.dll)

Syntax

'Declaration
Public Property CounterName As String
public string CounterName { get; set; }
public:
property String^ CounterName {
    String^ get ();
    void set (String^ value);
}
member CounterName : string with get, set
function get CounterName () : String 
function set CounterName (value : String)

Property Value

Type: String
The name of the performance counter to monitor.

Remarks

CategoryName, CounterName, InstanceName, and MachineName are the performance counter identifier properties. These properties combine to identify an instance of a performance counter to collect. Any or all of the performance counter identifier properties for a GoalBasedLoadProfile can be changed when a new GoalBasedLoadProfile is assigned by a plug-in.

However, if the performance counter that is specified cannot be collected because it does not exist or because it lacks the required permissions, an error is reported and the current load profile settings remain in effect.

Changes to any properties of any of the LoadTestLoadProfile classes must all be made before you assign the LoadTestLoadProfile object to the LoadProfile property of the LoadTestScenario. After the LoadTestLoadProfile object has been assigned to the LoadProfile property, it becomes a read-only version. An exception will be thrown if you try to set any properties of the LoadProfile object while it is in the read-only state. To get a new writable LoadProfile object, call the Copy() method, as shown in the example under LoadTestGoalBasedLoadProfile.

Examples

An example counter category that can be monitored is Requests/Sec.

To monitor the processor time that is used by SQL Server, set MachineName to the name of the computer that is running SQL Server, set CategoryName to Process, set CounterName to % Processor Time, and set InstanceName to sqlservr.

.NET Framework Security

See Also

Reference

LoadTestGoalBasedLoadProfile Class

Microsoft.VisualStudio.TestTools.LoadTesting Namespace