doc-exports/docs/css/umn/css_01_0138.html
Wuwan, Qi 050b395397 CSS UMN 23.2.1 20230926
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-01-10 14:23:15 +00:00

115 lines
18 KiB
HTML

<a name="css_01_0138"></a><a name="css_01_0138"></a>
<h1 class="topictitle1">Checking Index Monitoring Information</h1>
<div id="body0000001272074721"><p id="css_01_0138__en-us_topic_0000001272074721_p448122681319">You can check preconfigured index monitoring visualizations on the <strong id="css_01_0138__en-us_topic_0000001272074721_b921320550491">Dashboard</strong> and <strong id="css_01_0138__en-us_topic_0000001272074721_b999412111413">Visualizations</strong> pages of Kibana. You can also customize tables and charts.</p>
<div class="section" id="css_01_0138__en-us_topic_0000001272074721_section75371115551"><h4 class="sectiontitle">Prerequisites</h4><p id="css_01_0138__en-us_topic_0000001272074721_p38555178559">A cluster has been created and <a href="css_01_0136.html">index monitoring</a> has been enabled.</p>
</div>
<div class="section" id="css_01_0138__en-us_topic_0000001272074721_section8818191120216"><h4 class="sectiontitle">Checking Dashboard Charts</h4><ol id="css_01_0138__en-us_topic_0000001272074721_ol10251355151712"><li id="css_01_0138__en-us_topic_0000001272074721_li1251855131717">Log in to the CSS management console.</li><li id="css_01_0138__en-us_topic_0000001272074721_li025175511713">Choose <strong id="css_01_0138__en-us_topic_0000001272074721_b05301321114115">Clusters</strong> in the navigation pane. On the <strong id="css_01_0138__en-us_topic_0000001272074721_b198332018153919">Clusters</strong> page, locate the target cluster, and click <strong id="css_01_0138__en-us_topic_0000001272074721_b12180155218215">Access Kibana</strong> in the <strong id="css_01_0138__en-us_topic_0000001272074721_b318119520212">Operation</strong> column.</li><li id="css_01_0138__en-us_topic_0000001272074721_li32535516179">In the navigation tree on the left, click <strong id="css_01_0138__en-us_topic_0000001272074721_b5485734123014">Dashboard</strong>.</li><li id="css_01_0138__en-us_topic_0000001272074721_li17611194311187">Click <strong id="css_01_0138__en-us_topic_0000001272074721_b1571117177344">[Monitoring] Index Monitoring Dashboard</strong> to view the preconfigured dashboard.<div class="fignone" id="css_01_0138__en-us_topic_0000001272074721_fig131111036574"><span class="figcap"><b>Figure 1 </b>Preconfigured dashboard charts</span><br><span><img id="css_01_0138__en-us_topic_0000001272074721_image2011219361673" src="en-us_image_0000001714802245.png"></span></div>
<p id="css_01_0138__en-us_topic_0000001272074721_p172464103376">The preconfigured dashboard displays the number of read and write operations per second in the cluster and the top 10 indexes with the most read and write operations per second.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0138__en-us_topic_0000001272074721_table999011916246" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Preconfigured charts</caption><thead align="left"><tr id="css_01_0138__en-us_topic_0000001272074721_row14990131917243"><th align="left" class="cellrowborder" valign="top" width="39.82%" id="mcps1.3.3.2.4.4.2.3.1.1"><p id="css_01_0138__en-us_topic_0000001272074721_p199014198249">Chart Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.18%" id="mcps1.3.3.2.4.4.2.3.1.2"><p id="css_01_0138__en-us_topic_0000001272074721_p129901819112414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0138__en-us_topic_0000001272074721_row12990201914249"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p11316141415314">[monitoring] markdown</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p10990101919244">Markdown chart, which briefly describes the dashboard content.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row699013195249"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p1228135713522">[monitoring] Indexing Rate (/s)</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p1299081918240">Number of documents written to a cluster per second.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row134109113523"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p178523373524">[monitoring] Search Rate (/s)</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p1141114118526">Average number of queries per second in a cluster.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row5367101635214"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p12367111605215">[monitoring] indexing rate of index for top10</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p17367916145213">Top 10 indexes with the most documents written per second.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row666992119528"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p136697213526">[monitoring] search rate of index for top10</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p566942135213">Top 10 indexes with the most queries per second.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row1719410565404"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p9180193134211">[monitoring] total docs count</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p71801837427">Total number of documents in a cluster.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row380051114112"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p1718016313429">[monitoring] total docs delete</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p17180133134215">Total number of deleted documents in a cluster.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row119253124110"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p1418163124214">[monitoring] total store size in bytes</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p151811137425">Total storage occupied by documents in a cluster.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row1376482614413"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p171812034426">[monitoring] indices store_size for top10</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p218153164215">Top 10 indexes that occupy the largest storage space.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row695417417418"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p141827311421">[monitoring] indices docs_count for top10</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p191829334214">Top 10 indexes with the largest number of documents.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row2097117367414"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p1018253144220">[monitoring] indexing time in millis of index for top10(ms)</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p151838319423">Top 10 indexes with the longest document write latency in a unit time (ms).</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row1481043174117"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p41831733422">[monitoring] search query time in millis of index for top10(ms)</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p13183103104214">Top 10 indexes with the longest index query time in a unit time (ms).</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row541751104118"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p171839317423">[monitoring] segment count of index for top10</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p121836318423">Top 10 indexes with the largest number of index segments.</p>
</td>
</tr>
<tr id="css_01_0138__en-us_topic_0000001272074721_row11418422144114"><td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.4.4.2.3.1.1 "><p id="css_01_0138__en-us_topic_0000001272074721_p14183143154216">[monitoring] segment memory in bytes of index for top10</p>
</td>
<td class="cellrowborder" valign="top" width="60.18%" headers="mcps1.3.3.2.4.4.2.3.1.2 "><p id="css_01_0138__en-us_topic_0000001272074721_p2183339425">Top 10 indexes with the largest heap memory usage of index segments.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="notice" id="css_01_0138__en-us_topic_0000001272074721_note12373171464112"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="css_01_0138__en-us_topic_0000001272074721_p8373101414115">The index pattern of <strong id="css_01_0138__en-us_topic_0000001272074721_b2299101795612">monitoring-eye-css-*</strong> cannot be deleted during index monitoring. Otherwise, the monitoring chart will be abnormal.</p>
</div></div>
</li></ol>
</div>
<div class="section" id="css_01_0138__en-us_topic_0000001272074721_section16777143135916"><h4 class="sectiontitle">Customizing Visualizations Charts</h4><p id="css_01_0138__en-us_topic_0000001272074721_p4455101232715">The index monitoring module periodically stores the index/stats information in the <strong id="css_01_0138__en-us_topic_0000001272074721_b1041553111428">monitoring-eys-css</strong> index. You can use the Kibana chart function to draw customized charts.</p>
<p id="css_01_0138__en-us_topic_0000001272074721_p20800611895">The following procedure describes how to check the trend of the document quantity in a chart as an example.</p>
<ol id="css_01_0138__en-us_topic_0000001272074721_ol1585813235317"><li id="css_01_0138__en-us_topic_0000001272074721_li38581423438">Log in to the CSS management console.</li><li id="css_01_0138__en-us_topic_0000001272074721_li178584230315">Choose <strong id="css_01_0138__en-us_topic_0000001272074721_b11907132375516">Clusters</strong> in the navigation pane. On the <strong id="css_01_0138__en-us_topic_0000001272074721_b996353111349">Clusters</strong> page, locate the target cluster and click <strong id="css_01_0138__en-us_topic_0000001272074721_b491432317550">Access Kibana</strong> in the <strong id="css_01_0138__en-us_topic_0000001272074721_b6914102319558">Operation</strong> column.</li><li id="css_01_0138__en-us_topic_0000001272074721_li16858623138">Choose <strong id="css_01_0138__b15729184210715">Visualize</strong>.</li><li id="css_01_0138__en-us_topic_0000001272074721_li18260111419410">Click <strong id="css_01_0138__b1651314510716">Create visualization</strong> and select <strong id="css_01_0138__b551411451076">TSVB</strong>.</li><li id="css_01_0138__en-us_topic_0000001272074721_li6842444563">Set chart parameters and view the visualizations.<div class="p" id="css_01_0138__en-us_topic_0000001272074721_p21575349169"><a name="css_01_0138__en-us_topic_0000001272074721_li6842444563"></a><a name="en-us_topic_0000001272074721_li6842444563"></a>On the <strong id="css_01_0138__en-us_topic_0000001272074721_b4857202611">Data</strong> tab page, <strong id="css_01_0138__en-us_topic_0000001272074721_b12570191820611">index_stats.primaries.docs.count</strong> indicates the number of documents in the primary shard. <strong id="css_01_0138__en-us_topic_0000001272074721_b125651111579">Derivative</strong> indicates the difference between aggregation buckets. Set <strong id="css_01_0138__en-us_topic_0000001272074721_b77721737575">Unit</strong> to <strong id="css_01_0138__en-us_topic_0000001272074721_b108111039774">1s</strong>, visualizing network rates as "per second". Select <strong id="css_01_0138__en-us_topic_0000001272074721_b530510335810">Positive only</strong> to prevent negative numbers after resetting. To sort statistics by index, set <strong id="css_01_0138__en-us_topic_0000001272074721_b317521510">Group by</strong> to <strong id="css_01_0138__en-us_topic_0000001272074721_b9587193556">Terms</strong> and <strong id="css_01_0138__en-us_topic_0000001272074721_b145085612519">By</strong> to <strong id="css_01_0138__en-us_topic_0000001272074721_b1664414916517">index_stats.index</strong>. Statistics will be grouped by index name.<div class="fignone" id="css_01_0138__en-us_topic_0000001272074721_fig1765911351094"><span class="figcap"><b>Figure 2 </b>TSVB page</span><br><span><img id="css_01_0138__en-us_topic_0000001272074721_image206593357916" src="en-us_image_0000001714802241.png"></span></div>
</div>
<p id="css_01_0138__en-us_topic_0000001272074721_p811935561715">To view data in different time segments, set the aggregation interval, or the displayed data will be incomplete. On the <strong id="css_01_0138__en-us_topic_0000001272074721_b1772465115135">Panel options</strong> tab page, set <strong id="css_01_0138__en-us_topic_0000001272074721_b9471137191410">Interval</strong> to <strong id="css_01_0138__en-us_topic_0000001272074721_b4487892144">1m</strong> or <strong id="css_01_0138__en-us_topic_0000001272074721_b3791611151416">30m</strong> to adjust the interval of <strong id="css_01_0138__en-us_topic_0000001272074721_b1759716151410">timestamp</strong>.</p>
<div class="fignone" id="css_01_0138__en-us_topic_0000001272074721_fig651443721810"><span class="figcap"><b>Figure 3 </b>Setting the interval</span><br><span><img id="css_01_0138__en-us_topic_0000001272074721_image7778529265" src="en-us_image_0000001667002462.png"></span></div>
</li></ol>
</div>
<div class="section" id="css_01_0138__en-us_topic_0000001272074721_section174941953181814"><h4 class="sectiontitle">Importing Index Monitoring Charts</h4><p id="css_01_0138__en-us_topic_0000001272074721_p147121871911">You can import or export charts on Kibana. If the index monitoring charts are not displayed, you can import the charts to Kibana again to load the monitoring view.</p>
<p id="css_01_0138__en-us_topic_0000001272074721_p27112186190">The following describes how to import a chart to Kibana:</p>
<ol id="css_01_0138__en-us_topic_0000001272074721_ol116655475298"><li id="css_01_0138__en-us_topic_0000001272074721_li779343011306">Create the <span class="filepath" id="css_01_0138__en-us_topic_0000001272074721_filepath64661837182419"><b>monitoring-kibana.ndjson</b></span> file by referring to <a href="css_01_0197.html">kibana-monitor</a>.</li><li id="css_01_0138__en-us_topic_0000001272074721_li144515420306">Log in to Kibana and choose <strong id="css_01_0138__en-us_topic_0000001272074721_b1498431363">Management</strong> &gt; <strong id="css_01_0138__en-us_topic_0000001272074721_b5726154618610">Stack Management</strong> &gt; <strong id="css_01_0138__en-us_topic_0000001272074721_b479717811716">Saved objects</strong>.<div class="fignone" id="css_01_0138__en-us_topic_0000001272074721_fig76651555133011"><span class="figcap"><b>Figure 4 </b>Selecting saved objects</span><br><span><img id="css_01_0138__en-us_topic_0000001272074721_image27131815196" src="en-us_image_0000001666842746.png"></span></div>
</li><li id="css_01_0138__en-us_topic_0000001272074721_li633853303019">Click <span class="uicontrol" id="css_01_0138__en-us_topic_0000001272074721_uicontrol11734749194314"><b>Import</b></span> and upload the <strong id="css_01_0138__en-us_topic_0000001272074721_b12101313561">monitoring-kibana.ndjson</strong> file created in step 1.<div class="fignone" id="css_01_0138__en-us_topic_0000001272074721_fig1990354161914"><span class="figcap"><b>Figure 5 </b>Uploading a file</span><br><span><img id="css_01_0138__en-us_topic_0000001272074721_image89015549197" src="en-us_image_0000001714802249.png"></span></div>
</li><li id="css_01_0138__en-us_topic_0000001272074721_li142415419352">After the upload is complete, click <strong id="css_01_0138__en-us_topic_0000001272074721_b1763012186514">Done</strong>. The index monitoring chart is successfully imported.<div class="fignone" id="css_01_0138__en-us_topic_0000001272074721_fig1528381516458"><span class="figcap"><b>Figure 6 </b>Successfully importing index monitoring charts</span><br><span><img id="css_01_0138__en-us_topic_0000001272074721_image72831915154514" src="en-us_image_0000001666842750.png"></span></div>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0134.html">Index Monitoring</a></div>
</div>
</div>