Home
  •  

MSSQL on Windows: Database Status

Microsoft.SQLServer.Windows.MonitorType.Database.DBStatus (UnitMonitorType)

This monitor type checks the state of a database on a MSSQL Database Engine on Windows installation.

Element properties:

RunAsMicrosoft.SQLServer.Core.RunAs.Monitoring
AccessibilityInternal
Support Monitor RecalculateFalse

Member Modules:

ID Module Type TypeId RunAs 
DS DataSource Microsoft.SQLServer.Windows.DataSource.DBStatus Default
FilterBad ConditionDetection System.ExpressionFilter Default
FilterDatabase ConditionDetection System.ExpressionFilter Default
FilterGood ConditionDetection System.ExpressionFilter Default
FilterNeitherGoodNorBad ConditionDetection System.ExpressionFilter Default

Overrideable Parameters:

IDParameterTypeSelectorDisplay NameDescription
DisableIfAgOfflinebool$Config/DisableIfAgOffline$Disable if Availability Group is offlineInstructs the monitor to stop tracking the database state if the Availability Group with the database is offline. The override does not affect databases that are not part of Availability Groups. This override is useful as it helps you prevent alert storming that may happen when working with SQL Server 2012 due to the specifics of its architecture. For higher versions of SQL Server, this override is not required.
SqlExecTimeoutSecondsint$Config/SqlExecTimeoutSeconds$Timeout for query execution (seconds)The workflow will fail and register an event, if the query execution takes longer than the specified period.
SqlTimeoutSecondsint$Config/SqlTimeoutSeconds$Timeout for database connection (seconds)The workflow will fail and register an event, if it cannot access the database during the specified period.
NumSamplesint$Config/NumSamples$Number of samplesIndicates how many times a measured value should breach a threshold before the state is changed.
TimeoutSecondsint$Config/TimeoutSeconds$Timeout (seconds)Specifies the time the workflow is allowed to run before being closed and marked as failed.
IntervalSecondsint$Config/IntervalSeconds$Interval (seconds)The recurring interval of time in seconds in which to run the workflow.
SyncTimestring$Config/SyncTime$Synchronization TimeThe synchronization time specified by using a 24-hour format. May be omitted.

Source Code:

<UnitMonitorType ID="Microsoft.SQLServer.Windows.MonitorType.Database.DBStatus" Accessibility="Internal" RunAs="SqlCoreLib!Microsoft.SQLServer.Core.RunAs.Monitoring">

  <MonitorTypeStates>

    <MonitorTypeState ID="Good"/>

    <MonitorTypeState ID="Bad"/>

    <MonitorTypeState ID="NeitherGoodNorBad"/>

  </MonitorTypeStates>

  <Configuration>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="MachineName" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="NetbiosComputerName" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="InstanceName" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="DatabaseName" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="ConnectionString" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="InstanceVersion" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="InstanceEdition" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="MonitoringType" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="DisableIfAgOffline" type="xsd:boolean"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="NumSamples" type="xsd:int"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="SqlExecTimeoutSeconds" type="xsd:int"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="SqlTimeoutSeconds" type="xsd:int"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="TimeoutSeconds" type="xsd:int"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="IntervalSeconds" type="xsd:int"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="SyncTime" type="xsd:string"/>

  </Configuration>

  <OverrideableParameters>

    <OverrideableParameter ID="DisableIfAgOffline" ParameterType="bool" Selector="$Config/DisableIfAgOffline$"/>

    <OverrideableParameter ID="SqlExecTimeoutSeconds" ParameterType="int" Selector="$Config/SqlExecTimeoutSeconds$"/>

    <OverrideableParameter ID="SqlTimeoutSeconds" ParameterType="int" Selector="$Config/SqlTimeoutSeconds$"/>

    <OverrideableParameter ID="NumSamples" ParameterType="int" Selector="$Config/NumSamples$"/>

    <OverrideableParameter ID="TimeoutSeconds" ParameterType="int" Selector="$Config/TimeoutSeconds$"/>

    <OverrideableParameter ID="IntervalSeconds" ParameterType="int" Selector="$Config/IntervalSeconds$"/>

    <OverrideableParameter ID="SyncTime" ParameterType="string" Selector="$Config/SyncTime$"/>

  </OverrideableParameters>

  <MonitorImplementation>

    <MemberModules>

      <DataSource TypeID="Microsoft.SQLServer.Windows.DataSource.DBStatus" ID="DS">

        <MachineName>$Config/MachineName$</MachineName>

        <NetbiosComputerName>$Config/NetbiosComputerName$</NetbiosComputerName>

        <InstanceName>$Config/InstanceName$</InstanceName>

        <ConnectionString>$Config/ConnectionString$</ConnectionString>

        <InstanceVersion>$Config/InstanceVersion$</InstanceVersion>

        <InstanceEdition>$Config/InstanceEdition$</InstanceEdition>

        <MonitoringType>$Config/MonitoringType$</MonitoringType>

        <SqlExecTimeoutSeconds>$Config/SqlExecTimeoutSeconds$</SqlExecTimeoutSeconds>

        <SqlTimeoutSeconds>$Config/SqlTimeoutSeconds$</SqlTimeoutSeconds>

        <TimeoutSeconds>$Config/TimeoutSeconds$</TimeoutSeconds>

        <IntervalSeconds>$Config/IntervalSeconds$</IntervalSeconds>

        <SyncTime>$Config/SyncTime$</SyncTime>

      </DataSource>

      <ConditionDetection ID="FilterDatabase" TypeID="System!System.ExpressionFilter">

        <Expression>

          <And>

            <Expression>

              <SimpleExpression>

                <ValueExpression>

                  <XPathQuery Type="String">Property[@Name='DatabaseName']</XPathQuery>

                </ValueExpression>

                <Operator>Equal</Operator>

                <ValueExpression>

                  <Value Type="String">$Config/DatabaseName$</Value>

                </ValueExpression>

              </SimpleExpression>

            </Expression>

            <Expression>

              <Or>

                <Expression>

                  <And>

                    <Expression>

                      <SimpleExpression>

                        <ValueExpression>

                          <Value Type="Boolean">$Config/DisableIfAgOffline$</Value>

                        </ValueExpression>

                        <Operator>Equal</Operator>

                        <ValueExpression>

                          <Value Type="Boolean">true</Value>

                        </ValueExpression>

                      </SimpleExpression>

                    </Expression>

                    <Expression>

                      <SimpleExpression>

                        <ValueExpression>

                          <XPathQuery Type="Boolean">Property[@Name='IsAgOnline']</XPathQuery>

                        </ValueExpression>

                        <Operator>Equal</Operator>

                        <ValueExpression>

                          <Value Type="Boolean">true</Value>

                        </ValueExpression>

                      </SimpleExpression>

                    </Expression>

                  </And>

                </Expression>

                <Expression>

                  <SimpleExpression>

                    <ValueExpression>

                      <Value Type="Boolean">$Config/DisableIfAgOffline$</Value>

                    </ValueExpression>

                    <Operator>Equal</Operator>

                    <ValueExpression>

                      <Value Type="Boolean">false</Value>

                    </ValueExpression>

                  </SimpleExpression>

                </Expression>

              </Or>

            </Expression>

          </And>

        </Expression>

      </ConditionDetection>

      <ConditionDetection ID="FilterGood" TypeID="System!System.ExpressionFilter">

        <Expression>

          <SimpleExpression>

            <ValueExpression>

              <XPathQuery>Property[@Name='MonitoringStatus']</XPathQuery>

            </ValueExpression>

            <Operator>Equal</Operator>

            <ValueExpression>

              <Value Type="String">Good</Value>

            </ValueExpression>

          </SimpleExpression>

        </Expression>

      </ConditionDetection>

      <ConditionDetection ID="FilterBad" TypeID="System!System.ExpressionFilter">

        <Expression>

          <SimpleExpression>

            <ValueExpression>

              <XPathQuery>Property[@Name='MonitoringStatus']</XPathQuery>

            </ValueExpression>

            <Operator>Equal</Operator>

            <ValueExpression>

              <Value Type="String">Bad</Value>

            </ValueExpression>

          </SimpleExpression>

        </Expression>

        <SuppressionSettings>

          <MatchCount>$Config/NumSamples$</MatchCount>

          <SampleCount>$Config/NumSamples$</SampleCount>

        </SuppressionSettings>

      </ConditionDetection>

      <ConditionDetection ID="FilterNeitherGoodNorBad" TypeID="System!System.ExpressionFilter">

        <Expression>

          <SimpleExpression>

            <ValueExpression>

              <XPathQuery>Property[@Name='MonitoringStatus']</XPathQuery>

            </ValueExpression>

            <Operator>Equal</Operator>

            <ValueExpression>

              <Value Type="String">NeitherGoodNorBad</Value>

            </ValueExpression>

          </SimpleExpression>

        </Expression>

        <SuppressionSettings>

          <MatchCount>$Config/NumSamples$</MatchCount>

          <SampleCount>$Config/NumSamples$</SampleCount>

        </SuppressionSettings>

      </ConditionDetection>

    </MemberModules>

    <RegularDetections>

      <RegularDetection MonitorTypeStateID="Good">

        <Node ID="FilterGood">

          <Node ID="FilterDatabase">

            <Node ID="DS"/>

          </Node>

        </Node>

      </RegularDetection>

      <RegularDetection MonitorTypeStateID="Bad">

        <Node ID="FilterBad">

          <Node ID="FilterDatabase">

            <Node ID="DS"/>

          </Node>

        </Node>

      </RegularDetection>

      <RegularDetection MonitorTypeStateID="NeitherGoodNorBad">

        <Node ID="FilterNeitherGoodNorBad">

          <Node ID="FilterDatabase">

            <Node ID="DS"/>

          </Node>

        </Node>

      </RegularDetection>

    </RegularDetections>

  </MonitorImplementation>

</UnitMonitorType>