forked from docs/doc-exports
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
202 lines
26 KiB
HTML
202 lines
26 KiB
HTML
<a name="css_01_0364"></a><a name="css_01_0364"></a>
|
|
|
|
<h1 class="topictitle1">Setting Alarm Alerting via SMN for an OpenSearch Cluster</h1>
|
|
<div id="body0000001815107861"><div class="section" id="css_01_0364__section148521314566"><h4 class="sectiontitle">Scenarios</h4><p id="css_01_0364__p176313315196">By default, CSS has installed the open-source alert plugin <strong id="css_01_0364__b1772715445468">opensearch-alerting</strong> for OpenSearch clusters to send notifications when data meets specific conditions. This plugin consists of three components: <strong id="css_01_0364__b0612165517488">Alerts</strong>, <strong id="css_01_0364__b1161216559487">Monitors</strong>, and <strong id="css_01_0364__b961215517485">Destinations</strong>. CSS integrates the SMN service in the <strong id="css_01_0364__b9612125512483">Destinations</strong> component and can send alarm messages only through the SMN service as the destination.</p>
|
|
<p id="css_01_0364__p149378164111">This section describes how to configure the SMN alarm function for OpenSearch clusters on <strong id="css_01_0364__b15521618145211">OpenSearch Dashboards</strong>.</p>
|
|
<div class="note" id="css_01_0364__note31243381035"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0364__p1412513820314">For details about the official guide of the plug-in <strong id="css_01_0364__b211720367523">OpenSearch Alerting</strong>, visit <a href="https://opensearch.org/docs/1.3/observing-your-data/alerting/index/" target="_blank" rel="noopener noreferrer">Alerting - OpenSearch Documentation</a>.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="css_01_0364__section1460419465720"><h4 class="sectiontitle">Constraints</h4><p id="css_01_0364__p1820112434615">By default, the open-source alert plug-in <strong id="css_01_0364__b1215614110190">opensearch-alerting</strong> is installed for OpenSearch clusters of version 1.3.6.</p>
|
|
</div>
|
|
<div class="section" id="css_01_0364__section14330827195719"><a name="css_01_0364__section14330827195719"></a><a name="section14330827195719"></a><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0364__ul15995161333815"><li id="css_01_0364__li181181516143812">You have created a topic on the SMN console.</li><li id="css_01_0364__li3437173419585">You have obtained CSS administrator account. The account has the permissions to access CSS and view the agency list, create agencies, and grant permissions to agencies.</li></ul>
|
|
</div>
|
|
<div class="section" id="css_01_0364__section898402435419"><h4 class="sectiontitle">Authorizing Users to Use SMN</h4><ol id="css_01_0364__css_01_0223_ol129851924165413"><li id="css_01_0364__css_01_0223_li192703204411">Log in to the CSS management console using an administrator account.</li><li id="css_01_0364__css_01_0223_li791816471844">In the navigation pane, choose <strong id="css_01_0364__css_01_0223_b190079240335456">Service Authorization</strong>.</li><li id="css_01_0364__css_01_0223_li1489192120510">On the <strong id="css_01_0364__css_01_0223_b8272656035456">Service Authorization</strong> page, click <strong id="css_01_0364__css_01_0223_b214621698935456">Create Agency</strong>. In the dialog box displayed, confirm that the agency is successfully created.<ul id="css_01_0364__css_01_0223_ul146461324333"><li id="css_01_0364__css_01_0223_li146467219336">If an agency has been created, "css_smn_agency exist, no need to created." is displayed in the upper right corner.</li><li id="css_01_0364__css_01_0223_li18471105833310">If you do not have the permission to create an agency, an error message will be displayed in the upper right corner indicating "no permission", in which case, check that the administrator account has been assigned the IAM permission.</li></ul>
|
|
</li></ol>
|
|
</div>
|
|
<div class="section" id="css_01_0364__section116811923135817"><h4 class="sectiontitle">Configuring Alarm Alerting via SMN for a Cluster</h4><ol id="css_01_0364__ol1689223416583"><li id="css_01_0364__li113651842134713">Log in to the CSS management console.</li><li id="css_01_0364__en-us_topic_0000001428595166_li112262815169">Choose <span class="uicontrol" id="css_01_0364__uicontrol1843314245018"><b>Clusters</b></span> > <strong id="css_01_0364__b3433194245012">OpenSearch</strong>, select the target cluster and click <span class="parmvalue" id="css_01_0364__parmvalue10433442185019"><b>Access Kibana</b></span> in the <strong id="css_01_0364__b943384214503">Operation</strong> column.</li><li id="css_01_0364__li121221820173920">On the <strong id="css_01_0364__b4665918509">OpenSearch Dashboards</strong> page, choose <strong id="css_01_0364__b3780115884212">OpenSearch Plugins</strong> > <strong id="css_01_0364__b568070104315">Alerting</strong> in the navigation tree on the left.</li><li id="css_01_0364__li10273150152314"><a name="css_01_0364__li10273150152314"></a><a name="li10273150152314"></a>Create an SMN destination to send alert messages.<ol type="a" id="css_01_0364__ol691362115234"><li id="css_01_0364__li182481829175719">On the <strong id="css_01_0364__b8881123517">Alerting</strong> page, click the <strong id="css_01_0364__b11882124511">Destinations</strong> tab and click <strong id="css_01_0364__b888181215115">Add destination</strong> to configure destination information.
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0364__table15618122633118" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Destinations parameters</caption><thead align="left"><tr id="css_01_0364__row12618826173111"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.4.1.1.4.2.3.1.1"><p id="css_01_0364__p96181926133112">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.4.1.1.4.2.3.1.2"><p id="css_01_0364__p1361962618318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_01_0364__row16619162617318"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.1.1.4.2.3.1.1 "><p id="css_01_0364__p76194264318">Name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.1.1.4.2.3.1.2 "><p id="css_01_0364__p661913261318">User-defined destination name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row106192026203115"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.1.1.4.2.3.1.1 "><p id="css_01_0364__p76196269311">Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.1.1.4.2.3.1.2 "><p id="css_01_0364__p4619122653112">Retain the default value <strong id="css_01_0364__b105688551357">SMN</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row1061917268317"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.1.1.4.2.3.1.1 "><p id="css_01_0364__p9619182617312">Topic</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.1.1.4.2.3.1.2 "><p id="css_01_0364__p1261972616310">Select the SMN topic you have created in <a href="#css_01_0364__section14330827195719">Prerequisites</a> for sending alarm messages.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="fignone" id="css_01_0364__fig421554871617"><span class="figcap"><b>Figure 1 </b>Add destination</span><br><span><img id="css_01_0364__image15215448161616" src="en-us_image_0000001965417005.png"></span></div>
|
|
</li><li id="css_01_0364__li523715123165">Click <strong id="css_01_0364__b1063412420613">Create</strong> to return to the destination list. The created SMN destination is displayed in the list.<div class="fignone" id="css_01_0364__fig1942714216408"><span class="figcap"><b>Figure 2 </b>Destination list</span><br><span><img id="css_01_0364__image196531227338" src="en-us_image_0000001938378012.png"></span></div>
|
|
</li></ol>
|
|
</li><li id="css_01_0364__li435962341913">Create a monitoring task and configure the alarm triggering condition and monitoring frequency.<ol type="a" id="css_01_0364__ol1169518450279"><li id="css_01_0364__li16328172810195">Click the <strong id="css_01_0364__b132796291179">Monitors</strong> tab on the <strong id="css_01_0364__b22796291271">Alerting</strong> page and click <strong id="css_01_0364__b1927917291174">Create monitor</strong> to configure monitoring information.
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0364__table212044012329" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Monitor parameters</caption><thead align="left"><tr id="css_01_0364__row11201140103215"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.5.1.1.4.2.3.1.1"><p id="css_01_0364__p1012074023215">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.5.1.1.4.2.3.1.2"><p id="css_01_0364__p14120154063217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_01_0364__row5251435152120"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p863803614216"><strong id="css_01_0364__b5638193617219">Monitor details</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row312034020327"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p312014063213">Monitor name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p212018404323">User-defined monitor name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row65133917344"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p1131754619343">Monitor type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p156153953416">Monitor type. The value can be <strong id="css_01_0364__b11704583819">Per query monitor</strong> (common monitoring), <strong id="css_01_0364__b64956111487">Per bucket monitor</strong> (aggregation bucket monitoring), and <strong id="css_01_0364__b152541181814">Per cluster metrics monitor</strong> (cluster metric monitoring).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row1312017409322"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p886634513409">Monitor defining method</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p281462319339">Monitor defining method. <strong id="css_01_0364__b1529219914610">Extraction query editor</strong> is recommended.</p>
|
|
<ul id="css_01_0364__ul11224133817720"><li id="css_01_0364__li922412381574"><strong id="css_01_0364__b6736133619467">Visual editor</strong></li><li id="css_01_0364__li722419381179"><strong id="css_01_0364__b20757133920463">Extraction query editor</strong></li><li id="css_01_0364__li12957135034117"><strong id="css_01_0364__b3553243124615">Anomaly detector</strong></li></ul>
|
|
<p id="css_01_0364__p76204362150">The options of <strong id="css_01_0364__b7410736194610">Monitor defining method</strong> are determined by the <span class="parmname" id="css_01_0364__parmname18939105011151"><b>Monitor type</b></span> you selected.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row451617111365"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p2516216364">Detector</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p65161214362">If <span class="parmname" id="css_01_0364__parmname444491863810"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue17774287388"><b>Anomaly detector</b></span>, select an exception detection task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row1068417593333"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p12684259173315">Frequency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p0684145963311">Select the monitoring frequency and set the monitoring interval. The options include:</p>
|
|
<ul id="css_01_0364__ul19911175713115"><li id="css_01_0364__li191175710118"><strong id="css_01_0364__b1747833411473">By interval</strong></li><li id="css_01_0364__li791175721116"><strong id="css_01_0364__b6428037144710">Daily</strong></li><li id="css_01_0364__li991165751112"><strong id="css_01_0364__b1978023810473">Weekly</strong></li><li id="css_01_0364__li69110573118"><strong id="css_01_0364__b1398134034716">Monthly</strong></li><li id="css_01_0364__li1291105710111"><strong id="css_01_0364__b12651556164716">Custom cron expression</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row12228401225"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p744613292210"><strong id="css_01_0364__b144692112216">Data source</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row1534711373436"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p770064464312">Index</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p17001544144320">When <span class="parmname" id="css_01_0364__parmname74961727542"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue5656105165414"><b>Visual editor</b></span> or <span class="parmvalue" id="css_01_0364__parmvalue93976546542"><b>Extraction query editor</b></span>, you need to specify the index to be monitored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row0950144134316"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p207001944144320">Time field</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p97000444439">When <span class="parmname" id="css_01_0364__parmname831882715554"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue831862755519"><b>Visual editor</b></span>, you need to specify the time field to define counting parameters such as <strong id="css_01_0364__b112801622115113">count</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row310153917191"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p15965132614223"><strong id="css_01_0364__b1996552622210">Query</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row15120333162218"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p1812053342213">Metrics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p1412043316226">When <span class="parmname" id="css_01_0364__parmname066111237356"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue7661132310352"><b>Visual editor</b></span>, you need to set the metrics range for extracting statistics.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row376424342210"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p1676494372220">Time range for the last</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p11764164342218">When <span class="parmname" id="css_01_0364__parmname3966172553519"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue199662025173512"><b>Visual editor</b></span>, you need to set the monitoring time range for plugins.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row46465519226"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p564105519228">Data filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p66475510229">When <span class="parmname" id="css_01_0364__parmname1714922811354"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue5149122811353"><b>Visual editor</b></span>, you need to set filters for data search.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row11408562313"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p1030821192310">Group by</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p1640115112314">When <span class="parmname" id="css_01_0364__parmname12243029163519"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue924362911357"><b>Visual editor</b></span>, you need to specify a field so that each value of the field triggers an alarm.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row19383242153510"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p238354220350">Define extraction query</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p0383104212352">When <span class="parmname" id="css_01_0364__parmname224475214355"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue18244752163515"><b>Extraction query editor</b></span>, you need to enter the query statement to define the monitoring.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row2051143155512"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.1 "><p id="css_01_0364__p115843155515">Request type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.4.2.3.1.2 "><p id="css_01_0364__p9504375519">When <span class="parmname" id="css_01_0364__parmname12120192914015"><b>Monitor type</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue124401735503"><b>Per cluster metrics monitor</b></span>, you need to specify the request type to monitor cluster metrics, such as the running status and CPU usage.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="css_01_0364__li103721932193717">Click <strong id="css_01_0364__b1488319481485">Add trigger</strong> to add triggers and specify the alarm triggering conditions and actions to be triggered when an alarm is reported.</li><li id="css_01_0364__li107781049123811">On the <strong id="css_01_0364__b15812519134211">Triggers</strong> page, set the alarm triggering sensitivity and message release on the destination end.
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0364__table75101458390" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Trigger parameters</caption><thead align="left"><tr id="css_01_0364__row115103454395"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.5.1.3.2.2.3.1.1"><p id="css_01_0364__p15101845123916">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.5.1.3.2.2.3.1.2"><p id="css_01_0364__p45101745103918">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_01_0364__row15510245103917"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p1512115333913">Trigger name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p115101245113911">User-defined trigger name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row10510945123914"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p1512117537397">Severity level</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p7510194533919">Sensitivity of a trigger, that is, the number of alarms that are triggered before an alarm message is sent. <span class="parmvalue" id="css_01_0364__parmvalue22656316527"><b>1</b></span> indicates the highest sensitivity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row1314923320263"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p9149143318264">Trigger condition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p1891953220366">Trigger condition. An alarm is triggered when the trigger condition is hit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row12510164515397"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p3120115315391">Action name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p55101245133919">Trigger action name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row5510164514391"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p912025313399">Destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p1510745153914">Select the SMN destination created in section <a href="#css_01_0364__li10273150152314">4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row17510845103915"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p7119115311396">Message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p1498744018384">Alarm message body By default, the subject and body are defined when the destination is an email.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row1757544464012"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p857514441406">Perform action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p1857594415408">When <span class="parmname" id="css_01_0364__parmname1418154275516"><b>Monitor type</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue1795644417551"><b>Per bucket monitor</b></span>, you need to set whether to send alarms in combination. The value can be:</p>
|
|
<ul id="css_01_0364__ul1298216181676"><li id="css_01_0364__li498215181978"><strong id="css_01_0364__b9274184742810">Per execution</strong>: A combination alarm is sent when multiple alarm triggering conditions are hit.</li><li id="css_01_0364__li5982171810715"><strong id="css_01_0364__b5811134962814">Per alert</strong>: Alarms are sent separately when multiple alarm triggering conditions are hit.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row189382817416"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p9893102864114">Actionable alerts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p11893112814416">When <span class="parmname" id="css_01_0364__parmname036115563612"><b>Monitor type</b></span> is set to <span class="parmvalue" id="css_01_0364__parmvalue1361185610616"><b>Per bucket monitor</b></span>, set this parameter to <span class="parmvalue" id="css_01_0364__parmvalue8151140571"><b>Per alert</b></span>. You need to set the alarms that can be executed after alarm triggering conditions are hit.</p>
|
|
<ul id="css_01_0364__ul137643610321"><li id="css_01_0364__li376419633215"><strong id="css_01_0364__b169611582310">De-duplicated</strong>: Alarms that have been triggered. OpenSearch retains the existing alarms to prevent the plugin from creating duplicate alarms.</li><li id="css_01_0364__li167641160325"><strong id="css_01_0364__b99033103314">New</strong>: Newly created alarms.</li><li id="css_01_0364__li157641620328"><strong id="css_01_0364__b12741114133120">Completed</strong>: Alarms that are no longer ongoing.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_01_0364__row16311133802713"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.1 "><p id="css_01_0364__p14312133832717">Throttling</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.3.2.2.3.1.2 "><p id="css_01_0364__p15506523417">Message sending frequency. It limits the number of notification messages can be received in a specified period.</p>
|
|
<p id="css_01_0364__p145154674413">For example, if this parameter is set to 10 minutes, SMN sends only one alarm notification in the next 10 minutes even if the trigger condition is hit for multiple times. After 10 minutes, SMN sends another alarm notification if the alarm condition is met.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="fignone" id="css_01_0364__fig1342217084217"><span class="figcap"><b>Figure 3 </b>Setting the destination of a trigger action</span><br><span><img id="css_01_0364__image960613146474" src="en-us_image_0000001938378016.png"></span></div>
|
|
</li><li id="css_01_0364__li9544112116446">Click <strong id="css_01_0364__b18750935155319">Send test message</strong>. If a subscriber receives an email, as shown in <a href="#css_01_0364__fig341274195412">Figure 5</a>, the trigger is configured successfully.<div class="fignone" id="css_01_0364__fig2832329115114"><span class="figcap"><b>Figure 4 </b>Sending a test message</span><br><span><img id="css_01_0364__image1783342914517" src="en-us_image_0000001938218660.png"></span></div>
|
|
<div class="fignone" id="css_01_0364__fig341274195412"><a name="css_01_0364__fig341274195412"></a><a name="fig341274195412"></a><span class="figcap"><b>Figure 5 </b>Email notification</span><br><span><img id="css_01_0364__image9412843542" src="en-us_image_0000001965497233.png"></span></div>
|
|
</li><li id="css_01_0364__li1545051111553">Click <strong id="css_01_0364__b19191123916">Create</strong> to return to the monitor details page. The detector is successfully created.</li></ol>
|
|
</li></ol>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0504.html">OpenSearch Cluster Monitoring and Log Management</a></div>
|
|
</div>
|
|
</div>
|
|
|