Share via


LoadTestGoalBasedLoadProfile.InstanceName Property

Gets or sets the performance counter instance to monitor.

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

Syntax

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

Property Value

Type: System.String
The performance counter instance 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 of the 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 when 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

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