SPDiagnosticsService Members

  • Article

Include Protected Members
Include Inherited Members

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

The SPDiagnosticsService type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AllowLegacyTraceProviders
Public property Applications Gets the collection of service applications associated with the service. (Inherited from SPService.)
Public property Areas Gets a collection of all areas in this SPDiagnosticsService object. (Inherited from SPDiagnosticsServiceBase.)
Public property 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.)
Public property CanRenameOnRestore Gets a Boolean value that indicates whether the service object can be renamed when it is restored. (Inherited from SPDiagnosticsServiceBase.)
Public property 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.)
Public property 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.)
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property CEIPEnabled Gets or sets the Boolean value to indicate if Customer Experience Improvement Program (CEIP) data collection is used on the server farm.
Public property DaysToKeepLogs Gets or sets the number of days to store log files.
Public property DiskSizeRequired Gets the disk space that is required for a backup. (Inherited from SPDiagnosticsServiceBase.)
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property DownloadErrorReportingUpdates Gets or sets a Boolean value to indicate if crash data collection and error reporting updates are automatically downloaded.
Public property ErrorReportingAutomaticUpload
Public property ErrorReportingEnabled Gets or sets a Boolean value to indicate whether crash data collection and error reporting is enabled.
Public property EventLogFloodProtectionEnabled Gets or sets a Boolean value to indicate whether Event Log Flood Protection is enabled.
Public property 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.
Public property EventLogFloodProtectionQuietPeriod Gets or sets the interval, in minutes, without a specific event being logged before the flooding mode for that event will be canceled.
Public property EventLogFloodProtectionThreshold Gets or sets the number of events permitted in the specified EventLogFloodProtectionTriggerPeriod timeframe until this event is considered to be flooding the log.
Public property EventLogFloodProtectionTriggerPeriod Gets or sets the timeframe, in minutes, in which the threshold, EventLogFloodProtectionThreshold, must be exceeded in order to trigger log flooding mode.
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property Instances Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property JobDefinitions Gets a collection of job definitions for this service. (Inherited from SPService.)
Public property JobHistoryEntries (Inherited from SPService.)
Public propertyStatic member Local Gets an object that represents the instance of the Diagnostics Service that is currently running in the server farm.
Public property LogCutInterval Gets or sets the number of minutes to capture events to a single log file.
Public property LogDiskSpaceUsageGB Gets or sets the maximum storage space to use for logs.
Public property LogLocation Gets or sets the path to the file system directory where log files are created.
Public property LogMaxDiskSpaceUsageEnabled Gets or sets a Boolean value that indicates whether to restrict the maximum amount of storage to use for logging.
Public property LogsToKeep Obsolete. Gets or sets a value that indicates the maximum number of log files to create.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property NeedsUpgrade Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property 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.)
Protected property ResourceDll (Overrides SPDiagnosticsServiceBase.ResourceDll.)
Public property RunningJobs Gets a collection of running jobs for this service. (Inherited from SPService.)
Public property ScriptErrorReportingDelay
Public property ScriptErrorReportingEnabled Gets or sets a Boolean value to indicate whether ECMAScript (JScript, JavaScript) error reporting is enabled within the end user's browser session.
Public property ScriptErrorReportingRequireAuth
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the friendly name for the service. (Overrides SPPersistedObject.TypeName.)
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property 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
Public method AddBackupObjects Adds the SPDiagnosticesServiceBase object to the backup/restore operation. (Inherited from SPDiagnosticsServiceBase.)
Public method 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.)
Public method CreateTimerJob Creates a timer job to update the service configuration, based on the configuration that is stored in the content database.
Public method Delete Removes the service and associated resources. (Inherited from SPService.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetCreateApplicationLink (Inherited from SPService.)
Public method GetCreateApplicationOptions (Inherited from SPService.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetItem(Int32) Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
Public method GetItem(String) Obsolete. Returns an IDiagnosticsLevel object that represents a reporting category with a specified name.
Public method GetItems Obsolete. Gets a collection of all categories registered with the server farm.
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public methodStatic member LocalToFarm Returns an instance of the SPDiagnosticsService class that is associated with the specified SPFarm object.
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAbort Raises the Abort event. (Inherited from SPDiagnosticsServiceBase.)
Public method OnBackup (Overrides SPDiagnosticsServiceBase.OnBackup(Object, SPBackupInformation).)
Public method OnBackupComplete Raises the BackupComplete event. (Inherited from SPDiagnosticsServiceBase.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Public method OnPostRestore Raises the PostRestore event. (Inherited from SPDiagnosticsServiceBase.)
Public method OnPrepareBackup Raises the PrepareBackup event. (Inherited from SPDiagnosticsServiceBase.)
Public method OnPreRestore Raises the PreRestore event. (Inherited from SPDiagnosticsServiceBase.)
Public method OnRestore (Overrides SPDiagnosticsServiceBase.OnRestore(Object, SPRestoreInformation).)
Protected method ProvideAreas (Overrides SPDiagnosticsServiceBase.ProvideAreas().)
Public method Provision Makes the necessary changes to the local server to use the SPDiagnosticsService object. (Overrides SPPersistedObject.Provision().)
Public method ResetAll Resets reporting thresholds for all categories to their diagnostic logging thresholds. (Inherited from SPDiagnosticsServiceBase.)
Public method ResetItem(Int32) Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
Public method ResetItem(IDiagnosticsLevel) Obsolete. Resets the default reporting thresholds for a category that is specified by an IDiagnosticsLevel object.
Public method SetAll(EventSeverity) Sets the threshold at which events associated with all categories are written to the event log. (Inherited from SPDiagnosticsServiceBase.)
Public method SetAll(TraceSeverity) Sets the threshold at which traces associated with all categories are written to the trace log. (Inherited from SPDiagnosticsServiceBase.)
Public method 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.)
Public method SetItem(Int32, TraceSeverity, EventSeverity) Obsolete. This member is reserved for internal use and is not intended to be used directly from your code.
Public method SetItem(IDiagnosticsLevel, TraceSeverity, EventSeverity) Obsolete. Sets the reporting thresholds for a category that is specified by an IDiagnosticsLevel object.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the SPDiagnosticsService object to save its state and propagate changes to all servers in the server farm. (Overrides SPDiagnosticsServiceBase.Update().)
Public method 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.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public method 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.)
Public method 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.)
Public method WriteTrace Writes a trace to the Microsoft SharePoint Foundation trace log. (Inherited from SPDiagnosticsServiceBase.)

Top

Explicit Interface Implementations

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

Top

See Also

Reference

SPDiagnosticsService Class

Microsoft.SharePoint.Administration Namespace