yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/css/umn/css_01_0364.html
zhengxiu 93d856d5c5 css umn 25.6.0 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>
2025-11-25 11:34:43 +00:00

401 lines
59 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001938218372"></a><a name="EN-US_TOPIC_0000001938218372"></a>
<h1 class="topictitle1">Setting Alarm Alerting via SMN for an OpenSearch Cluster</h1>
<div id="body0000001815107861"><p id="EN-US_TOPIC_0000001938218372__p154712017694">This topic describes how to use an open-source alerting or notification plugin to configure alarm alerting via the Simple Message Notification (SMN) service for OpenSearch clusters in OpenSearch Dashboards.</p>
<div class="section" id="EN-US_TOPIC_0000001938218372__section148521314566"><h4 class="sectiontitle">Scenarios</h4><p id="EN-US_TOPIC_0000001938218372__p18975105001112">In CSS, the open-source OpenSearch alerting plugin (opensearch-alerting) and OpenSearch notification plugin (opensearch-notifications and opensearch-notifications-core) are installed by default. They trigger alerts when data meets predefined conditions.</p>
<ul id="EN-US_TOPIC_0000001938218372__ul1012913360304"><li id="EN-US_TOPIC_0000001938218372__li8129936203014">By default, the open-source alert plugin <strong id="EN-US_TOPIC_0000001938218372__b124019241439">opensearch-alerting</strong> is installed for OpenSearch clusters of version 1.3.6. This plugin consists of three components: <strong id="EN-US_TOPIC_0000001938218372__b20632128933">Alerts</strong>, <strong id="EN-US_TOPIC_0000001938218372__b1663314283312">Monitors</strong>, and <strong id="EN-US_TOPIC_0000001938218372__b146331281319">Destinations</strong>. CSS integrates the SMN service in the <strong id="EN-US_TOPIC_0000001938218372__b1163317281939">Destinations</strong> component, allowing it to send alarm notifications to the SMN service as a destination.</li><li id="EN-US_TOPIC_0000001938218372__li51296367308">For OpenSearch 2.19.0 clusters, the open-source OpenSearch alerting plugin (opensearch-alerting) and OpenSearch notification plugin (opensearch-notifications and opensearch-notifications-core) are installed by default. The Destinations component of the OpenSearch alerting plugin is now an independent notification plugin that manages notification channels. CSS integrates the SMN service in its <strong id="EN-US_TOPIC_0000001938218372__b176520910209">Notifications</strong> component, so it can use SMN as a notification channel.</li></ul>
<p id="EN-US_TOPIC_0000001938218372__p871363471516">For more information about the OpenSearch alerting plugin, see <a href="https://docs.opensearch.org/2.19/observing-your-data/alerting/index/" target="_blank" rel="noopener noreferrer">Alerting - OpenSearch Documentation</a>. For more information about the OpenSearch notifications plugin, see <a href="https://docs.opensearch.org/2.19/observing-your-data/notifications/index/" target="_blank" rel="noopener noreferrer">Notifications - OpenSearch Documentation</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001938218372__section14330827195719"><a name="EN-US_TOPIC_0000001938218372__section14330827195719"></a><a name="section14330827195719"></a><h4 class="sectiontitle">Prerequisites</h4><ul id="EN-US_TOPIC_0000001938218372__ul15995161333815"><li id="EN-US_TOPIC_0000001938218372__li181181516143812">You have created a topic on the SMN console.</li><li id="EN-US_TOPIC_0000001938218372__li3437173419585">You have obtained the CSS administrator account. This account has the permission to access CSS, check the agency list, create agencies, and grant permissions to agencies.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001938218372__section898402435419"><h4 class="sectiontitle">Authorizing Users to Use SMN</h4><ol id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_ol129851924165413"><li id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_li15996128141913"><span id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_ph6996138201911">Log in to the CSS management console.</span><p id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_p1133426131914">You must log in using a CSS administrator account.</p>
</li><li id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_li791816471844">In the navigation pane, choose <strong id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_b190079240335456">Service Authorization</strong>.</li><li id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_li1489192120510">On the <strong id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_b8272656035456">Service Authorization</strong> page, click <strong id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_b214621698935456">Create Agency</strong>. In the dialog box displayed, confirm that the agency is successfully created.<ul id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_ul146461324333"><li id="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_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="EN-US_TOPIC_0000001938218372__en-us_topic_0000001938218508_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="EN-US_TOPIC_0000001938218372__section72079495319"><h4 class="sectiontitle">Setting Alarm Notifications via SMN (OpenSearch 2.19.0)</h4><ol id="EN-US_TOPIC_0000001938218372__ol6207194903115"><li id="EN-US_TOPIC_0000001938218372__li459563317368"><span id="EN-US_TOPIC_0000001938218372__ph155951533173619">Log in to the CSS management console.</span><p id="EN-US_TOPIC_0000001938218372__p155393338209">Log in using an account with CSS permissions.</p>
</li><li id="EN-US_TOPIC_0000001938218372__li3595143316360">In the navigation pane on the left, choose <span class="uicontrol" id="EN-US_TOPIC_0000001938218372__uicontrol9282226112118"><b>Clusters &gt; OpenSearch</b></span>.</li><li id="EN-US_TOPIC_0000001938218372__li14595113333614">In the cluster list, find the target cluster, and click <strong id="EN-US_TOPIC_0000001938218372__b7647114215218">Dashboards</strong> in the <strong id="EN-US_TOPIC_0000001938218372__b10648134216217">Operation</strong> column to log in to OpenSearch Dashboards.</li><li id="EN-US_TOPIC_0000001938218372__li1720815497318">On the OpenSearch Dashboards console, expand the menu in the upper-left corner, and choose <strong id="EN-US_TOPIC_0000001938218372__b4462183535318">Notifications</strong>.</li><li id="EN-US_TOPIC_0000001938218372__li1220804983114"><a name="EN-US_TOPIC_0000001938218372__li1220804983114"></a><a name="li1220804983114"></a>Create an SMN channel to send alert messages.<ol type="a" id="EN-US_TOPIC_0000001938218372__ol15208134912312"><li id="EN-US_TOPIC_0000001938218372__li17208049153115">On the <strong id="EN-US_TOPIC_0000001938218372__b167685512913">Channels</strong> page, click <strong id="EN-US_TOPIC_0000001938218372__b19893195112917">Create channel</strong> and configure a notification channel.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001938218372__table720844933110" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Channel parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001938218372__row15208049183115"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.5.1.1.3.2.3.1.1"><p id="EN-US_TOPIC_0000001938218372__p1320817498312">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.5.1.1.3.2.3.1.2"><p id="EN-US_TOPIC_0000001938218372__p92091049113116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001938218372__row132091049173111"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p182091149143119">Name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p162097493319">Custom channel name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row620924943111"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p4209174983111">Description</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p520911494317">Custom channel description.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1209049153112"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p72091549143118">Type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p6209149183113">Retain the default value <strong id="EN-US_TOPIC_0000001938218372__b105688551357">SMN</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row18209549173119"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p14209174916311">Topic</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.5.1.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p15209184913318">Select the SMN topic you have created in <a href="#EN-US_TOPIC_0000001938218372__section14330827195719">Prerequisites</a> for sending alert messages.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig14698163116915"><span class="figcap"><b>Figure 1 </b>Create channel</span><br><span><img id="EN-US_TOPIC_0000001938218372__image62101449133118" src="figure/en-us_image_0000002417423609.png"></span></div>
</li><li id="EN-US_TOPIC_0000001938218372__li12210194912311">Click <strong id="EN-US_TOPIC_0000001938218372__b1330212407315">Create</strong>.</li><li id="EN-US_TOPIC_0000001938218372__li11210194953116">Return to the <strong id="EN-US_TOPIC_0000001938218372__b12940145031515">Channels</strong> page. If the new channel is displayed, it has been created successfully.<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig179257518918"><span class="figcap"><b>Figure 2 </b>Channels list</span><br><span><img id="EN-US_TOPIC_0000001938218372__image02101349123115" src="figure/en-us_image_0000002417543465.png"></span></div>
</li></ol>
</li><li id="EN-US_TOPIC_0000001938218372__li821013499315">On the OpenSearch Dashboards console, expand the menu in the upper-left corner, and choose <strong id="EN-US_TOPIC_0000001938218372__b1054274365410">Alerting</strong>.</li><li id="EN-US_TOPIC_0000001938218372__li6210249173119">Create a monitor and configure alarm triggers and monitoring frequency.<ol type="a" id="EN-US_TOPIC_0000001938218372__ol1521119499316"><li id="EN-US_TOPIC_0000001938218372__li152119496316">Click the <strong id="EN-US_TOPIC_0000001938218372__b132796291179">Monitors</strong> tab on the <strong id="EN-US_TOPIC_0000001938218372__b22796291271">Alerting</strong> page and click <strong id="EN-US_TOPIC_0000001938218372__b1927917291174">Create monitor</strong> to configure monitor information.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001938218372__table1211164973119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Monitor parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001938218372__row19211134919317"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.7.1.1.4.2.3.1.1"><p id="EN-US_TOPIC_0000001938218372__p1021110493318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.7.1.1.4.2.3.1.2"><p id="EN-US_TOPIC_0000001938218372__p52111649183115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001938218372__row11211549153117"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p521111499310"><strong id="EN-US_TOPIC_0000001938218372__b17211149183118">Monitor details</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row142111049133111"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p102111849173120">Monitor name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p11211144918318">User-defined monitor name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row72115494314"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p122111492316">Monitor type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p693044195719">Monitor type, which can be:</p>
<ul id="EN-US_TOPIC_0000001938218372__ul2097018501513"><li id="EN-US_TOPIC_0000001938218372__li14970115011119">Per query monitor</li><li id="EN-US_TOPIC_0000001938218372__li39701650917">Per bucket monitor</li><li id="EN-US_TOPIC_0000001938218372__li8970250916">Per cluster metrics monitor</li><li id="EN-US_TOPIC_0000001938218372__li139706501013">Per document monitors</li><li id="EN-US_TOPIC_0000001938218372__li697016502010">Composite monitors</li></ul>
<p id="EN-US_TOPIC_0000001938218372__p1084731111562">In this example, <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue19674922125710"><b>Per query monitor</b></span> is selected. For more information, see <a href="https://docs.opensearch.org/2.19/observing-your-data/alerting/monitors/" target="_blank" rel="noopener noreferrer">Monitors</a> in the OpenSearch official documentation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row22118491313"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p22124493315">Monitor defining method</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p72121749123119">Monitor defining method. <strong id="EN-US_TOPIC_0000001938218372__b1529219914610">Extraction query editor</strong> is recommended.</p>
<ul id="EN-US_TOPIC_0000001938218372__ul1621264919313"><li id="EN-US_TOPIC_0000001938218372__li1721294916314"><strong id="EN-US_TOPIC_0000001938218372__b6736133619467">Visual editor</strong></li><li id="EN-US_TOPIC_0000001938218372__li92121496318"><strong id="EN-US_TOPIC_0000001938218372__b20757133920463">Extraction query editor</strong></li><li id="EN-US_TOPIC_0000001938218372__li821215492311"><strong id="EN-US_TOPIC_0000001938218372__b3553243124615">Anomaly detector</strong></li></ul>
<p id="EN-US_TOPIC_0000001938218372__p9212649163118">The options of <strong id="EN-US_TOPIC_0000001938218372__b7410736194610">Monitor defining method</strong> are determined by the <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname18939105011151"><b>Monitor type</b></span> you selected.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1521334912311"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p13213154973114">Detector</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p4213114914319">If <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname444491863810"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue17774287388"><b>Anomaly detector</b></span>, select an exception detection task.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row102131549163118"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1213124915319">Frequency</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p521374963119">Select the monitoring frequency and set the monitoring interval. The options include:</p>
<ul id="EN-US_TOPIC_0000001938218372__ul421310493319"><li id="EN-US_TOPIC_0000001938218372__li1721344910311"><strong id="EN-US_TOPIC_0000001938218372__b1747833411473">By interval</strong></li><li id="EN-US_TOPIC_0000001938218372__li22135499315"><strong id="EN-US_TOPIC_0000001938218372__b6428037144710">Daily</strong></li><li id="EN-US_TOPIC_0000001938218372__li132131649163115"><strong id="EN-US_TOPIC_0000001938218372__b1978023810473">Weekly</strong></li><li id="EN-US_TOPIC_0000001938218372__li121464943120"><strong id="EN-US_TOPIC_0000001938218372__b1398134034716">Monthly</strong></li><li id="EN-US_TOPIC_0000001938218372__li5214949153118"><strong id="EN-US_TOPIC_0000001938218372__b2053745255710">Custom cron expression</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1121464963114"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p182144490311"><strong id="EN-US_TOPIC_0000001938218372__b1521454916313">Select data</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row112144496319"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p192141749123116">Index</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1621404918310">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname74961727542"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue5656105165414"><b>Visual editor</b></span> or <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue93976546542"><b>Extraction query editor</b></span>, you need to specify the index to be monitored.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1121414915312"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p421414943115">Time field</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p921519499316">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname831882715554"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue831862755519"><b>Visual editor</b></span>, you need to specify the time field to define counting parameters such as <strong id="EN-US_TOPIC_0000001938218372__b112801622115113">count</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1221518496315"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p132154492317"><strong id="EN-US_TOPIC_0000001938218372__b122151249133113">Query</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row182159498312"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p18215104914317">Metrics</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p172150498310">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname066111237356"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue7661132310352"><b>Visual editor</b></span>, you need to set the metrics range for extracting statistics.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row7215549163114"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p521594983111">Time range for the last</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p14215184973111">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname3966172553519"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue199662025173512"><b>Visual editor</b></span>, you need to set the monitoring time range for plugins.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row92161049113113"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p22161549183115">Data filter</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p192162495313">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname1714922811354"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue5149122811353"><b>Visual editor</b></span>, you need to set filters for data search.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row82184491315"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1721819491312">Group by</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1321814912314">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname12243029163519"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__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="EN-US_TOPIC_0000001938218372__row2218124973116"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p721874910311">Define extraction query</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p102199494314">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname224475214355"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue18244752163515"><b>Extraction query editor</b></span>, you need to enter the query statement to define the monitoring.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row02198493313"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p15219114918311">Request type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p16219194993111">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname73543016562"><b>Monitor type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue535130165619"><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>
<tr id="EN-US_TOPIC_0000001938218372__row1521917499311"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p6219174943112">Preview query and performance</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p621974919314">Preview the query result and verify query performance under the current configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001938218372__li121915493315">Click <strong id="EN-US_TOPIC_0000001938218372__b1133818268577">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="EN-US_TOPIC_0000001938218372__li121916491314">On the <strong id="EN-US_TOPIC_0000001938218372__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="EN-US_TOPIC_0000001938218372__table1722013496318" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Trigger parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001938218372__row132202493317"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.7.1.3.2.2.3.1.1"><p id="EN-US_TOPIC_0000001938218372__p12220134919312">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.7.1.3.2.2.3.1.2"><p id="EN-US_TOPIC_0000001938218372__p102208494315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001938218372__row922017497315"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1322064912314">Trigger name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p192201449193115">User-defined trigger name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row182209496312"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p9220149203118">Severity level</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p32201249123113">Sensitivity of a trigger, that is, the number of alarms that need to be triggered before an alarm message is sent. <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue22656316527"><b>1</b></span> indicates the highest sensitivity.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row622014494314"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p122024912314">Trigger condition</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1422014916317">Trigger condition. An alarm is triggered when the trigger condition is hit.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1822064973119"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p22211449173111">Action name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p15221549183111">Trigger action name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1122194916313"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1022119490318">Channels</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p2221144919318">Select the SMN destination created in <a href="#EN-US_TOPIC_0000001938218372__li1220804983114">5</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row6221124943118"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p6221114918313">Message subject</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p822120490317">A description of the message.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1022164911317"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p19221154913119">Message</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p222119491319">Alarm message body. By default, the subject and body are defined when the destination is an email address.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1722110493314"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p62221149153110">Perform action</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p72221849173117">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname1418154275516"><b>Monitor type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1795644417551"><b>Per bucket monitor</b></span>, you need to set whether to send alarms in combination. The value can be:</p>
<ul id="EN-US_TOPIC_0000001938218372__ul1322264913111"><li id="EN-US_TOPIC_0000001938218372__li822284973118"><strong id="EN-US_TOPIC_0000001938218372__b9274184742810">Per execution</strong>: A combination alarm is sent when multiple alarm triggering conditions are hit.</li><li id="EN-US_TOPIC_0000001938218372__li122284963119"><strong id="EN-US_TOPIC_0000001938218372__b5811134962814">Per alert</strong>: Alarms are sent separately when multiple alarm triggering conditions are hit.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1122254920311"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p192227494315">Actionable alerts</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p62221449173112">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname036115563612"><b>Monitor type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1361185610616"><b>Per bucket monitor</b></span>, set this parameter to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__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="EN-US_TOPIC_0000001938218372__ul132231449103111"><li id="EN-US_TOPIC_0000001938218372__li322344911317"><strong id="EN-US_TOPIC_0000001938218372__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="EN-US_TOPIC_0000001938218372__li192231349193114"><strong id="EN-US_TOPIC_0000001938218372__b99033103314">New</strong>: Newly created alarms.</li><li id="EN-US_TOPIC_0000001938218372__li1022354910314"><strong id="EN-US_TOPIC_0000001938218372__b12741114133120">Completed</strong>: Alarms that are no longer ongoing.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row112232049143110"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p10223144983117">Throttling</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.7.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p52231549123110">Message sending frequency. It limits the number of notification messages can be received in a specified period.</p>
<p id="EN-US_TOPIC_0000001938218372__p42232049113114">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="EN-US_TOPIC_0000001938218372__fig1016592415398"><span class="figcap"><b>Figure 3 </b>Setting the destination of a trigger action</span><br><span><img id="EN-US_TOPIC_0000001938218372__image12223449153112" src="figure/en-us_image_0000002383984212.png"></span></div>
</li><li id="EN-US_TOPIC_0000001938218372__li92233490312">Click <strong id="EN-US_TOPIC_0000001938218372__b92911530133619">Send test message</strong>. If a subscriber receives an email, as shown in <a href="#EN-US_TOPIC_0000001938218372__fig176191820154018">Figure 5</a>, the trigger is configured successfully.<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig11621753203914"><span class="figcap"><b>Figure 4 </b>Sending a test message</span><br><span><img id="EN-US_TOPIC_0000001938218372__image8223114914318" src="figure/en-us_image_0000002417543469.png"></span></div>
<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig176191820154018"><a name="EN-US_TOPIC_0000001938218372__fig176191820154018"></a><a name="fig176191820154018"></a><span class="figcap"><b>Figure 5 </b>Email notification</span><br><span><img id="EN-US_TOPIC_0000001938218372__image5224174919319" src="figure/en-us_image_0000002383824328.png"></span></div>
</li><li id="EN-US_TOPIC_0000001938218372__li82249495319">Click <strong id="EN-US_TOPIC_0000001938218372__b4366638361">Create</strong> to return to the monitor details page. The detector is successfully created.</li></ol>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001938218372__section116811923135817"><h4 class="sectiontitle">Setting Alarm Notifications via SMN (OpenSearch 1.3.6)</h4><ol id="EN-US_TOPIC_0000001938218372__ol1689223416583"><li id="EN-US_TOPIC_0000001938218372__li111185453113"><span id="EN-US_TOPIC_0000001938218372__ph134648105316">Log in to the CSS management console.</span><p id="EN-US_TOPIC_0000001938218372__p93941231143815">Log in using an account with CSS permissions.</p>
</li><li id="EN-US_TOPIC_0000001938218372__li1711804571114">In the navigation pane on the left, choose <span class="uicontrol" id="EN-US_TOPIC_0000001938218372__uicontrol20645269341"><b>Clusters &gt; OpenSearch</b></span>.</li><li id="EN-US_TOPIC_0000001938218372__li201181045151113">In the cluster list, find the target cluster, and click <strong id="EN-US_TOPIC_0000001938218372__b20192023193417">Dashboards</strong> in the <strong id="EN-US_TOPIC_0000001938218372__b19203231344">Operation</strong> column to log in to OpenSearch Dashboards.</li><li id="EN-US_TOPIC_0000001938218372__li121221820173920">On the <strong id="EN-US_TOPIC_0000001938218372__b4665918509">OpenSearch Dashboards</strong> page, choose <strong id="EN-US_TOPIC_0000001938218372__b3780115884212">OpenSearch Plugins</strong> &gt; <strong id="EN-US_TOPIC_0000001938218372__b568070104315">Alerting</strong> in the navigation tree on the left.</li><li id="EN-US_TOPIC_0000001938218372__li10273150152314"><a name="EN-US_TOPIC_0000001938218372__li10273150152314"></a><a name="li10273150152314"></a>Create an SMN destination to send alert messages.<ol type="a" id="EN-US_TOPIC_0000001938218372__ol691362115234"><li id="EN-US_TOPIC_0000001938218372__li182481829175719">On the <strong id="EN-US_TOPIC_0000001938218372__b2819112316167">Alerting</strong> page, click the <strong id="EN-US_TOPIC_0000001938218372__b681910235168">Destinations</strong> tab, and click <strong id="EN-US_TOPIC_0000001938218372__b58208230169">Add destination</strong> to configure destination information.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001938218372__table15618122633118" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Destinations parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001938218372__row12618826173111"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.2.5.1.1.4.2.3.1.1"><p id="EN-US_TOPIC_0000001938218372__p96181926133112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.2.5.1.1.4.2.3.1.2"><p id="EN-US_TOPIC_0000001938218372__p1361962618318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001938218372__row16619162617318"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p76194264318">Name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p661913261318">User-defined destination name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row106192026203115"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p76196269311">Type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p4619122653112">Retain the default value <strong id="EN-US_TOPIC_0000001938218372__b1775946061">SMN</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1061917268317"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p9619182617312">Topic</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1261972616310">Select the SMN topic you have created in <a href="#EN-US_TOPIC_0000001938218372__section14330827195719">Prerequisites</a> for sending alert messages.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig421554871617"><span class="figcap"><b>Figure 6 </b>Add destination</span><br><span><img id="EN-US_TOPIC_0000001938218372__image15215448161616" src="figure/en-us_image_0000001965417005.png"></span></div>
</li><li id="EN-US_TOPIC_0000001938218372__li1713510575444">Click Create to create destinations.</li><li id="EN-US_TOPIC_0000001938218372__li523715123165">Return to the <strong id="EN-US_TOPIC_0000001938218372__b39591230171619">Destinations</strong> page. If the new channel is displayed, it has been created successfully.<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig1942714216408"><span class="figcap"><b>Figure 7 </b>Destination list</span><br><span><img id="EN-US_TOPIC_0000001938218372__image196531227338" src="figure/en-us_image_0000001938378012.png"></span></div>
</li></ol>
</li><li id="EN-US_TOPIC_0000001938218372__li435962341913">Create a monitor and configure alarm triggers and monitoring frequency.<ol type="a" id="EN-US_TOPIC_0000001938218372__ol1169518450279"><li id="EN-US_TOPIC_0000001938218372__li16328172810195">Click the <strong id="EN-US_TOPIC_0000001938218372__b566604317168">Monitors</strong> tab on the <strong id="EN-US_TOPIC_0000001938218372__b10666144310161">Alerting</strong> page and click <strong id="EN-US_TOPIC_0000001938218372__b266618435163">Create monitor</strong> to configure monitor information.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001938218372__table212044012329" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Monitor parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001938218372__row11201140103215"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.2.6.1.1.4.2.3.1.1"><p id="EN-US_TOPIC_0000001938218372__p1012074023215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.2.6.1.1.4.2.3.1.2"><p id="EN-US_TOPIC_0000001938218372__p14120154063217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001938218372__row5251435152120"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p863803614216"><strong id="EN-US_TOPIC_0000001938218372__b5638193617219">Monitor details</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row312034020327"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p312014063213">Monitor name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p212018404323">User-defined monitor name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row65133917344"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1131754619343">Monitor type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p17762124819313">Monitor type, which can be:</p>
<ul id="EN-US_TOPIC_0000001938218372__ul676254818312"><li id="EN-US_TOPIC_0000001938218372__li676215481131">Per query monitor</li><li id="EN-US_TOPIC_0000001938218372__li27621748834">Per bucket monitor</li><li id="EN-US_TOPIC_0000001938218372__li197622487318">Per cluster metrics monitor</li><li id="EN-US_TOPIC_0000001938218372__li676212481537">Per document monitors</li><li id="EN-US_TOPIC_0000001938218372__li27621948336">Composite monitors</li></ul>
<p id="EN-US_TOPIC_0000001938218372__p2763348533">In this example, <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1245095471810"><b>Per query monitor</b></span> is selected. For more information, see <a href="https://docs.opensearch.org/2.19/observing-your-data/alerting/monitors/" target="_blank" rel="noopener noreferrer">Monitors</a> in the OpenSearch official documentation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1312017409322"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p886634513409">Monitor defining method</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p281462319339">Monitor defining method. <strong id="EN-US_TOPIC_0000001938218372__b883966098">Extraction query editor</strong> is recommended.</p>
<ul id="EN-US_TOPIC_0000001938218372__ul11224133817720"><li id="EN-US_TOPIC_0000001938218372__li922412381574"><strong id="EN-US_TOPIC_0000001938218372__b1665097278">Visual editor</strong></li><li id="EN-US_TOPIC_0000001938218372__li722419381179"><strong id="EN-US_TOPIC_0000001938218372__b714556011">Extraction query editor</strong></li><li id="EN-US_TOPIC_0000001938218372__li12957135034117"><strong id="EN-US_TOPIC_0000001938218372__b843210239">Anomaly detector</strong></li></ul>
<p id="EN-US_TOPIC_0000001938218372__p76204362150">The options of <strong id="EN-US_TOPIC_0000001938218372__b907493826">Monitor defining method</strong> are determined by the <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname941757033"><b>Monitor type</b></span> you selected.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row451617111365"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p2516216364">Detector</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p65161214362">If <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname664852781"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue874301749"><b>Anomaly detector</b></span>, select an exception detection task.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1068417593333"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p12684259173315">Frequency</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p0684145963311">Select the monitoring frequency and set the monitoring interval. The options include:</p>
<ul id="EN-US_TOPIC_0000001938218372__ul19911175713115"><li id="EN-US_TOPIC_0000001938218372__li191175710118"><strong id="EN-US_TOPIC_0000001938218372__b1914598728">By interval</strong></li><li id="EN-US_TOPIC_0000001938218372__li791175721116"><strong id="EN-US_TOPIC_0000001938218372__b1380241175">Daily</strong></li><li id="EN-US_TOPIC_0000001938218372__li991165751112"><strong id="EN-US_TOPIC_0000001938218372__b845095706">Weekly</strong></li><li id="EN-US_TOPIC_0000001938218372__li69110573118"><strong id="EN-US_TOPIC_0000001938218372__b1352701634">Monthly</strong></li><li id="EN-US_TOPIC_0000001938218372__li1291105710111"><strong id="EN-US_TOPIC_0000001938218372__b12651556164716">Custom cron expression</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row12228401225"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p744613292210"><strong id="EN-US_TOPIC_0000001938218372__b29012011123014">Data source</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1534711373436"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p770064464312">Index</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p17001544144320">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname1474596037"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1824017143"><b>Visual editor</b></span> or <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1990649266"><b>Extraction query editor</b></span>, you need to specify the index to be monitored.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row0950144134316"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p207001944144320">Time field</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p97000444439">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname100329102"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1694793849"><b>Visual editor</b></span>, you need to specify the time field to define counting parameters such as <strong id="EN-US_TOPIC_0000001938218372__b1381252584">count</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row310153917191"><td class="cellrowborder" colspan="2" valign="top" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p15965132614223"><strong id="EN-US_TOPIC_0000001938218372__b1996552622210">Query</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row15120333162218"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1812053342213">Metrics</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1412043316226">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname80140762"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1720330271"><b>Visual editor</b></span>, you need to set the metrics range for extracting statistics.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row376424342210"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1676494372220">Time range for the last</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p11764164342218">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname1315766159"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1132917709"><b>Visual editor</b></span>, you need to set the monitoring time range for plugins.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row46465519226"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p564105519228">Data filter</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p66475510229">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname35723923"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue242194276"><b>Visual editor</b></span>, you need to set filters for data search.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row11408562313"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1030821192310">Group by</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1640115112314">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname1615548293"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue2099952427"><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="EN-US_TOPIC_0000001938218372__row19383242153510"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p238354220350">Define extraction query</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p0383104212352">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname527976157"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1938825480"><b>Extraction query editor</b></span>, you need to enter the query statement to define the monitoring.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row2051143155512"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p115843155515">Request type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p9504375519">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname12120192914015"><b>Monitor type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__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="EN-US_TOPIC_0000001938218372__li103721932193717">Click <strong id="EN-US_TOPIC_0000001938218372__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="EN-US_TOPIC_0000001938218372__li107781049123811">On the <strong id="EN-US_TOPIC_0000001938218372__b1191957450">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="EN-US_TOPIC_0000001938218372__table75101458390" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Trigger parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001938218372__row115103454395"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.2.6.1.3.2.2.3.1.1"><p id="EN-US_TOPIC_0000001938218372__p15101845123916">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.2.6.1.3.2.2.3.1.2"><p id="EN-US_TOPIC_0000001938218372__p45101745103918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001938218372__row15510245103917"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1512115333913">Trigger name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p115101245113911">User-defined trigger name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row10510945123914"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p1512117537397">Severity level</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p7510194533919">Sensitivity of a trigger, that is, the number of alarms that need to be triggered before an alarm message is sent. <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue5309103519428"><b>1</b></span> indicates the highest sensitivity.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1314923320263"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p9149143318264">Trigger condition</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1891953220366">Trigger condition. An alarm is triggered when the trigger condition is hit.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row12510164515397"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p3120115315391">Action name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p55101245133919">Trigger action name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row5510164514391"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p912025313399">Destination</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1510745153914">Select the SMN destination created in <a href="#EN-US_TOPIC_0000001938218372__li10273150152314">5</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row17510845103915"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p7119115311396">Message</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1498744018384">Alarm message body By default, the subject and body are defined when the destination is an email address.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row1757544464012"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p857514441406">Perform action</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p1857594415408">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname67935683"><b>Monitor type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1977342002"><b>Per bucket monitor</b></span>, you need to set whether to send alarms in combination. The value can be:</p>
<ul id="EN-US_TOPIC_0000001938218372__ul1298216181676"><li id="EN-US_TOPIC_0000001938218372__li498215181978"><strong id="EN-US_TOPIC_0000001938218372__b224662948">Per execution</strong>: A combination alarm is sent when multiple alarm triggering conditions are hit.</li><li id="EN-US_TOPIC_0000001938218372__li5982171810715"><strong id="EN-US_TOPIC_0000001938218372__b1480341617">Per alert</strong>: Alarms are sent separately when multiple alarm triggering conditions are hit.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row189382817416"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p9893102864114">Actionable alerts</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p11893112814416">When <span class="parmname" id="EN-US_TOPIC_0000001938218372__parmname303227960"><b>Monitor type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue1319537857"><b>Per bucket monitor</b></span>, set this parameter to <span class="parmvalue" id="EN-US_TOPIC_0000001938218372__parmvalue838992031"><b>Per alert</b></span>. You need to set the alarms that can be executed after alarm triggering conditions are hit.</p>
<ul id="EN-US_TOPIC_0000001938218372__ul137643610321"><li id="EN-US_TOPIC_0000001938218372__li376419633215"><strong id="EN-US_TOPIC_0000001938218372__b1813745107">De-duplicated</strong>: Alarms that have been triggered. OpenSearch retains the existing alarms to prevent the plugin from creating duplicate alarms.</li><li id="EN-US_TOPIC_0000001938218372__li167641160325"><strong id="EN-US_TOPIC_0000001938218372__b1645130393">New</strong>: Newly created alarms.</li><li id="EN-US_TOPIC_0000001938218372__li157641620328"><strong id="EN-US_TOPIC_0000001938218372__b893146747">Completed</strong>: Alarms that are no longer ongoing.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001938218372__row16311133802713"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001938218372__p14312133832717">Throttling</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.6.1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001938218372__p15506523417">Message sending frequency. It limits the number of notification messages can be received in a specified period.</p>
<p id="EN-US_TOPIC_0000001938218372__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="EN-US_TOPIC_0000001938218372__fig1342217084217"><span class="figcap"><b>Figure 8 </b>Setting the destination of a trigger action</span><br><span><img id="EN-US_TOPIC_0000001938218372__image960613146474" src="figure/en-us_image_0000001938378016.png"></span></div>
</li><li id="EN-US_TOPIC_0000001938218372__li9544112116446">Click <strong id="EN-US_TOPIC_0000001938218372__b18750935155319">Send test message</strong>. If a subscriber receives an email, as shown in <a href="#EN-US_TOPIC_0000001938218372__fig341274195412">Figure 10</a>, the trigger is configured successfully.<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig2832329115114"><span class="figcap"><b>Figure 9 </b>Sending a test message</span><br><span><img id="EN-US_TOPIC_0000001938218372__image1783342914517" src="figure/en-us_image_0000001938218660.png"></span></div>
<div class="fignone" id="EN-US_TOPIC_0000001938218372__fig341274195412"><a name="EN-US_TOPIC_0000001938218372__fig341274195412"></a><a name="fig341274195412"></a><span class="figcap"><b>Figure 10 </b>Email notification</span><br><span><img id="EN-US_TOPIC_0000001938218372__image9412843542" src="figure/en-us_image_0000001965497233.png"></span></div>
</li><li id="EN-US_TOPIC_0000001938218372__li1545051111553">Click <strong id="EN-US_TOPIC_0000001938218372__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_0212.html">OpenSearch Cluster Monitoring and Log Management</a></div>
</div>
</div>
View Git Blame Copy Permalink