doc-exports/docs/dws/umn/dws_01_1242.html

<a name="EN-US_TOPIC_0000001707254585"></a><a name="EN-US_TOPIC_0000001707254585"></a>

<h1 class="topictitle1">Alarm Rules</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_section53888177284"><h4 class="sectiontitle">Overview</h4><ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul13364546454"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li11459191014716">Concepts related to threshold alarms<ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul89291414371"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li176895394114">Alarm rule: consists of the alarm rule name, rule description, clusters associated with the rule, alarm policy triggering relationship, and alarm policy. An alarm rule can apply to one or all clusters, and can consist of one or more policies. The relationship between alarm policies can be selected in <strong id="EN-US_TOPIC_0000001707254585__b124745814457">Triggered Policies</strong>. Each alarm policy consists of the triggers and constraint of each alarm rule.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li7981354510">Alarm policy: consists of the triggers, constraint, and alarm severity for an alarm metric.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li221102544519">Alarm metric: indicates a database cluster metric, which is generally time series data, for example, node CPU usage and amount of data flushed to disks.</li></ul>
</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li14459210870">Alarm rule types<ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul9281812194218"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1989731854213">Default rule: best practices of GaussDB(DWS) threshold alarms.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li461912103511">User-defined rule: personalized alarm rules by configuring or combining monitoring metrics. (The current version supports only user-defined alarm rules of schema usage.)</li></ul>
</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li19800351375">Alarm rule operations<ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul10218235173114"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li7218163519311">Modify: modifies an alarm rule. All alarm rules apply (all items of user-defined alarm rules but only some items of the default alarm rules).</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li201550416314">Enable/Disable: enables or disables an alarm rule. All alarm rules can be enabled or disabled. After an alarm rule is enabled, it is added to the check list by the alarm engine and can be triggered normally. Disabled alarm rules will be removed from the check list by the alarm engine and will not be triggered.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li321218442317">Delete: deletes an alarm rule. You can delete only user-defined rules. Default alarm rules cannot be deleted.</li></ul>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_section183651339122410"><h4 class="sectiontitle">Precautions</h4><p id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_p118192111186">After a cluster is migrated, to monitor alarms of the new cluster, change the cluster bound to the alarm rule to the new cluster. You can also create an alarm rule for the new cluster.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_section189551111994"><h4 class="sectiontitle">Viewing Alarm Rules</h4><ol id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ol4135415112220"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li813512156226"><span>Log in to the GaussDB(DWS) management console.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li121352158224"><span>In the navigation pane on the left, choose <strong id="EN-US_TOPIC_0000001707254585__b188203414176">Alarms</strong>.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li9636549613"><span>Click <strong id="EN-US_TOPIC_0000001707254585__b8502103724519">View Alarm Rule</strong> in the upper left corner. On the page that is displayed, you can see the threshold alarm rules of database cluster monitoring metrics, as shown in the following figure.</span><p><p id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_p16682115119116"><span><img id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_image331425116395" src="figure/en-us_image_0000001759357369.png" title="Click to enlarge" class="imgResize"></span></p>
</p></li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_section118710116915"><h4 class="sectiontitle">Modifying an Alarm Rule</h4><ol id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ol1471144332018"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1047119436208"><span>Log in to the GaussDB(DWS) management console.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li17471543182010"><span>In the navigation pane on the left, click <strong id="EN-US_TOPIC_0000001707254585__b7401816521">Alarms</strong>.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li114721743162017"><span>Click <strong id="EN-US_TOPIC_0000001707254585__b568219113345">View Alarm Rule</strong> in the upper left corner.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li152974453206"><span>On the <strong id="EN-US_TOPIC_0000001707254585__b8404131113911">Alarm Rules</strong> page that is displayed, click <strong id="EN-US_TOPIC_0000001707254585__b10184183003514">Modify</strong> in the <strong id="EN-US_TOPIC_0000001707254585__b2249632123516">Operation</strong> column of the target alarm rule.</span><p><ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul1990191942817"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li5901131918286"><strong id="EN-US_TOPIC_0000001707254585__b1029655210465">Alarm rule name</strong>: The rule name contains 6 to 64 characters (letters, digits, Chinese characters, slashes) and must start with a non-digit character.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li159011019152814"><strong id="EN-US_TOPIC_0000001707254585__b4115451103920">Description</strong></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1590151917285"><strong id="EN-US_TOPIC_0000001707254585__b129141642410">Associated Cluster</strong>: From the drop-down list, select the current tenant's clusters to which the alarm rule applies.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li3902171922811"><strong id="EN-US_TOPIC_0000001707254585__b26301738154714">Triggered Policies</strong><ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul20992020648"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li179204221640"><strong id="EN-US_TOPIC_0000001707254585__b1214218481472">Independent</strong>: Alarm policies are triggered independently of each other.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li3993206419"><strong id="EN-US_TOPIC_0000001707254585__b6389175734710">Priority</strong>: Alarm policies are triggered by priority. Policies of a lower priority will be automatically triggered after those of a higher priority.</li></ul>
</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li169028197286"><strong id="EN-US_TOPIC_0000001707254585__b7108144331518">Alarm Policy</strong><ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul197675863119"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1187094912298"><strong id="EN-US_TOPIC_0000001707254585__b1662810020168">Metric</strong>: GaussDB(DWS) monitoring metric, which is the data source used by the alarm engine for threshold determination.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li6999142133012"><strong id="EN-US_TOPIC_0000001707254585__b162201422101613">Trigger</strong>: calculation rule for threshold determination of a monitoring metric. Select the average value within a period of time of a metric to reduce the probability of alarm oscillation.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1075917711306"><strong id="EN-US_TOPIC_0000001707254585__b611653551618">Constraint</strong>: suppresses the repeated triggering and clearance of alarms of the same type within the specified period.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li15657188307"><strong id="EN-US_TOPIC_0000001707254585__b2025845813417">Alarm Severity</strong>: includes <strong id="EN-US_TOPIC_0000001707254585__b1820265454410">Urgent</strong>, <strong id="EN-US_TOPIC_0000001707254585__b126221555174413">Important</strong>, <strong id="EN-US_TOPIC_0000001707254585__b11820195684411">Minor</strong>, and <strong id="EN-US_TOPIC_0000001707254585__b18477165819449">Prompt</strong>.</li></ul>
</li></ul>
<p id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_p149315436226"><span><img id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_image19795145412309" src="figure/en-us_image_0000001711438332.png" title="Click to enlarge" class="imgResize"></span></p>
<div class="note" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_note200540914"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_p189998531791">You can modify only some items of the default rules (associated cluster, alarm policy threshold, time period, and alarm constraint). User-defined rules support modification of all items.</p>
</div></div>
</p></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li99699534918"><span>Confirm the information and click <strong id="EN-US_TOPIC_0000001707254585__b6344132817212">OK</strong>.</span></li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_section161961957165112"><h4 class="sectiontitle">Creating an Alarm Rule</h4><ol id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ol1261883284717"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li11619132144718"><span>Log in to the GaussDB(DWS) management console.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1161914328470"><span>In the navigation pane on the left, click <strong id="EN-US_TOPIC_0000001707254585__b2395369119">Alarms</strong>.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li19619532184714"><span>Click <strong id="EN-US_TOPIC_0000001707254585__b580363612189">View Alarm Rule</strong> in the upper left corner.</span></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li167491735184714"><span>Click <strong id="EN-US_TOPIC_0000001707254585__b35682521439">Create Alarm Rule</strong> in the upper right corner. You can configure items, such as the alarm rule name, rule description, clusters associated with the rule, and alarm policy.</span><p><ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul36509489435"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li11650144854316"><strong id="EN-US_TOPIC_0000001707254585__b895332194910">Alarm rule name</strong>: The rule name contains 6 to 64 characters (letters, digits, Chinese characters, slashes) and must start with a non-digit character.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li13616195554318"><strong id="EN-US_TOPIC_0000001707254585__b654912608">Description</strong></li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1742519644417"><strong id="EN-US_TOPIC_0000001707254585__b2003902611">Associated Cluster</strong>: From the drop-down list, select the current tenant's clusters to which the alarm rule applies.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1848910108444"><strong id="EN-US_TOPIC_0000001707254585__b324653321">Triggered Policies</strong><ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul676224194417"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li2762941174417"><strong id="EN-US_TOPIC_0000001707254585__b1060238475">Independent</strong>: Alarm policies are triggered independently of each other.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li7762341144412"><strong id="EN-US_TOPIC_0000001707254585__b864825383">Priority</strong>: Alarm policies are triggered by priority. Policies of a lower priority will be automatically triggered after those of a higher priority.</li></ul>
</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li7962557154418"><strong id="EN-US_TOPIC_0000001707254585__b2146768494">Alarm Policy</strong><ul id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_ul4121125618458"><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1512195611450"><strong id="EN-US_TOPIC_0000001707254585__b1974675418224">Metric</strong>: GaussDB(DWS) monitoring metric, which is the data source used by the alarm engine for threshold determination.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1094132424619"><strong id="EN-US_TOPIC_0000001707254585__b2184165010235">Alarm Object</strong>: databases in the selected cluster and schemas in the selected databases.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li19121125615457"><strong id="EN-US_TOPIC_0000001707254585__b158296343238">Trigger</strong>: calculation rule for threshold determination of a monitoring metric. Select the average value within a period of time of a metric to reduce the probability of alarm oscillation.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li18121145610453"><strong id="EN-US_TOPIC_0000001707254585__b821588739">Constraint</strong>: suppresses the repeated triggering and clearance of alarms of the same type within the specified period.</li><li id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_li1512195611456"><strong id="EN-US_TOPIC_0000001707254585__b16731124916251">Alarm Severity</strong>: includes <strong id="EN-US_TOPIC_0000001707254585__b197374493254">Urgent</strong>, <strong id="EN-US_TOPIC_0000001707254585__b97381249122517">Important</strong>, <strong id="EN-US_TOPIC_0000001707254585__b1973811494253">Minor</strong>, and <strong id="EN-US_TOPIC_0000001707254585__b177386498257">Prompt</strong>.<div class="fignone" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_fig260641012342"><span class="figcap"><b>Figure 1 </b>Creating an alarm rule</span><br><span><img id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_image1060651073416" src="figure/en-us_image_0000001711597828.png" title="Click to enlarge" class="imgResize"></span></div>
<div class="note" id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_note735315035616"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001707254585__en-us_topic_0000001423159637_p133559010563">Currently, only alarm rules of schema usage metrics can be created on GaussDB(DWS).</p>
</div></div>
</li></ul>
</li></ul>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_01_1240.html">Alarms</a></div>
</div>
</div>


<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>