SPDiagnosticsService members

Provides a diagnostic-logging category manager for Microsoft SharePoint Foundation.

The SPDiagnosticsService type exposes the following members.

Constructors

	Name	Description
	SPDiagnosticsService()	This member is reserved for internal use and is not intended to be used directly from your code.
	SPDiagnosticsService(String, SPFarm)	Initializes a new instance of the SPDiagnosticsService class based on the specified service name and server farm.

Top

Properties

	Name	Description
	AllowLegacyTraceProviders
	AppAnalyticsAutomaticUpload
	Applications	Gets the collection of service applications associated with the service. (Inherited from SPService.)
	Areas	Gets a collection of all areas in this SPDiagnosticsService object. (Inherited from SPDiagnosticsServiceBase.)
	AutoProvision	Available in SharePoint 2016 and later. Gets (and in some scenarios sets) a Boolean value that indicates whether the service is enabled on the farm. (Inherited from SPService.)
	CanBackupRestoreAsConfiguration	Gets a value that indicates whether the service object can be selected for inclusion in a configuration-only backup or restore operation. (Inherited from SPDiagnosticsServiceBase.)
	CanRenameOnRestore	Gets a Boolean value that indicates whether the service object can be renamed when it is restored. (Inherited from SPDiagnosticsServiceBase.)
	CanSelectForBackup	Gets or sets a Boolean value that indicates whether the SPDiagnosticsServiceBase object can be selected for a backup operation in the Central Administration user interface (UI). (Inherited from SPDiagnosticsServiceBase.)
	CanSelectForRestore	Gets or sets a Boolean value that indicates whether the SPDiagnosticsServiceBase object can be selected for a restore operation in the Central Administration user interface (UI). (Inherited from SPDiagnosticsServiceBase.)
	CanUpgrade	Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
	CEIPEnabled	Gets or sets the Boolean value to indicate if Customer Experience Improvement Program (CEIP) data collection is used on the server farm.
	CEIPQoSEnabled
	CEIPQoSExtractCriterias
	CEIPQoSExtractionEnabled
	ClientPerformanceMeasurementEnabled
	CompliantWithMinRole	(Inherited from SPService.)
	CorrelationVisibleID	Gets the logging correlation identifier in the current thread. (Inherited from SPDiagnosticsServiceBase.)
	DaysToKeepLogs	Gets or sets the number of days to store log files.
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	(Overrides SPService.Description.)
	DiskSizeRequired	Gets the disk space that is required for a backup. (Inherited from SPDiagnosticsServiceBase.)
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	DownloadErrorReportingUpdates	Gets or sets a Boolean value to indicate if crash data collection and error reporting updates are automatically downloaded.
	ErrorReportingAutomaticUpload
	ErrorReportingEnabled	Gets or sets a Boolean value to indicate whether crash data collection and error reporting is enabled.
	EventLogFloodProtectionEnabled	Gets or sets a Boolean value to indicate whether Event Log Flood Protection is enabled.
	EventLogFloodProtectionNotifyInterval	Gets or sets the interval, in minutes, when a notification that was suppressed by flooding of the log will be fired, even if the flooding continues.
	EventLogFloodProtectionQuietPeriod	Gets or sets the interval, in minutes, without a specific event being logged before the flooding mode for that event will be canceled.
	EventLogFloodProtectionThreshold	Gets or sets the number of events permitted in the specified EventLogFloodProtectionTriggerPeriod timeframe until this event is considered to be flooding the log.
	EventLogFloodProtectionTriggerPeriod	Gets or sets the timeframe, in minutes, in which the threshold, EventLogFloodProtectionThreshold, must be exceeded in order to trigger log flooding mode.
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Hidden	(Overrides SPService.Hidden.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	Instances	Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
	IsBackwardsCompatible	Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
	JobDefinitions	Gets a collection of job definitions for this service. (Inherited from SPService.)
	JobHistoryEntries	Gets an enumeration of the job history entries for this service. (Inherited from SPService.)
	Local	Gets an object that represents the instance of the Diagnostics Service that is currently running in the server farm.
	LogCutInterval	Gets or sets the number of minutes to capture events to a single log file.
	LogDiskSpaceUsageGB	Gets or sets the maximum storage space to use for logs.
	LogLocation	Gets or sets the path to the file system directory where log files are created.
	LogMaxDiskSpaceUsageEnabled	Gets or sets a Boolean value that indicates whether to restrict the maximum amount of storage to use for logging.
	LogsToKeep	Obsolete. Gets or sets a value that indicates the maximum number of log files to create.
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	NeedsUpgrade	Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
	NeedsUpgradeIncludeChildren	Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	Required	Gets a Boolean value that indicates whether an instance of the service must be running on at least one computer in the server farm. (Inherited from SPService.)
	ResourceDll	(Overrides SPDiagnosticsServiceBase.ResourceDll.)
	RunningJobs	Gets a collection of running jobs for this service. (Inherited from SPService.)
	ScriptErrorReportingDelay
	ScriptErrorReportingEnabled	Gets or sets a Boolean value to indicate whether ECMAScript (JScript, JavaScript) error reporting is enabled within the end user's browser session.
	ScriptErrorReportingRequireAuth
	ShouldDeferUpgradeActions	(Inherited from SPPersistedUpgradableObject.)
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	SystemService	(Inherited from SPService.)
	TypeName	Gets the friendly name for the service. (Overrides SPPersistedObject.TypeName.)
	UlsCapSid
	UpgradeContext	Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	WasCreated	Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

	Name	Description
	AddBackupObjects	Adds the SPDiagnosticesServiceBase object to the backup/restore operation. (Inherited from SPDiagnosticsServiceBase.)
	Clone	Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
	CreateTimerJob	Creates a timer job to update the service configuration, based on the configuration that is stored in the content database.
	Delete	Removes the service and associated resources. (Inherited from SPService.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetCreateApplicationLink	Gets the administration user interface link that is used to create a new service application. (Inherited from SPService.)
	GetCreateApplicationOptions	Gets the options for creating a new service application. (Inherited from SPService.)
	GetFirstPreconfiguredDatabase	(Inherited from SPService.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetItem(Int32)	Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
	GetItem(String)	Obsolete. Returns an IDiagnosticsLevel object that represents a reporting category with a specified name.
	GetItems	Obsolete. Gets a collection of all categories registered with the server farm.
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetPreconfiguredDatabaseInfo	(Inherited from SPService.)
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	Invalidate	Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
	IsUserLicensedForEntity	Checks if the current user has the proper license to access the specified entity. (Inherited from SPService.)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	LocalToFarm	Returns an instance of the SPDiagnosticsService class that is associated with the specified SPFarm object.
	MemberwiseClone	(Inherited from Object.)
	OnAbort	Raises the Abort event. (Inherited from SPDiagnosticsServiceBase.)
	OnBackup	(Overrides SPDiagnosticsServiceBase.OnBackup(Object, SPBackupInformation).)
	OnBackupComplete	Raises the BackupComplete event. (Inherited from SPDiagnosticsServiceBase.)
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPostRestore	Raises the PostRestore event. (Inherited from SPDiagnosticsServiceBase.)
	OnPreCreate	(Overrides SPPersistedObject.OnPreCreate().)
	OnPrepareBackup	Raises the PrepareBackup event. (Inherited from SPDiagnosticsServiceBase.)
	OnPreRestore	Raises the PreRestore event. (Inherited from SPDiagnosticsServiceBase.)
	OnRestore	(Overrides SPDiagnosticsServiceBase.OnRestore(Object, SPRestoreInformation).)
	ProvideAreas	(Overrides SPDiagnosticsServiceBase.ProvideAreas().)
	Provision	Makes the necessary changes to the local server to use the SPDiagnosticsService object. (Overrides SPPersistedObject.Provision().)
	ResetAll	Resets reporting thresholds for all categories to their diagnostic logging thresholds. (Inherited from SPDiagnosticsServiceBase.)
	ResetItem(Int32)	Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
	ResetItem(IDiagnosticsLevel)	Obsolete. Resets the default reporting thresholds for a category that is specified by an IDiagnosticsLevel object.
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	SetAll(EventSeverity)	Sets the threshold at which events associated with all categories are written to the event log. (Inherited from SPDiagnosticsServiceBase.)
	SetAll(TraceSeverity)	Sets the threshold at which traces associated with all categories are written to the trace log. (Inherited from SPDiagnosticsServiceBase.)
	SetAll(TraceSeverity, EventSeverity)	Sets the threshold at which traces and Windows events associated with all categories are written to trace logs and the Windows event log. (Inherited from SPDiagnosticsServiceBase.)
	SetItem(Int32, TraceSeverity, EventSeverity)	Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
	SetItem(IDiagnosticsLevel, TraceSeverity, EventSeverity)	Obsolete. Sets the reporting thresholds for a category that is specified by an IDiagnosticsLevel object.
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	Update()	Causes the SPDiagnosticsService object to save its state and propagate changes to all servers in the server farm. (Overrides SPDiagnosticsServiceBase.Update().)
	Update(Boolean)	Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Upgrade()	Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
	Upgrade(Boolean)	Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
	Validate	Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
	ValidateBackwardsCompatibility	Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)
	WriteEvent	Writes an event to the Windows application event log, if the event severity is above the configured threshold for the SPDiagnosticsCategory. (Inherited from SPDiagnosticsServiceBase.)
	WriteTrace	Writes a trace to the Microsoft SharePoint Foundation trace log. (Inherited from SPDiagnosticsServiceBase.)

Top

Explicit interface implementations

	Name	Description
	IBackupRestore.Name	Gets or sets the name for the SPDiagnosticsServiceBase object. (Inherited from SPDiagnosticsServiceBase.)

Top

See also

Reference

SPDiagnosticsService class

Microsoft.SharePoint.Administration namespace