All Products
Search

This Product

    Elasticsearch:Modify shipper configurations

    Document Center

    Elasticsearch:Modify shipper configurations

    Last Updated:Nov 08, 2024

    After you install a shipper, you can modify its configuration on the Beats Data Shippers page of the Elasticsearch console.

    Prerequisites

    A shipper is installed. For more information, see Collect the logs of an ECS instance. In this topic, a Filebeat shipper is used.

    Procedure

    1. Log on to the Alibaba Cloud Elasticsearch console.

    2. In the left-side navigation pane, click Beats Data Shippers.

    3. In the Manage Shippers section, find the Filebeat shipper whose configurations you want to modify and click Configure in the Actions column.

    4. In the Configure Shipper panel, click Modify. Then, modify the configurations of the Filebeat shipper based on your business requirements.

      Parameter

      Description

      Output

      The destination for the data collected by the shipper. The system provides Elasticsearch and Logstash clusters for you to select. The protocol must be the same as that of the selected Elasticsearch cluster.

      Username and Password

      If you select Elasticsearch for Output, enter the username and password used to access the destination Elasticsearch cluster. This way, the shipper can write data to the cluster. The default username is elastic. The password is specified when you create the Elasticsearch cluster. If you forget the password, you can reset it. For more information about the procedure and precautions for resetting the password, see Reset the access password for an Elasticsearch cluster.

      Enable Kibana Monitoring

      Specifies whether to monitor the metrics of the shipper. If you select Elasticsearch for Output, the Kibana monitor uses the same Elasticsearch cluster as Output. If you select Logstash for Output, you must configure a monitor in the configuration file of the destination Logstash cluster.

      Enable Kibana Dashboard

      Specifies whether to enable the default Kibana dashboard. Alibaba Cloud Kibana is deployed in a VPC. You must enable the Private Network Access feature for Kibana on the Kibana Configuration page. For more information, see Configure a public or private IP address whitelist for Kibana.

      Filebeat File Path

      This parameter is specific to Filebeat shippers. Alibaba Cloud deploys Beats with Docker. You must map the directory from which logs are collected to Docker. We recommend that you specify a directory that is consistent with input.path in filebeat.yml.

      Shipper YML Configuration

      The YML configuration file of the shipper. You can modify the configuration file based on your business requirements. For more information, see Prepare a YML configuration file for a shipper.

      Important

      If you already configure Output, you do not need to specify the destination again in Shipper YML Configuration. Otherwise, the system reports a shipper installation error.

    5. Click Save.

      After you save the modifications, the shipper is in the Enabling state. After the state changes to Enabled, the shipper configuration modification is complete.