yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
03e77f3e5b0080047fdcb72efdfd3333dd3bcf92
doc-exports/docs/css/umn/css_01_0106.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

212 lines
30 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002384208466"></a><a name="EN-US_TOPIC_0000002384208466"></a>
<h1 class="topictitle1">Synchronizing OpenSearch Alerts to Prometheus</h1>
<div id="body0000002384208466"><p id="EN-US_TOPIC_0000002384208466__p4609854145610">Make necessary configurations in OpenSearch Dashboards to synchronize OpenSearch alerts to Prometheus so you can use Prometheus to monitor and analyze key performance metrics for OpenSearch clusters in real time.</p>
<p id="EN-US_TOPIC_0000002384208466__p2026415399212">Prometheus is an open-source monitoring system with a dimensional data model, flexible query language, efficient time series database and modern alerting approach.</p>
<div class="section" id="EN-US_TOPIC_0000002384208466__section1460419465720"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002384208466__p11183175275714">Only OpenSearch 2.19.0 clusters support alarm synchronization to Prometheus.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002384208466__section1200141105812"><h4 class="sectiontitle">Prerequisites</h4><ul id="EN-US_TOPIC_0000002384208466__ul1410920161345"><li id="EN-US_TOPIC_0000002384208466__li13362161915420">The Prometheus monitor server is ready, and the Pushgateway address has been obtained. Prometheus and OpenSearch must be connected. Otherwise, alerts cannot be sent.</li><li id="EN-US_TOPIC_0000002384208466__li16156022543">The target OpenSearch cluster is available.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002384208466__section19926151956"><h4 class="sectiontitle">Configuring Alert Synchronization</h4><ol id="EN-US_TOPIC_0000002384208466__ol1689223416583"><li id="EN-US_TOPIC_0000002384208466__li459563317368"><span id="EN-US_TOPIC_0000002384208466__ph155951533173619">Log in to the CSS management console.</span></li><li id="EN-US_TOPIC_0000002384208466__li3595143316360">In the navigation pane on the left, choose <span class="uicontrol" id="EN-US_TOPIC_0000002384208466__uicontrol459513319367"><b>Clusters &gt; OpenSearch</b></span>.</li><li id="EN-US_TOPIC_0000002384208466__li14595113333614">In the cluster list, find the target cluster, and click <strong id="EN-US_TOPIC_0000002384208466__b973216050115647">Dashboards</strong> in the <strong id="EN-US_TOPIC_0000002384208466__b1433579969115647">Operation</strong> column to log in to OpenSearch Dashboards.</li><li id="EN-US_TOPIC_0000002384208466__li121221820173920">On the <strong id="EN-US_TOPIC_0000002384208466__b73291823779">OpenSearch Dashboards</strong> page, expand the menu in the upper-left corner, and choose <span class="uicontrol" id="EN-US_TOPIC_0000002384208466__uicontrol18131774542"><b>Management &gt; Notifications</b></span>.</li><li id="EN-US_TOPIC_0000002384208466__li10273150152314"><a name="EN-US_TOPIC_0000002384208466__li10273150152314"></a><a name="li10273150152314"></a>Create a Prometheus channel to send alert messages.<ol type="a" id="EN-US_TOPIC_0000002384208466__ol691362115234"><li id="EN-US_TOPIC_0000002384208466__li182481829175719">On the <strong id="EN-US_TOPIC_0000002384208466__b47072121816">Channels</strong> page, click <strong id="EN-US_TOPIC_0000002384208466__b16176109781">Create channel</strong> to configure a channel.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002384208466__table15618122633118" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Channel parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002384208466__row12618826173111"><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_0000002384208466__p96181926133112">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_0000002384208466__p1361962618318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002384208466__row16619162617318"><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_0000002384208466__p76194264318">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_0000002384208466__p661913261318">Custom channel name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row068901284711"><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_0000002384208466__p86901812194719">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_0000002384208466__p1569081218478">Channel description.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row106192026203115"><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_0000002384208466__p12387135164718">Channel 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_0000002384208466__p4619122653112">Select <span class="uicontrol" id="EN-US_TOPIC_0000002384208466__uicontrol122577511599"><b>PROMETHEUS</b></span>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row1061917268317"><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_0000002384208466__p46831413478">Prometheus Endpoint</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_0000002384208466__p13457109151211">Enter the Pushgateway address of the Prometheus monitor server.</p>
<ul id="EN-US_TOPIC_0000002384208466__ul688516572116"><li id="EN-US_TOPIC_0000002384208466__li15885165719112">Currently, only Prometheus Gauge dashboards can be added or deleted. Metrics are queried using specific statements and numeric values are synchronized to Pushgateway for monitoring via Prometheus.</li><li id="EN-US_TOPIC_0000002384208466__li11885115718116">Two types of Pushgateway addresses are supported: HTTP and HTTPS.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="EN-US_TOPIC_0000002384208466__fig35205517144"><span class="figcap"><b>Figure 1 </b>Create channel</span><p id="EN-US_TOPIC_0000002384208466__p676645018497"><span><img id="EN-US_TOPIC_0000002384208466__image19370204125010" src="figure/en-us_image_0000002417955057.png"></span></p>
</div>
</li><li id="EN-US_TOPIC_0000002384208466__li1849112615436">Click <strong id="EN-US_TOPIC_0000002384208466__b1950201811195">Create</strong>.</li><li id="EN-US_TOPIC_0000002384208466__li523715123165">Return to the <strong id="EN-US_TOPIC_0000002384208466__b58261717223">Channels</strong> page. If the newly created Prometheus channel is displayed, it has been created successfully.<div class="fignone" id="EN-US_TOPIC_0000002384208466__fig1833115352112"><span class="figcap"><b>Figure 2 </b>Channels list</span><p id="EN-US_TOPIC_0000002384208466__p9191124775015"><span><img id="EN-US_TOPIC_0000002384208466__image075294714502" src="figure/en-us_image_0000002384396084.png"></span></p>
</div>
</li></ol>
</li><li id="EN-US_TOPIC_0000002384208466__li1016616911519">On the OpenSearch Dashboards console, expand the menu in the upper-left corner, and choose <strong id="EN-US_TOPIC_0000002384208466__b1349652981213">Alerting</strong>.</li><li id="EN-US_TOPIC_0000002384208466__li435962341913">Create a monitor and configure alarm triggers and monitoring frequency.<ol type="a" id="EN-US_TOPIC_0000002384208466__ol1169518450279"><li id="EN-US_TOPIC_0000002384208466__li16328172810195">Click the <strong id="EN-US_TOPIC_0000002384208466__b93711728102216">Monitors</strong> tab on the <strong id="EN-US_TOPIC_0000002384208466__b837182814225">Alerting</strong> page, and click <strong id="EN-US_TOPIC_0000002384208466__b12371228152213">Create monitors</strong> to configure monitor information.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002384208466__table1211164973119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Monitor parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p52111649183115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p521111499310"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b17211149183118">Monitor details</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p11211144918318">User-defined monitor name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p693044195719">Monitor type, which can be:</p>
<ul id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_ul2097018501513"><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li14970115011119">Per query monitor</li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li39701650917">Per bucket monitor</li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li8970250916">Per cluster metrics monitor</li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li139706501013">Per document monitors</li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li697016502010">Composite monitors</li></ul>
<p id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_p1084731111562">In this example, <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p72121749123119">Monitor defining method. <strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b1529219914610">Extraction query editor</strong> is recommended.</p>
<ul id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_ul1621264919313"><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li1721294916314"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b6736133619467">Visual editor</strong></li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li92121496318"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b20757133920463">Extraction query editor</strong></li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li821215492311"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b3553243124615">Anomaly detector</strong></li></ul>
<p id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_p9212649163118">The options of <strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b7410736194610">Monitor defining method</strong> are determined by the <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname18939105011151"><b>Monitor type</b></span> you selected.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p4213114914319">If <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname444491863810"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmvalue17774287388"><b>Anomaly detector</b></span>, select an exception detection task.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p521374963119">Select the monitoring frequency and set the monitoring interval. The options include:</p>
<ul id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_ul421310493319"><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li1721344910311"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b1747833411473">By interval</strong></li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li22135499315"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b6428037144710">Daily</strong></li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li132131649163115"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b1978023810473">Weekly</strong></li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li121464943120"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b1398134034716">Monthly</strong></li><li id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_li5214949153118"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b2053745255710">Custom cron expression</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p182144490311"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b1521454916313">Select data</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p1621404918310">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname74961727542"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmvalue5656105165414"><b>Visual editor</b></span> or <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p921519499316">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname831882715554"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_b112801622115113">count</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p132154492317"><strong id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_b122151249133113">Query</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p172150498310">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname066111237356"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p14215184973111">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname3966172553519"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p192162495313">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname1714922811354"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p1321814912314">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname12243029163519"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p102199494314">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname224475214355"><b>Monitor defining method</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__en-us_topic_0000001938218372_p16219194993111">When <span class="parmname" id="EN-US_TOPIC_0000002384208466__en-us_topic_0000001938218372_parmname73543016562"><b>Monitor type</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__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_0000002384208466__li103721932193717">Click <strong id="EN-US_TOPIC_0000002384208466__b1751629555115647">Create</strong>. The <strong id="EN-US_TOPIC_0000002384208466__b1988961368115647">Create trigger</strong> page is displayed.</li><li id="EN-US_TOPIC_0000002384208466__li107781049123811">On the <strong id="EN-US_TOPIC_0000002384208466__b1238473197115647">Create trigger</strong> page, set the alert triggering conditions and the actions to be triggered.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002384208466__table75101458390" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Trigger parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002384208466__row115103454395"><th align="left" class="cellrowborder" colspan="2" valign="top" id="mcps1.3.5.2.7.1.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000002384208466__p15101845123916">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" id="mcps1.3.5.2.7.1.3.2.2.4.1.2"><p id="EN-US_TOPIC_0000002384208466__p45101745103918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002384208466__row15510245103917"><td class="cellrowborder" rowspan="3" valign="top" width="20%" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p1577019266238">Define trigger</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p1512115333913">Trigger name</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.7.1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002384208466__p115101245113911">User-defined trigger name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row10510945123914"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p1512117537397">Severity level</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__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_0000002384208466__parmvalue7612182132513"><b>1</b></span> indicates the highest sensitivity.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row391914323362"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p179191732133610">Trigger condition</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p1891953220366">Trigger condition. An alarm is triggered when the trigger condition is hit.</p>
<div class="note" id="EN-US_TOPIC_0000002384208466__note1962412316323"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000002384208466__p3624235321">You are advised to set a trigger condition that can almost always be triggered so that the queried metrics will always be synchronized to the Pushgateway.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row12510164515397"><td class="cellrowborder" rowspan="4" valign="top" width="20%" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p97103832513">Configure actions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p3120115315391">Action name</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.7.1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002384208466__p55101245133919">Trigger action name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row5510164514391"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p912025313399">Destination</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p1510745153914">Select the destination created in <a href="#EN-US_TOPIC_0000002384208466__li10273150152314">5</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row17510845103915"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p7119115311396">Message</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p1355095715356">Defines the body of the message to be published, which must use the JSON format. See the following for an example.</p>
<pre class="screen" id="EN-US_TOPIC_0000002384208466__screen15998141712618">{
"metricsName":"hits_total_value", //Prometheus metric name
"metricsLabel": {"label_key1":"label_value1","label_key2":"label_value2"}, //Prometheus labels
"metricsValue":{{ctx.results.0.hits.total.value}}, //Prometheus metric values
"jobName":"job_name" //Prometheus monitor task name
"metricsHelp":"***" //Metric explanation. Optional.
}</pre>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002384208466__row1850195216417"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p17501152124119">throttling</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.7.1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002384208466__p15506523417">Message sending frequency. It limits the number of notification messages can be received in a specified period.</p>
<p id="EN-US_TOPIC_0000002384208466__p145154674413">For example, if this parameter is set to 10 minutes, Prometheus sends only one alert notification in the next 10 minutes even if the trigger condition is met multiple times. After 10 minutes, Prometheus sends another alert notification if the trigger condition is met again.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000002384208466__li8233101591710">Click <strong id="EN-US_TOPIC_0000002384208466__b1753453771115647">Send test message</strong> to send a test message to Prometheus to check whether the trigger is set successfully.<div class="fignone" id="EN-US_TOPIC_0000002384208466__fig12841433132117"><span class="figcap"><b>Figure 3 </b>Send a test message.</span><br><span><img id="EN-US_TOPIC_0000002384208466__image849135765519" src="figure/en-us_image_0000002417960673.png"></span></div>
<p id="EN-US_TOPIC_0000002384208466__p287342401817">As shown in <a href="#EN-US_TOPIC_0000002384208466__fig341274195412">Figure 4</a>, Prometheus can receive a triggered message, meaning the trigger is set successfully.</p>
<div class="fignone" id="EN-US_TOPIC_0000002384208466__fig341274195412"><a name="EN-US_TOPIC_0000002384208466__fig341274195412"></a><a name="fig341274195412"></a><span class="figcap"><b>Figure 4 </b>Message received successfully</span><br><span><img id="EN-US_TOPIC_0000002384208466__image9412843542" src="figure/en-us_image_0000002384208558.png"></span></div>
</li><li id="EN-US_TOPIC_0000002384208466__li1545051111553">Click <strong id="EN-US_TOPIC_0000002384208466__b1058272579115647">Create</strong> to return to the <strong id="EN-US_TOPIC_0000002384208466__b677674413115647">Monitor</strong> details page.</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