Get-SPDiagnosticsPerformanceCounter

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Returns a collection of performance counters.

Syntax

Get-SPDiagnosticsPerformanceCounter
   [-AssignmentCollection <SPAssignmentCollection>]
   [-DatabaseServer]
   [-WebFrontEnd]
   [<CommonParameters>]

Description

The Get-SPDiagnosticsPerformanceCounter cmdlet returns the collection of performance counters that are read and recorded in the usage database. If neither the DatabaseServer or WebFrontEnd parameters are specified, this cmdlet returns the performance counters on the front end Web servers and database servers in the farm.

To distinguish counters that are collected on database servers and counters that are collected on front end Web servers, note that counters that are collected on database servers have a Provider Name of job-diagnostics-performance-counter-sql-provider, and counters that are collected on front end Web servers have a Provider Name of job-diagnostics-performance-counter-wfe-provider.

The Get-SPDiagnosticsPerformanceCounter cmdlet is only available by using Windows PowerShell. There is no user interface.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

------------------EXAMPLE 1------------------

Get-SPDiagnosticsPerformanceCounter

This example gets the performance counter settings for front end Web servers and database servers.

------------------EXAMPLE 2------------------

Get-SPDiagnosticsPerformanceCounter -WebFrontEnd

This example gets the performance counter settings for front end Web servers.

------------------EXAMPLE 3------------------

Get-SPDiagnosticsPerformanceCounter -DatabaseServer

This example gets the performance counter settings for database servers.

Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-DatabaseServer

Returns performance counters collected for the database servers in the farm.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WebFrontEnd

Returns performance counters collected for the front end Web servers in the farm.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Share via