User-defined SQL Query Three-State Monitor

Microsoft.SqlServer.Core.CustomMonitoring.MonitorType.DBEngine.CustomQueryThreeState (UnitMonitorType)

Three-state monitor that executes a user-defined query in the target SQL Server DB Engine and compares the results against specified conditions.

Element properties:

RunAs	Microsoft.SQLServer.Core.RunAs.Monitoring
Accessibility	Public
Support Monitor Recalculate	False

Member Modules:

ID	Module Type	TypeId	RunAs
Scheduler	DataSource	System.SimpleScheduler	Default
CustomQuery	ProbeAction	Microsoft.SqlServer.Core.CustomMonitoring.ProbeAction.DBEngineCustomQueryMonitor	Default
CriticalFailedCondition	ConditionDetection	System.ExpressionFilter	Default
PassedCondition	ConditionDetection	System.ExpressionFilter	Default
WarningFailedCondition	ConditionDetection	System.ExpressionFilter	Default

Overrideable Parameters:

ID	ParameterType	Selector	Display Name	Description
SqlExecTimeoutSeconds	int	$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.
SqlTimeoutSeconds	int	$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.
TimeoutSeconds	int	$Config/TimeoutSeconds$	Timeout (seconds)	Specifies the time the workflow is allowed to run before being closed and marked as failed.
IntervalSeconds	int	$Config/IntervalSeconds$	Interval (seconds)	The recurring interval of time in seconds in which to run the workflow.
SyncTime	string	$Config/SyncTime$	Synchronization Time	The synchronization time specified by using a 24-hour format. May be omitted.

Source Code:

<UnitMonitorType ID="Microsoft.SqlServer.Core.CustomMonitoring.MonitorType.DBEngine.CustomQueryThreeState" Accessibility="Public" RunAs="SqlCoreLib!Microsoft.SQLServer.Core.RunAs.Monitoring">

  <MonitorTypeStates>

    <MonitorTypeState ID="Passed" NoDetection="false"/>

    <MonitorTypeState ID="WarningFailed" NoDetection="false"/>

    <MonitorTypeState ID="CriticalFailed" NoDetection="false"/>

  </MonitorTypeStates>

  <Configuration>

    <IncludeSchemaTypes>

      <SchemaType>Microsoft.SqlServer.Core.CustomMonitoring.Schema.CustomQueryTypes</SchemaType>

    </IncludeSchemaTypes>

    <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="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" minOccurs="0" maxOccurs="1"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="MonitorName" 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="SqlQuery" type="xsd:string"/>

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

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

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

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

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

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

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

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

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

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

  </Configuration>

  <OverrideableParameters>

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

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

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

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

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

  </OverrideableParameters>

  <MonitorImplementation>

    <MemberModules>

      <DataSource ID="Scheduler" TypeID="System!System.SimpleScheduler">

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

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

      </DataSource>

      <ProbeAction ID="CustomQuery" TypeID="Microsoft.SqlServer.Core.CustomMonitoring.ProbeAction.DBEngineCustomQueryMonitor">

        <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>

        <MonitorName>$Config/MonitorName$</MonitorName>

        <DatabaseName>$Config/DatabaseName$</DatabaseName>

        <SqlQuery>$Config/SqlQuery$</SqlQuery>

        <WarningConditions>$Config/WarningConditions$</WarningConditions>

        <WarningConditionPredicate>$Config/WarningConditionPredicate$</WarningConditionPredicate>

        <CriticalConditions>$Config/CriticalConditions$</CriticalConditions>

        <CriticalConditionPredicate>$Config/CriticalConditionPredicate$</CriticalConditionPredicate>

        <Login>$RunAs[Name="SqlCoreLib!Microsoft.SQLServer.Core.RunAs.SqlCredentials"]/UserName$</Login>

        <Password>$RunAs[Name="SqlCoreLib!Microsoft.SQLServer.Core.RunAs.SqlCredentials"]/Password$</Password>

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

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

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

        <Publisher>$Config/Publisher$</Publisher>

        <ManagementGroupName>$Target/ManagementGroup/Name$</ManagementGroupName>

      </ProbeAction>

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

        <Expression>

          <SimpleExpression>

            <ValueExpression>

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

            </ValueExpression>

            <Operator>Equal</Operator>

            <ValueExpression>

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

            </ValueExpression>

          </SimpleExpression>

        </Expression>

      </ConditionDetection>

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

        <Expression>

          <SimpleExpression>

            <ValueExpression>

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

            </ValueExpression>

            <Operator>Equal</Operator>

            <ValueExpression>

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

            </ValueExpression>

          </SimpleExpression>

        </Expression>

      </ConditionDetection>

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

        <Expression>

          <SimpleExpression>

            <ValueExpression>

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

            </ValueExpression>

            <Operator>Equal</Operator>

            <ValueExpression>

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

            </ValueExpression>

          </SimpleExpression>

        </Expression>

      </ConditionDetection>

    </MemberModules>

    <RegularDetections>

      <RegularDetection MonitorTypeStateID="Passed">

        <Node ID="PassedCondition">

          <Node ID="CustomQuery">

            <Node ID="Scheduler"/>

          </Node>

        </Node>

      </RegularDetection>

      <RegularDetection MonitorTypeStateID="WarningFailed">

        <Node ID="WarningFailedCondition">

          <Node ID="CustomQuery">

            <Node ID="Scheduler"/>

          </Node>

        </Node>

      </RegularDetection>

      <RegularDetection MonitorTypeStateID="CriticalFailed">

        <Node ID="CriticalFailedCondition">

          <Node ID="CustomQuery">

            <Node ID="Scheduler"/>

          </Node>

        </Node>

      </RegularDetection>

    </RegularDetections>

  </MonitorImplementation>

</UnitMonitorType>