doc-exports/docs/ces/umn/ces_01_0031.html
qiujiandong1 eb9f8a2617 CES UMN -20240202 version
Reviewed-by: Rumpler, Mihály <mihaly.rumpler@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2024-11-08 11:28:13 +00:00

128 lines
15 KiB
HTML

<a name="ces_01_0031"></a><a name="ces_01_0031"></a>
<h1 class="topictitle1">(Optional) Manually Configuring the Agent (Linux)</h1>
<div id="body8662426"><div class="section" id="ces_01_0031__en-us_topic_0078544025_section10035481163223"><h4 class="sectiontitle">Scenarios</h4><p id="ces_01_0031__en-us_topic_0078544025_p51569369182131">After you install the Agent, configure it by clicking <strong id="ces_01_0031__b847713228524">Restore Agent Configurations</strong> on the Cloud Eye console. If the Agent fails to be configured by clicking <strong id="ces_01_0031__b197013204141">Restore Agent Configurations</strong> or due to other reasons, manually configure it by following the instructions provided in this topic.</p>
<p id="ces_01_0031__p2672135072713">This topic takes an ECS as an example. The operations for BMSs are similar.</p>
</div>
<div class="section" id="ces_01_0031__en-us_topic_0078544025_section8243987182032"><h4 class="sectiontitle">Prerequisites</h4><p id="ces_01_0031__en-us_topic_0078544025_p28279724182038">The Agent has been installed.</p>
</div>
<div class="section" id="ces_01_0031__section1224216126319"><h4 class="sectiontitle">Procedure</h4><ol id="ces_01_0031__ol19651111213115"><li id="ces_01_0031__li16631412153116">Log in to an ECS as user <strong id="ces_01_0031__b1319670834">root</strong>.</li><li id="ces_01_0031__li4631191212318">Run the following command to go to the Agent installation path <strong id="ces_01_0031__b842352706163913">bin</strong>:<p id="ces_01_0031__p36311120318"><strong id="ces_01_0031__b32451841142613">cd</strong> <strong id="ces_01_0031__b18246194112617">/usr/local/telescope/bin</strong></p>
</li><li id="ces_01_0031__li56471212103117">Modify configuration file <strong id="ces_01_0031__b842352706111556">conf.json</strong>.<ol type="a" id="ces_01_0031__ol4647111253115"><li id="ces_01_0031__li663241263112">Run the following command to open <strong id="ces_01_0031__b864090566">conf.json</strong>:<p id="ces_01_0031__p14632412143115"><strong id="ces_01_0031__b5121845112619">vi</strong> <strong id="ces_01_0031__b81211845112614">conf.json</strong></p>
</li><li id="ces_01_0031__li1564718125317">Modify the parameters in the file. For details, see <a href="#ces_01_0031__table18647151253120">Table 1</a>.<p id="ces_01_0031__p11634121263114">ECS parameters</p>
<div class="notice" id="ces_01_0031__note153291526174718"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="ces_01_0031__en-us_topic_0000001595976732_en-us_topic_0000001595976732_p1516182912467">Storing plaintext AKs and SKs poses great security risks. You are advised to delegate all ECS or BMS Agents in the region. For details, see <a href="ces_faq_0028.html">How Can I Create an Agency?</a></p>
</div></div>
<p id="ces_01_0031__p2075618916311"></p>
<pre class="screen" id="ces_01_0031__screen26351712103117">{
"InstanceId":"<strong id="ces_01_0031__b5635181211312"><em id="ces_01_0031__i163541233116">XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</em></strong>",
"ProjectId": "<em id="ces_01_0031__i3635612103112"><strong id="ces_01_0031__b196351812133119">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</strong></em>",
"AccessKey": "<em id="ces_01_0031__i6635812163119"><strong id="ces_01_0031__b11635512163116">XXXXXXXXXXXXXXXXXXXX</strong></em>",
"SecretKey": "<em id="ces_01_0031__i663521283120"><strong id="ces_01_0031__b126352012163117">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</strong></em>",
"RegionId": "eu-de",
"ClientPort": 0,
"PortNum": 200
}</pre>
<p id="ces_01_0031__p1763631213318">BMS parameters</p>
<pre class="screen" id="ces_01_0031__screen9639141263116">{
"InstanceId":"<strong id="ces_01_0031__b4639412103115"><em id="ces_01_0031__i263921213118">XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</em></strong>",
"ProjectId": "<em id="ces_01_0031__i1863991212316"><strong id="ces_01_0031__b20639612153110">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</strong></em>",
"AccessKey": "<em id="ces_01_0031__i1639712153117"><strong id="ces_01_0031__b10639112103114">XXXXXXXXXXXXXXXXXXXX</strong></em>",
"SecretKey": "<em id="ces_01_0031__i16639121223116"><strong id="ces_01_0031__b763911220312">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</strong></em>",
"RegionId": "eu-de",
"ClientPort": 0,
"PortNum": 200,
"BmsFlag": true
}</pre>
<div class="tablenoborder"><a name="ces_01_0031__table18647151253120"></a><a name="table18647151253120"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_01_0031__table18647151253120" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Public parameters</caption><thead align="left"><tr id="ces_01_0031__row064151211311"><th align="left" class="cellrowborder" valign="top" width="16.99%" id="mcps1.3.3.2.3.2.2.8.2.3.1.1"><p id="ces_01_0031__p10641912173117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="83.00999999999999%" id="mcps1.3.3.2.3.2.2.8.2.3.1.2"><p id="ces_01_0031__p15641171212312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_01_0031__row1064221233112"><td class="cellrowborder" valign="top" width="16.99%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.1 "><p id="ces_01_0031__p1664141273114">InstanceId</p>
</td>
<td class="cellrowborder" valign="top" width="83.00999999999999%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.2 "><p id="ces_01_0031__p2641412113115">(Optional) Specifies the ECS ID. You can log in to the management console and view the ECS ID in the ECS list.</p>
<div class="note" id="ces_01_0031__note364211223113"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_01_0031__p16759142312296">If you do not configure <strong id="ces_01_0031__b0759182316291">InstanceId</strong>, retain <strong id="ces_01_0031__b10759172352913">"InstanceId":""</strong>.</p>
<p id="ces_01_0031__p914215403355">If you configure it, ensure that the following two requirements are met:</p>
<ul id="ces_01_0031__ul1764218126316"><li id="ces_01_0031__li864281219317">The ECS ID must be unique at all sites, that is, in the same region, <strong id="ces_01_0031__b842352706165813">InstanceId</strong> used by the Agent cannot be the same. Otherwise, errors may occur.</li><li id="ces_01_0031__li96421712143118">The <strong id="ces_01_0031__b842352706165945">InstanceId</strong> value must be consistent with the actual ECS or BMS ID. Otherwise, you cannot see the OS monitoring data on Cloud Eye.</li></ul>
</div></div>
</td>
</tr>
<tr id="ces_01_0031__row1064271283111"><td class="cellrowborder" valign="top" width="16.99%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.1 "><p id="ces_01_0031__p9642171263115">ProjectId</p>
</td>
<td class="cellrowborder" valign="top" width="83.00999999999999%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.2 "><p id="ces_01_0031__p1652184213291">(Optional) Specifies the project ID.</p>
<p id="ces_01_0031__p20617144610296">If you do not configure <strong id="ces_01_0031__b36171646192915">ProjectId</strong>, retain <strong id="ces_01_0031__b10617144612291">"ProjectId": ""</strong>.</p>
<p id="ces_01_0031__p106421212153118">If you configure it, perform the following operations:</p>
<ol id="ces_01_0031__ol8642101263111"><li id="ces_01_0031__li15642212203117">Log in to the Cloud Eye console, click the username in the upper right corner, and choose <strong id="ces_01_0031__b14610185123810">My Credentials</strong>.</li><li id="ces_01_0031__li186421412133114">Under <strong id="ces_01_0031__b858524618381">Projects</strong>, obtain the project ID for the region where the ECS or BMS is located.</li></ol>
</td>
</tr>
<tr id="ces_01_0031__row136431912113113"><td class="cellrowborder" valign="top" width="16.99%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.1 "><p id="ces_01_0031__p264214126314">AccessKey/SecretKey</p>
</td>
<td class="cellrowborder" valign="top" width="83.00999999999999%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.2 "><p id="ces_01_0031__p196421612133120">To obtain the AK and SK, perform the following operations:</p>
<p id="ces_01_0031__p1064261283110">Log in to the Cloud Eye console, click the username in the upper right corner, and choose <strong id="ces_01_0031__b13724411143814">My Credentials</strong>, and choose <strong id="ces_01_0031__b1875064215385">Access Keys</strong>.</p>
<ul id="ces_01_0031__ul13643161293117"><li id="ces_01_0031__li106431112193116">If you have obtained the access key, obtain the <strong id="ces_01_0031__b84235270693234">AccessKey</strong> value and the <strong id="ces_01_0031__b84235270693238">SecretKey</strong> value in the <strong id="ces_01_0031__b19453194284">credentials.csv</strong> file saved when you create <strong id="ces_01_0031__b84235270693310">Access Keys</strong>.</li><li id="ces_01_0031__li764301214316">If no access keys are available, click <strong id="ces_01_0031__b17881640192216">Create Access Key</strong> to create one. Save the <strong id="ces_01_0031__b146423177245">credentials.csv</strong> file and obtain the <strong id="ces_01_0031__b19882154052210">AccessKey</strong> value and the <strong id="ces_01_0031__b588324018222">SecretKey</strong> value in it.<div class="notice" id="ces_01_0031__note1464381218311"><span class="noticetitle"> NOTICE: </span><div class="noticebody"><ul id="ces_01_0031__ul564311219318"><li id="ces_01_0031__li76431212183111">For security purposes, it is recommended that the user be an IAM user with the <strong id="ces_01_0031__b27927327392">CES Administrator</strong> permissions only.</li></ul>
</div></div>
</li></ul>
</td>
</tr>
<tr id="ces_01_0031__row1564512127314"><td class="cellrowborder" valign="top" width="16.99%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.1 "><p id="ces_01_0031__p12645812163116">RegionId</p>
</td>
<td class="cellrowborder" valign="top" width="83.00999999999999%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.2 "><p id="ces_01_0031__p14645612163118">Specifies the region ID. For example, if the ECS is located in region <strong id="ces_01_0031__b13413602333">EU DE</strong>, <strong id="ces_01_0031__b2008893169">RegionId</strong> is <strong id="ces_01_0031__b1121195920">eu-de</strong>.</p>
</td>
</tr>
<tr id="ces_01_0031__row964661218313"><td class="cellrowborder" valign="top" width="16.99%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.1 "><p id="ces_01_0031__p1564691273119">ClientPort</p>
</td>
<td class="cellrowborder" valign="top" width="83.00999999999999%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.2 "><p id="ces_01_0031__p136461012113117">Specifies the start port number used by the Agent.</p>
<div class="note" id="ces_01_0031__note17646712143117"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_01_0031__p1464661253112">The default value is <strong id="ces_01_0031__b842352706145313">0,</strong> indicating that the Agent will randomly use any port. Ports 1 to 1023 are reserved. You are advised not to specify a port in this range for the Agent.</p>
</div></div>
</td>
</tr>
<tr id="ces_01_0031__row186461112183119"><td class="cellrowborder" valign="top" width="16.99%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.1 "><p id="ces_01_0031__p7646111283111">PortNum</p>
</td>
<td class="cellrowborder" valign="top" width="83.00999999999999%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.2 "><p id="ces_01_0031__p56461812143113">Specifies the number of ports configured for the Agent.</p>
<div class="note" id="ces_01_0031__note1264681213117"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_01_0031__p8646181219314">The default value is <strong id="ces_01_0031__b84235270692343">200</strong>. If <strong id="ces_01_0031__b84235270692359">ClientPort</strong> is <strong id="ces_01_0031__b842352706145339">5000</strong>, the port range will be 5000 to 5199.</p>
</div></div>
</td>
</tr>
<tr id="ces_01_0031__row6647131216310"><td class="cellrowborder" valign="top" width="16.99%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.1 "><p id="ces_01_0031__p1264618127313">BmsFlag</p>
</td>
<td class="cellrowborder" valign="top" width="83.00999999999999%" headers="mcps1.3.3.2.3.2.2.8.2.3.1.2 "><p id="ces_01_0031__p15646812133119">Set this parameter to <strong id="ces_01_0031__b6385144774912">true</strong> for a BMS. This parameter is not required by an ECS.</p>
<p id="ces_01_0031__p9646141212318">You do not need to set this parameter for the Windows OS.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ol>
</li><li id="ces_01_0031__li265191203119">Modify configuration file <strong id="ces_01_0031__b842352706193838">conf_ces.json</strong> for the Cloud Eye metric collection module.<ol type="a" id="ces_01_0031__ol18651191243120"><li id="ces_01_0031__li1764721218316">Run the following command to open public configuration file <strong id="ces_01_0031__b842352706164927">conf_ces.json</strong>:<p id="ces_01_0031__p1764715121318"><strong id="ces_01_0031__b5137195610267">vi</strong> <strong id="ces_01_0031__b1713755620263">conf_ces.json</strong></p>
</li><li id="ces_01_0031__li565116126316">Modify the endpoint in <strong id="ces_01_0031__b926119242541">conf_ces.json</strong>, and save the <strong id="ces_01_0031__b7883153119541">conf_ces.json</strong> file. For details, see <a href="#ces_01_0031__table176514120315">Table 2</a>.<pre class="screen" id="ces_01_0031__screen12648191203117">{
"Endpoint": "https://ces.eu-de.otc.t-systems.com"
}</pre>
<div class="tablenoborder"><a name="ces_01_0031__table176514120315"></a><a name="table176514120315"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_01_0031__table176514120315" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter setting of the metric collection module</caption><thead align="left"><tr id="ces_01_0031__row106491612183115"><th align="left" class="cellrowborder" valign="top" width="21.98%" id="mcps1.3.3.2.4.2.2.5.2.3.1.1"><p id="ces_01_0031__p1864971213114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="78.02%" id="mcps1.3.3.2.4.2.2.5.2.3.1.2"><p id="ces_01_0031__p36493121314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_01_0031__row1565081212312"><td class="cellrowborder" valign="top" width="21.98%" headers="mcps1.3.3.2.4.2.2.5.2.3.1.1 "><p id="ces_01_0031__p17650212113119">Endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="78.02%" headers="mcps1.3.3.2.4.2.2.5.2.3.1.2 "><p id="ces_01_0031__p16506128316">Specifies the Cloud Eye endpoint URL in the region of the ECS or BMS. For example, if the ECS or BMS is located in region <strong id="ces_01_0031__b259524032710">EU-DE</strong>, <strong id="ces_01_0031__b970983161719">Endpoint</strong> is <strong id="ces_01_0031__b77107391711">ces.eu-de.otc.t-systems.com</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="ces_01_0031__note56511412153118"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="ces_01_0031__ul2651181293118"><li id="ces_01_0031__li14651512163111">After you configure the Agent, its status is still displayed as <strong id="ces_01_0031__b84235270615929">Uninstalled</strong> because no monitoring data is reported yet. Wait 3 to 5 minutes and refresh the page.</li><li id="ces_01_0031__li4651181213319">If the Agent is in the <strong id="ces_01_0031__b1948763420381">Running</strong> state, the Agent has been installed and has started to collect fine-grained metric data.</li></ul>
</div></div>
</li></ol>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_01_0004.html">Installing and Configuring the Agent on a Linux ECS or BMS</a></div>
</div>
</div>