doc-exports/docs/mrs/component-operation-guide/mrs_01_1066.html

<a name="mrs_01_1066"></a><a name="mrs_01_1066"></a>

<h1 class="topictitle1">Typical Scenario: Collecting Logs from Kafka and Uploading Them to HDFS Through the Flume Client</h1>
<div id="body1590374514767"><div class="section" id="mrs_01_1066__sa09be57bc8424fa5868559f0b93a5e0f"><h4 class="sectiontitle">Scenario</h4><p id="mrs_01_1066__a2fdbe65f2a6b44d29de98457ef8bf7a0">This section describes how to use the Flume client to collect logs from the topic list (test1) of the Kafka client and save them to the <span class="filepath" id="mrs_01_1066__filepath1575753210485"><b>/flume/test</b></span> directory on HDFS.</p>
<p id="mrs_01_1066__p1190153615238">This section applies to MRS 3.<em id="mrs_01_1066__i182153139569">x</em> or later clusters.</p>
<div class="note" id="mrs_01_1066__n1c24e0864c8f46ec90574b6cdb537684"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="mrs_01_1066__a6eae353646a34effa2e1ace5538bddfd">By default, the cluster network environment is secure and the SSL authentication is not enabled during the data transmission process. For details about how to use the encryption mode, see <a href="mrs_01_1069.html">Configuring the Encrypted Transmission</a>.</p>
</div></div>
</div>
<div class="section" id="mrs_01_1066__s2c591043ec4f4a73affa1eeec294c526"><h4 class="sectiontitle">Prerequisites</h4><ul id="mrs_01_1066__ua08e403ea2fa44f68dfa92b00eed1580"><li id="mrs_01_1066__l4ef5aa2f014648d8b55c2a4a5516615c">The cluster has been installed, including the HDFS, Kafka, and Flume services.</li><li id="mrs_01_1066__li3520154014471">The Flume client has been installed. For details, see <span id="mrs_01_1066__ph1579144184913"><a href="https://docs.otc.t-systems.com/cmpntguide/mrs/mrs_01_0392.html" target="_blank" rel="noopener noreferrer">Installing the Flume Client</a></span>.</li><li id="mrs_01_1066__l18bdf785d21642c0ac5be50903211f02">You have created user <strong id="mrs_01_1066__b1941017484395">flume_hdfs</strong> and authorized the HDFS directory and data to be operated during log verification.</li><li id="mrs_01_1066__l579cf22f24bf40f2b3bb933038a2ad0c">The network environment of the cluster is secure.</li></ul>
</div>
<div class="section" id="mrs_01_1066__s8a7bc8a8d6dc4259ad505e48de3fef69"><h4 class="sectiontitle">Procedure</h4><ol id="mrs_01_1066__ol82782043123318"><li id="mrs_01_1066__li2268134373311"><span>On FusionInsight Manager, choose <span class="menucascade" id="mrs_01_1066__menucascade136082026142517"><b><span class="uicontrol" id="mrs_01_1066__uicontrol6607102692517">System &gt; User</span></b></span> and choose <span class="menucascade" id="mrs_01_1066__menucascade1860832602514"><b><span class="uicontrol" id="mrs_01_1066__uicontrol26081026142514">More &gt; Download Authentication Credential</span></b></span> to download the Kerberos certificate file of user <strong id="mrs_01_1066__b1460942622515">flume_hdfs</strong> and save it to the local host.</span></li><li id="mrs_01_1066__li122788439332"><span>Configure the client parameters of the Flume role.</span><p><ol type="a" id="mrs_01_1066__ol32781439334"><li id="mrs_01_1066__li2277104353317">Use the Flume configuration tool on FusionInsight Manager to configure the Flume role client parameters and generate a configuration file.<ol class="substepthirdol" id="mrs_01_1066__ol15277104353310"><li id="mrs_01_1066__li132682438330">Log in to FusionInsight Manager and choose<strong id="mrs_01_1066__b1127213142119"> Cluster</strong> &gt; <strong id="mrs_01_1066__b9282151414115">Services</strong>. On the page that is displayed, choose <strong id="mrs_01_1066__b112828145111">Flume</strong>. On the displayed page, click the  <strong id="mrs_01_1066__b828317145118">Configuration Tool</strong> tab.</li><li id="mrs_01_1066__li122684438339">Set <strong id="mrs_01_1066__b817710562612">Agent Name</strong> to <strong id="mrs_01_1066__b191829582618">client</strong>. Select the source, channel, and sink to be used, drag them to the GUI on the right, and connect them.<p id="mrs_01_1066__p5268143183319">For example, use Kafka Source, File Channel, and HDFS Sink.</p>
</li><li id="mrs_01_1066__li8269164313334">Double-click the source, channel, and sink. Set corresponding configuration parameters by referring to <a href="#mrs_01_1066__table15799134418507">Table 1</a> based on the actual environment.<div class="note" id="mrs_01_1066__note2269164316333"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="mrs_01_1066__ul2269843173311"><li id="mrs_01_1066__li5269124323312">If you want to continue using the <strong id="mrs_01_1066__b6228142091116">properties.propretites</strong> file by modifying it, log in to FusionInsight Manager, choose <strong id="mrs_01_1066__b172286206113">Cluster</strong> &gt; <em id="mrs_01_1066__i5229320161112">Name of the desired cluster</em> &gt; <strong id="mrs_01_1066__b112291020111115">Services</strong>. On the page that is displayed, choose <strong id="mrs_01_1066__b9229182091120">Flume</strong>. On the displayed page, click the <strong id="mrs_01_1066__b9230102001110">Configuration Tool</strong> tab, click <strong id="mrs_01_1066__b1823072017111">Import</strong>, import the file, and modify the configuration items related to non-encrypted transmission.</li><li id="mrs_01_1066__li52697432336">It is recommended that the numbers of Sources, Channels, and Sinks do not exceed 40 during configuration file import. Otherwise, the response time may be very long.</li></ul>
</div></div>

<div class="tablenoborder"><a name="mrs_01_1066__table15799134418507"></a><a name="table15799134418507"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_01_1066__table15799134418507" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters to be modified for the Flume role client</caption><thead align="left"><tr id="mrs_01_1066__row1679918448503"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1"><p id="mrs_01_1066__p1279954465011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2"><p id="mrs_01_1066__p17799644105016">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34%" id="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3"><p id="mrs_01_1066__p7799104413508">Example Value</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_01_1066__row9799134416504"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p779954415504">Name</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p127991944165010">The value must be unique and cannot be left blank.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p2799194465012">test</p>
</td>
</tr>
<tr id="mrs_01_1066__row179974425013"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p4799944175019">kafka.topics</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p187999442507">Specifies the subscribed Kafka topic list, in which topics are separated by commas (,). This parameter cannot be left blank.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p13800204455019">test1</p>
</td>
</tr>
<tr id="mrs_01_1066__row1380014447505"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p20800444175016">kafka.consumer.group.id</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p1180054485018">Specifies the data group ID obtained from Kafka. This parameter cannot be left blank.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p17800174419503">flume</p>
</td>
</tr>
<tr id="mrs_01_1066__row380017445501"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p12800044135015">kafka.bootstrap.servers</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p780011441504">Specifies the bootstrap IP address and port list of Kafka. The default value is all Kafka lists in a Kafka cluster. If Kafka has been installed in the cluster and its configurations have been synchronized, this parameter can be left blank.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p188001044145010">192.168.101.10:21007</p>
</td>
</tr>
<tr id="mrs_01_1066__row58001443503"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p1780024415501">batchSize</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p88004447504">Specifies the number of events that Flume sends in a batch (number of data pieces).</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p680034416508">61200</p>
</td>
</tr>
<tr id="mrs_01_1066__row1280084410505"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p1380094412502">dataDirs</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p118001244115016">Specifies the directory for storing buffer data. The run directory is used by default. Configuring multiple directories on disks can improve transmission efficiency. Use commas (,) to separate multiple directories. If the directory is inside the cluster, the <strong id="mrs_01_1066__b20104595681000">/srv/BigData/hadoop/dataX/flume/data</strong> directory can be used. <strong id="mrs_01_1066__b6661897821000">dataX</strong> ranges from data1 to dataN. If the directory is outside the cluster, it needs to be independently planned.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p178005441506">/srv/BigData/hadoop/data1/flume/data</p>
</td>
</tr>
<tr id="mrs_01_1066__row168001544105015"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p7800194417501">checkpointDir</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p19800744195015">Specifies the directory for storing the checkpoint information, which is under the run directory by default. If the directory is inside the cluster, the <strong id="mrs_01_1066__b7306623451000">/srv/BigData/hadoop/dataX/flume/checkpoint</strong> directory can be used. <strong id="mrs_01_1066__b20490785581000">dataX</strong> ranges from data1 to dataN. If the directory is outside the cluster, it needs to be independently planned.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p19800124415019">/srv/BigData/hadoop/data1/flume/checkpoint</p>
</td>
</tr>
<tr id="mrs_01_1066__row138003445504"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p2800124416506">transactionCapacity</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p18800744125012">Specifies the transaction size, that is, the number of events in a transaction that can be processed by the current Channel. The size cannot be smaller than the batchSize of Source. Setting the same size as batchSize is recommended.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p1480119443505">61200</p>
</td>
</tr>
<tr id="mrs_01_1066__row0801154485019"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p4801154405018">hdfs.path</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p118012445509">Specifies the HDFS data write directory. This parameter cannot be left blank.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p18011244115013">hdfs://hacluster/flume/test</p>
</td>
</tr>
<tr id="mrs_01_1066__row1580110444502"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p6801124417502">hdfs.filePrefix</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p2801444155019">Specifies the file name prefix after data is written to HDFS.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p1780117441509">TMP_</p>
</td>
</tr>
<tr id="mrs_01_1066__row780174475012"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p1180120449504">hdfs.batchSize</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p2801144105015">Specifies the maximum number of events that can be written to HDFS once.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p580134405016">61200</p>
</td>
</tr>
<tr id="mrs_01_1066__row5801194425013"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p14801144135018">hdfs.kerberosPrincipal</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p17801124415015">Specifies the Kerberos authentication user, which is mandatory in security versions. This configuration is required only in security clusters.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p9801194417504">flume_hdfs</p>
</td>
</tr>
<tr id="mrs_01_1066__row480174414508"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p12801144445010">hdfs.kerberosKeytab</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p1180154495013">Specifies the keytab file path for Kerberos authentication, which is mandatory in security versions. This configuration is required only in security clusters.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p14801104435019">/opt/test/conf/user.keytab</p>
<div class="note" id="mrs_01_1066__note1680174425011"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="mrs_01_1066__p6801344165016">Obtain the <strong id="mrs_01_1066__b13167454951000">user.keytab</strong> file from the Kerberos certificate file of the user <strong id="mrs_01_1066__b16580011071000">flume_hdfs</strong>. In addition, ensure that the user who installs and runs the Flume client has the read and write permissions on the <strong id="mrs_01_1066__b5966957081000">user.keytab</strong> file.</p>
</div></div>
</td>
</tr>
<tr id="mrs_01_1066__row480124412502"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.1 "><p id="mrs_01_1066__p188011244115015">hdfs.useLocalTimeStamp</p>
</td>
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.2 "><p id="mrs_01_1066__p7801164419507">Specifies whether to use the local time. Possible values are <strong id="mrs_01_1066__b15227233971000">true</strong> and <strong id="mrs_01_1066__b12693067391000">false</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.3.2.2.2.1.1.1.3.3.2.4.1.3 "><p id="mrs_01_1066__p68019449508">true</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="mrs_01_1066__li152771943153315">Click <strong id="mrs_01_1066__b17403381311000">Export</strong> to save the <strong id="mrs_01_1066__b15190264141000">properties.properties</strong> configuration file to the local.</li></ol>
</li><li id="mrs_01_1066__li15278204311335">Upload the <strong id="mrs_01_1066__b5721677701000">properties.properties</strong> file to <strong id="mrs_01_1066__b11730857911000">flume/conf/</strong> under the installation directory of the Flume client.</li><li id="mrs_01_1066__li6278204310334">To connect the Flume client to the HDFS, you need to add the following configuration:<ol class="substepthirdol" id="mrs_01_1066__ol7278843173311"><li id="mrs_01_1066__li22781343113313">Download the Kerberos certificate of account <strong id="mrs_01_1066__b5692048041000">flume_hdfs</strong> and obtain the <strong id="mrs_01_1066__b21250537971000">krb5.conf</strong> configuration file. Upload the configuration file to the <strong id="mrs_01_1066__b12142365351000">fusioninsight-flume-1.9.0/conf/</strong> directory on the node where the client is installed.</li><li id="mrs_01_1066__li1727864315338">In <strong id="mrs_01_1066__b11194893201000">fusioninsight-flume-1.9.0/conf/</strong>, create the <strong id="mrs_01_1066__b20075104651000">jaas.conf</strong> configuration file.<p id="mrs_01_1066__p2278134311335"><strong id="mrs_01_1066__b327834310338">vi jaas.conf</strong></p>
<pre class="screen" id="mrs_01_1066__screen20278194317339">KafkaClient {
com.sun.security.auth.module.Krb5LoginModule required
useKeyTab=true
keyTab="<strong id="mrs_01_1066__b827864363310">/opt/test/conf/user.keytab</strong>"
principal="<strong id="mrs_01_1066__b1227894314334">flume_hdfs@</strong><em id="mrs_01_1066__i1235215297387">&lt;System domain name&gt;</em>"
useTicketCache=false
storeKey=true
debug=true;
};</pre>
<p id="mrs_01_1066__p162781435337">Values of <strong id="mrs_01_1066__b17392194781000">keyTab</strong> and <strong id="mrs_01_1066__b13958809631000">principal</strong> vary depending on the actual situation.</p>
</li><li id="mrs_01_1066__li1627894317331">Obtain configuration files <strong id="mrs_01_1066__b4092624401000">core-site.xml</strong> and <strong id="mrs_01_1066__b10577338651000">hdfs-site.xml</strong> from <strong id="mrs_01_1066__b4598466481000">/opt/FusionInsight_Cluster_<em id="mrs_01_1066__i4182669051000">&lt;Cluster ID&gt;</em>_Flume_ClientConfig/Flume/config</strong> and upload them to <strong id="mrs_01_1066__b6542527891000">fusioninsight-flume-1.9.0/conf/</strong>.</li></ol>
</li><li id="mrs_01_1066__li11278143193313">Run the following command to restart the Flume process:<p id="mrs_01_1066__p1879517526112"><a name="mrs_01_1066__li11278143193313"></a><a name="li11278143193313"></a><strong id="mrs_01_1066__b138321612181211">flume-manager.sh restart</strong></p>
</li></ol>
</p></li></ol><ol start="3" id="mrs_01_1066__ol1526612430336"><li id="mrs_01_1066__li3266843173312"><span>Verify log transmission.</span><p><ol type="a" id="mrs_01_1066__ol926614313335"><li id="mrs_01_1066__li5266134323311">Log in to FusionInsight Manager as a user who has the management permission on HDFS. For details, see <a href="mrs_01_2124.html">Accessing FusionInsight Manager (MRS 3.x or Later)</a>. Choose <strong id="mrs_01_1066__b1714513242119">Cluster</strong> &gt; <strong id="mrs_01_1066__b131461924171117">Services</strong> &gt; <strong id="mrs_01_1066__b214652417116">HDFS</strong>. On the page that is displayed, click the <strong id="mrs_01_1066__b5147162414119">NameNode(</strong><em id="mrs_01_1066__i14147112416113">Node name</em><strong id="mrs_01_1066__b0147162441119">,Active)</strong> link next to <strong id="mrs_01_1066__b71481124151112">NameNode WebUI</strong> to go to the HDFS web UI. On the displayed page, choose <strong id="mrs_01_1066__b161489242113">Utilities</strong> &gt; <strong id="mrs_01_1066__b15148152461118">Browse the file system</strong>.</li><li id="mrs_01_1066__li026614353315">Check whether the data is generated in the <strong id="mrs_01_1066__b7567374561000">/flume/test</strong> directory on the HDFS.</li></ol>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_01_1059.html">Non-Encrypted Transmission</a></div>
</div>
</div>