SQL Monitor 13

Custom Types

MonitoredObject

Member NameTypeDescription
Namestring

Name of the monitored object

BaseMonitor

Member NameTypeDescription
Namestring

Name of the Base Monitor

Cluster

Inherits MonitoredObject

System.DateTime

Member NameTypeDescription
NamestringName of the cluster (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this cluster is monitored by

Machine

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the machine (inherited from MonitoredObject)

StandaloneMachine

Inherits Machine

Member NameTypeDescription
NamestringName of the machine (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this standalone machine is monitored by

ClusterMachine

Inherits Machine

Member NameTypeDescription
NamestringName of the machine (inherited from MonitoredObject)
ClusterClusterThe cluster this machine forms part of

LinuxMachine

Inherits Machine

Member NameTypeDescription
NamestringName of the linux machine (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this Linux machine is monitored by
GroupGroupThe Group this Linux machine is assigned to

Instance

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the SQL instance  (inherited from MonitoredObject)
AliasstringAlias of the SQL instance

ClusterInstance 

Inherits Instance

Member NameTypeDescription
NamestringName of the SQL instance  (inherited from MonitoredObject)
AliasstringAlias of the SQL instance (inherited from Instance)
ClusterClusterThe cluster that hosts this instance
GetTags()
Returns all the tags of the current instance

MachineInstance 

Inherits Instance

Member NameTypeDescription
NamestringName of the SQL instance  (inherited from MonitoredObject)
AliasstringAlias of the SQL instance (inherited from Instance)
MachineMachineThe machine that hosts this instance
GetTags()

Returns all the tags of the current instance

SqlServerInstanceOnLinux

Inherits Instance

Member NameTypeDescription
NamestringName of the SQL instance  (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this SqlServerInstance is monitored by
LinuxMachineLinuxMachineThe machine that hosts this instance
AliasstringAlias of the SQL instance
GetTags()
Returns all the tags of the current instance

AvailabilityGroup 

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the availability group  (inherited from MonitoredObject)
ClusterClusterThe cluster that hosts this availability group

Disk

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the disk  (inherited from MonitoredObject)
MachineMachineThe machine that this disk is located on

Database

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the database  (inherited from MonitoredObject)
InstanceInstanceThe instance this database is on

Job

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the job (inherited from MonitoredObject)
InstanceInstanceThe instance that this job is defined on

AzureManagedInstance

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the server (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this Azure Managed Instance is monitored by
GroupGroupThe Group this Azure Managed Instance is assigned to
AliasstringAlias of the Azure Managed Instance
GetTags()
Returns all the tags of the current instance

AzureManagedInstanceDatabase

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the server (inherited from MonitoredObject)
AzureManagedInstanceAzureManagedInstanceThe server this Azure Managed Instance is on

AmazonRdsSqlServer

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the server (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this Amazon RDS SQL Server is monitored by
GroupGroupThe Group this Amazon RDS SQL Server is assigned to
AliasstringAlias of the Amazon RDS SQL Server
GetTags()
Returns all the tags of the current instance

AmazonRdsDatabase

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the server (inherited from MonitoredObject)
AmazonRdsSqlServerAmazonRdsSqlServerThe server this Amazon RDS SQL Database is on

AzureSqlServer

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the server (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this Azure SQL server is monitored by
GroupGroupThe Group this Azure SQL server is assigned to

AzureSqlDatabase

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the database (inherited from MonitoredObject)
AzureSqlServerAzureSqlServerThe server this Azure SQL database is on
AliasstringAlias of the database

ElasticPool

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the Elastic Pool (inherited from MonitoredObject)
AzureSqlServerAzureSqlServerThe server this Azure Elastic Pool is on

Group

Inherits MonitoredObject

Member NameTypeDescription
NamestringName of the group (inherited from MonitoredObject)
BaseMonitorBaseMonitorThe Base Monitor this group is on
IdstringID of the group
ParentIdstringID of the parent group

AlertType

Member NameTypeDescription
NamestringName of the alert type
Idint32Type of the alert 

EmailNotificationOption

Member NameDescription
DontEmailDo not send a notification email
SendToDefaultSend email notifications to the default recipients
SendToCustomSend email notifications to the specific recipients

NotificationSettings

Member NameTypeDescription
EmailNotificationOptionEmailNotificationOptionNotification option for the alert
EmailAddressesstring arrayEmail addresses for the specific notification receivers (used if EmailNotificationOption is set to "SendToCustom")
SlackEnabledbooleanTrue if notification also needs to be sent through Slack
SnmpEnabledbooleanTrue if notification also needs to be sent through SNMP

DatabaseFileUsageAlertSettingsMode

Member NameDescription
PercentFullUsed database file space is more than the threshold
BytesRemainingRemaining database file space is less than the threshold
TimeRemainingRemaining time until the database file gets full

AbsoluteOrPercentAlertSettingsMode

Member NameDescription
PercentageIndicates that the corresponding threshold value is a percentage
AbsoluteIndicates that the corresponding threshold value is an absolute value

SeverityDto

Member NameDescription
Low
Medium
High

ServiceState

Member NameDescription
Stopped
Paused
Started
StoppedOrPaused
StartedOrPaused

AlertStatus

Member NameDescription
InheritedInherited alert status from the parent
CustomizedCustomized alert status
DisabledDisabled alert status

AlertSettings

Member NameTypeDescription
StatusAlertStatusStatus of the alert settings
CommentsstringComments of the alert settings
NotificationSettingsNotificationSettingsNotification settings of the alert settings
SpecificSettingsSpecificAlertSettingsSpecific settings of the alert settings

SpecificAlertSettings

Generic base type to store specific alert settings

DatabaseFileUsageAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
ModeDatabaseFileUsageAlertSettingsModeMode of the alert settings
DisableWhenAutogrowthEnabledbooleanDisables the alert when Autogrowth is enabled
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings

AbsoluteValueThresholdAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
Durationint32Time threshold in seconds to trigger the alert

AbsoluteOrPercentAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
ModeAbsoluteOrPercentAlertSettingsModeMode of the alert settings
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
Durationint32Time threshold in seconds to trigger the alert

FilterableSqlProcessAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
IgnoreCommandstringSQL commands to ignore (Regular expression)
IgnoreProcessstringSQL processes to ignore (Regular expression)

DeadlockXEAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
SeveritySeverityDtoSeverity of the alert settings
RaiseAlertForVictimlessbooleanTrue if victimless deadlocks should be raised
DatabaseNameRegexesstringDatabase names where alerts should raise for (Regular expression)
ResourceNameRegexesstringResource names where alerts should raise for (Regular expression)
LoginNameRegexesstringLogin names where alerts should raise for (Regular expression)

FragmentedIndexAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
IgnoreReadOnlyDatabasesbooleanTrue if read-only databases should be ignored
MinPagesint32

IntegrityCheckOverdueAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
IgnoreReadOnlyDatabasesbooleanTrue if read-only databases should be ignored

SqlErrorLogAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
IgnoreMatchingErrorMessageRegexstring
IgnoreMatchingErrorNumberRegexstring
IgnoreMatchingSeverityRegexstring

ThresholdPlusDurationAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
Durationint32Time threshold in seconds to trigger the alert

SingleSeverityAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
SeveritySeverityDtoSeverity of the alert settings

ServiceStateAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
SeveritySeverityDtoSeverity of the alert settings
ServiceStateServiceState

ThresholdDurationJobExclusionAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
Durationint32Time threshold in seconds to trigger the alert
JobExclusionRegexesstringJob names to exclude (Regular Expression)

CustomMetricAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings
MinimumDurationint32Minimum time threshold in seconds to trigger the alert

TimeThresholdAlertSettings

Inherits SpecificAlertSettings

Member NameTypeDescription
HighEnabledbooleanTrue if the high threshold is defined
HighThresholdobjectHigh threshold value of the specific alert settings
MediumEnabledbooleanTrue if the medium threshold is defined
MediumThresholdobjectMedium threshold value of the specific alert settings
LowEnabledbooleanTrue if the low threshold is defined
LowThresholdobjectLow threshold value of the specific alert settings

AlertSuppressionAlertTypeGroupToSuppress

Member NameDescription
PerformanceRelatedAlertsAndCustomAlerts
AllAlerts

AlertSuppressionLevel

Member NameDescription
NotificationsOnly
AlertsAndNotifications

AlertSuppressionScheduleSetPosition

Member NameDescription
Last
First
Second
Third
Fourth

BaseAlertSuppressionWindow

Base class for alert suppression window. It is inherited by the specific types of alert suppression windows.

Member NameTypeDescription
NamestringUnique name for the window within its Base Monitor
StartTimeSystem.TimeSpanThe start time of day for the window
DurationSystem.TimeSpanDuration for the window to be active
AlertTypeGroupToSuppressAlertSuppressionAlertTypeGroupToSuppressType of alerts that will be affected by this alert suppression window
AlertSuppressionLevelAlertSuppressionLevelIndicates the suppression level during this alert suppression window
TargetsMonitoredObject[]Target monitored objects to which the window will be applied to

NonRecurringAlertSuppressionWindow

Inherits BaseAlertSuppressionWindow

Member NameTypeDescription
StartDateSystem.DateTimeContains the date and time for the start of the window

WeeklyAlertSuppressionWindow

Inherits BaseAlertSuppressionWindow

Member NameTypeDescription
DaysSystem.DayOfWeek[]Days in which the weekly alert suppression window will be active

MonthlyAlertSuppressionWindow

Inherits BaseAlertSuppressionWindow

Member NameTypeDescription
DaySystem.DayOfWeekDay in which the monthly alert suppression window will be active
ScheduleSetPositionAlertSuppressionScheduleSetPositionRelative week in which the monthly alert suppression window will be active

ADPrincipal

Member NameTypeDescription
NamestringThe name of the AD Principal
BaseMonitorBaseMonitorThe base monitor the AD Principal is stored on
PrincipalRolestringThe role of the AD Principal ("Administrator", "Standard", "Reporting" or "ReadOnly")
GroupsGroup[]The groups the AD Principal has access to (if All is false)
MonitoredObjects
MonitoredObject[]The monitored objects the AD Principal has access to (outside groups, if All is false)
AllbooleanTrue if the ADPrincipal has access to the entire estate; false otherwise

Tag

Member NameTypeDescription
NamestringTextual description of the tag

EntityReference

Member NameTypeDescription
ReferencestringA unique id for a monitored entity placed on a base monitor

SshPrivateKey

Member NameTypeDescription
NamestringThe name of the SSH private key
Usageint32The usage count of this key
CreatedDateSystem.DateTimeThe date and time of when this key was added
BaseMonitorBaseMonitorThe Base Monitor this key is added to

Do you have any feedback on this documentation?

Let us know at sqlmonitorfeedback@red-gate.com


Didn't find what you were looking for?