Connecting Elasticsearch to Projects for Log Service

  • Last update: 2025-05-14
  • Overview

    Elasticsearch is a distributed, open-source search and analysis engine for you to store, retrieve, and analyze massive amounts of data in near real time.

    Featuring flexibility, scalability, and high performance, Elasticsearch has gradually become a core tool in fields such as log management, monitoring, and security analysis.

    FineOps-deployed FanRuan projects support connection to Elasticsearch, which can replace Swift (LogDB) to provide log storage services, collecting requests from nodes, external databases, business databases, and other cluster components in projects.

    This document introduces how to connect Elasticsearch to FanRuan projects to provide log services.

    • You can set up Elasticsearch yourself and adjust the parameters as needed.

    • You can connect Elasticsearch during/after project deployment.

    Confirming Information of the FanRuan Project

    Operation Log Instruction

    Historical Operation Log

    icon

    Note:


    After you switch the log service provider from Swift (LogDB) to Elasticsearch, the historical operation logs stored in Swift (LogDB) of the project will not be migrated automatically.

    If backup is required, use the Syncing Platform Logs to Other Databases plugin to export historical logs to a self-prepared database before migration. For details, see Syncing Platform Logs to Other Databases Plugin.

    New Operation Log

    After you switch the log service provider from Swift (LogDB) to Elasticsearch, the project can no longer access operation logs through the data connection to the LogDB database.

    If you need to view project logs, contact FanRuan technical support personnel for assistance. For details about how to contact technical support personnel, see Technical Support Channel Introduction.

    Confirming the FanRuan Application Type

    Main Application Type

    Only FineBI/FineReport-type FanRuan applications support connection to Elasticsearch for log service.

    FineDataLink-type FanRuan applications only support the use of Swift (LogDB) for log storage.

    Application Deployment Method

    Only FineOps-deployed projects support connection to Elasticsearch for log service.

    Non-FineOps-deployed projects only support the use of Swift (LogDB) for log storage.

    Confirming Plugin Installation

    Connecting RanRuan projects to Elasticsearch requires the Elasticsearch Implementation of LogDB plugin. FineOps-deployed projects have this plugin installed by default.

    Log in to the FanRuan application as the admin, choose System Management > Plugin Management > My Plugins, and check if the Elasticsearch Implementation of LogDB plugin is enabled.

    Install it first if there is no such plugin. Contact technical support personnel to obtain the installation package. To contact technical support personnel, you can send an email to international@fanruan.com or click the  icon in the lower right corner at https://help.fanruan.com/fineops-en/.

    Preparing Elasticsearch

    You need to prepare and deploy Elasticsearch yourself.

    FanRuan does not provide related documentation or guidance. Refer to the official website for assistance. The following section only specifies essential content.

    icon

    Note:


    If lacking sufficient O&M capabilities, you are advised to choose Deploy Elasticsearch in Log Service when deploying a new project using FineOps. This eliminates the need for manual deployment and parameter adjustment of Elasticsearch.

    Elasticsearch Requirement

    RequirementDescription
    VersionIf you use self-provided Elasticsearch, ensure its version is 8.X.
    Operation

    After successful deployment/connection, Elasticsearch cannot be paused, otherwise, the project operation logs may be lost.

    Therefore, you are advised to set Elasticsearch to start automatically upon system reboot.

    Firewall portEnsure that the FanRuan project server has intranet connectivity to the Elasticsearch host and its service port.

    Elasticsearch Information

    Prepare the following Elasticsearch information.

    InformationDescription
    URL

    It refers to the Elasticsearch access address, which is formatted as https://IP address:Port number.

    The default port number is 9200.

    Username

    It refers to the Elasticsearch username.

    The default username is elastic.

    PasswordIt refers to the password of the Elasticsearch user.

    Connecting Elasticsearch to the Project

    You can connect Elasticsearch as the log server using the following two methods. Choose any one as needed.

    Connecting Elasticsearch When Deploying a New Project

    You can connect the self-provided Elasticsearch as the log server in the Project Setting phase during new project deployment. For details, see New Project Deployment.

    1. Set Log Service to Connect to Existing Log Service.

    2. Fill in the Elasticsearch information prepared in the "Elasticsearch Information" section on the Log Service tab page.

    3. Click Test Connection. Elasticsearch can be connected normally if the page prompts "Connected successfully."

    Connecting Elasticsearch in Cluster Management in FineOps

    After the project is successfully deployed, you can connect the self-provided Elasticsearch as the log server in Cluster Management in FineOps.

    1. Log in to FineOps as the admin and select the required O&M project.

    2 Choose Maintenance > Cluster Management and configure Log Server.

    3. Fill in the Elasticsearch information prepared in the "Elasticsearch Information" section.

    4. Click Save. Elasticsearch can be connected normally if the page prompts "Connected successfully."

    5. Click Component Management and restart the project component to apply configuration changes.

    Attachment List


    Theme: Project Management
    • Helpful
    • Not helpful
    • Only read