Help Center > > User Guide> MRS Cluster Component Operation Guide> Using Flume> Installing the Flume Client

Installing the Flume Client

Updated at: Feb 12, 2020 GMT+08:00


To use Flume to collect logs, you must install the Flume client on the log host. You can create an ECS to install the client.


  • A streaming cluster with the Flume component has been created.
  • The log host is in the same VPC and subnet with the cluster. For details, see Using an MRS Client on Nodes Outside a Cluster.
  • You have obtained the username and password for logging in to the log host.


  1. Create an ECS that meets the requirements in the prerequisites.
  2. On the MRS cluster details page, click Components.

    • If the Components tab is not displayed on the cluster details page, perform IAM user synchronization first. (On the Dashboard tab page of the cluster details page, click on the right side of IAM User Sync to synchronize IAM users.)
    • For MRS 2.0.1 or earlier, log in to MRS Manager. For details, see Accessing MRS Manager. Then, choose Services.

  3. Click Download Client.

    1. In Client Type, select All client files.
    2. In Save Path, select Remote host.
    3. Set Host IP Address to the IP address of the ECS, set Host Port to 22, and set Save Path to /tmp.
      • If the default port 22 for logging in to an ECS using SSH has been changed, set Host Port to the new port.
      • Save Path contains a maximum of 256 characters.
    4. Set Login User to root.

      If other users are used, ensure that they have read, write, and execute permission on the save path.

    5. Select Password or SSH Private Key in Login Mode.
      • Password: Enter the password of user root set during cluster creation.
      • SSH Private Key: Select and upload the key file used for creating the cluster.
    6. Click OK to start downloading the client to the ECS.

      If the following information is displayed, the client package is successfully saved.

      Client files downloaded to the remote host successfully.

      If the following information is displayed, check the username, password, and security group configurations of the remote host. Ensure that the username and password are correct and an inbound rule of the SSH(22) port has been added to the security group of the remote host. And then, go to 3 to download the client again.

      Failed to connect to the server. Please check the network connection or parameter settings.

  4. Choose Flume > Instance. Query the Business IP Address of any Flume instance and any two MonitorServer instances.
  5. Log in to the ECS using VNC. See "Logging In to a Linux ECS Using VNC" in the Elastic Cloud Server User Guide (Getting Started > Logging In to an ECS > Logging In to a Linux ECS Using VNC).

    All images support Cloud-Init. The preset username for Cloud-init is root and the password is the one you set during cluster creation. It is recommended that you change the password upon the first login.

  6. On the ECS, switch to user root and copy the installation package to the /opt directory.

    sudo su - root

    cp /tmp/MRS_Flume_Client.tar /opt

  7. Run the following command in the /opt directory to decompress the package and obtain the verification file and the configuration package of the client:

    tar -xvf MRS_Flume_Client.tar

  8. Run the following command to verify the configuration package of the client:

    sha256sum -c MRS_Flume_ClientConfig.tar.sha256

    The command output is as follows:

    MRS_Flume_ClientConfig.tar: OK

  9. Run the following command to decompress MRS_Flume_ClientConfig.tar:

    tar -xvf MRS_Flume_ClientConfig.tar

  10. Run the following command to install the client running environment to a new directory, for example, /opt/Flumeenv. The directory is automatically generated during installation.

    sh /opt/MRS_Flume_ClientConfig/ /opt/Flumeenv

    If the following information is displayed, the client running environment is successfully installed:

    Components client installation is complete.

  11. Run the following command to configure the environment variable:

    source /opt/Flumeenv/bigdata_env

  12. Run the following commands to decompress the Flume client package:

    cd /opt/MRS_Flume_ClientConfig/Flume

    tar -xvf FusionInsight-Flume-1.6.0.tar.gz

  13. Run the following command to check whether the password of the current user has expired:

    chage -l root

    If the value of Password expires is earlier than the current time, the password has expired. Run the chage -M -1 root command to validate the password.

  14. Run the following command to install the Flume client to a new directory, for example, /opt/FlumeClient. The directory is automatically generated during installation.

    sh /opt/MRS_Flume_ClientConfig/Flume/ -d /opt/FlumeClient -f Service IP addresses of the MonitorServer instances -c Path of the Flume configuration file -l /var/log/ -e Service IP address of Flume -n Name of the Flume client

    The parameters are described as follows:

    • -d: indicates the installation path of the Flume client.
    • -f: (optional) indicates the service IP addresses of the two MonitorServer instances, separated by a comma. If the IP addresses are not configured, the Flume client will not send alarm information to MonitorServer, and the client information will not be displayed on MRS Manager.
    • -c: (optional) indicates the configuration file that the Flume client loads after installation. If this parameter is not specified, the fusioninsight-flume-1.6.0/conf/ file in the client installation directory is used by default. The configuration file of the client is empty. You can modify as required and the Flume client will load it automatically.
    • -l: (optional) indicates the log directory. The default value is /var/log/Bigdata.
    • -e: (optional) indicates the service IP address of the Flume instance. It is used to receive the monitoring indicators reported by the client.
    • -n: (optional) indicates the name of the Flume client.
    • IBM JDK does not support -Xloggc. You must change -Xloggc to -Xverbosegclog in flume/conf/ For 32-bit JDK, the value of -Xmx must not exceed 3.25 GB.
    • In flume/conf/, the default value of -Xmx is 4 GB. If the client memory is too small, you can change it to 512 MB or even 1 GB.

    For example, run sh -d /opt/FlumeClient.

    If the following information is displayed, the client is successfully installed:

    install flume client successfully.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?

Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel