All Products
Search

This Product

    Log Service:Install Logtail on a Windows server

    Document Center

    Log Service:Install Logtail on a Windows server

    Last Updated:Aug 11, 2023

    This topic describes how to install Logtail on a Windows server.

    Prerequisites

    • At least one Windows server is available.

    • The type of the network that is required to collect logs is determined. You can determine the network type based on the type of the server on which you want to install Logtail and the region where the server resides. For more information, see Select a network type.

    Supported operating systems

    The following Windows operating systems are supported:

    Note

    • If your server uses Windows Server 2008 or Windows 7, make sure that the operating systems run on x86 or x86_64.

    • If your server uses a different Windows operating system, make sure that the operating system runs on x86_64.

    • Microsoft Windows Server 2008

    • Microsoft Windows Server 2012

    • Microsoft Windows Server 2016

    • Microsoft Windows Server 2019

    • Microsoft Windows Server 2022

    • Microsoft Windows 7

    • Microsoft Windows 10

    • Microsoft Windows Server Version 1909

    • Microsoft Windows Server Version 2004

    Install Logtail

    Important

    Simple Log Service cannot obtain information about the owner of Elastic Compute Service (ECS) instances that belong to a different Alibaba Cloud account. Simple Log Service also cannot obtain information about the owner of servers in data centers or servers from third-party cloud service providers. After Logtail is installed, you must specify the IDs of Alibaba Cloud accounts as user identifiers for the servers. For more information, see Configure a user identifier.

    1. Log on to your server.

    2. Download an installation package based on your business requirements.

    3. Decompress the logtail_installer.zip package to the current directory.

    4. Select an installation command based on the network type and the region where your Simple Log Service project resides, and run the installation command.

      Run Windows PowerShell or Command Prompt as an administrator. Go to the logtail_installer directory and run the installation command. The directory contains the files that are extracted from the installation package.

      Region

      Alibaba Cloud internal network (classic network or VPC)

      Internet

      Global acceleration

      China (Qingdao)

      .\logtail_installer.exe install cn-qingdao

      .\logtail_installer.exe install cn-qingdao-internet

      .\logtail_installer.exe install cn-qingdao-acceleration

      China (Beijing)

      .\logtail_installer.exe install cn-beijing

      .\logtail_installer.exe install cn-beijing-internet

      .\logtail_installer.exe install cn-beijing-acceleration

      China (Zhangjiakou)

      .\logtail_installer.exe install cn-zhangjiakou

      .\logtail_installer.exe install cn-zhangjiakou-internet

      .\logtail_installer.exe install cn-zhangjiakou-acceleration

      China (Hohhot)

      .\logtail_installer.exe install cn-huhehaote

      .\logtail_installer.exe install cn-huhehaote-internet

      .\logtail_installer.exe install cn-huhehaote-acceleration

      China (Ulanqab)

      .\logtail_installer.exe install cn-wulanchabu

      .\logtail_installer.exe install cn-wulanchabu-internet

      .\logtail_installer.exe install cn-wulanchabu-acceleration

      China (Hangzhou)

      .\logtail_installer.exe install cn-hangzhou

      .\logtail_installer.exe install cn-hangzhou-internet

      .\logtail_installer.exe install cn-hangzhou-acceleration

      China (Shanghai)

      .\logtail_installer.exe install cn-shanghai

      .\logtail_installer.exe install cn-shanghai-internet

      .\logtail_installer.exe install cn-shanghai-acceleration

      China (Shenzhen)

      .\logtail_installer.exe install cn-shenzhen

      .\logtail_installer.exe install cn-shenzhen-internet

      .\logtail_installer.exe install cn-shenzhen-acceleration

      China (Heyuan)

      .\logtail_installer.exe install cn-heyuan

      .\logtail_installer.exe install cn-heyuan-internet

      .\logtail_installer.exe install cn-heyuan-acceleration

      China (Guangzhou)

      .\logtail_installer.exe install cn-guangzhou

      .\logtail_installer.exe install cn-guangzhou-internet

      .\logtail_installer.exe install cn-guangzhou-acceleration

      China (Chengdu)

      .\logtail_installer.exe install cn-chengdu

      .\logtail_installer.exe install cn-chengdu-internet

      .\logtail_installer.exe install cn-chengdu-acceleration

      China (Hong Kong)

      .\logtail_installer.exe install cn-hongkong

      .\logtail_installer.exe install cn-hongkong-internet

      .\logtail_installer.exe install cn-hongkong-acceleration

      US (Silicon Valley)

      .\logtail_installer.exe install us-west-1

      .\logtail_installer.exe install us-west-1-internet

      .\logtail_installer.exe install us-west-1-acceleration

      US (Virginia)

      .\logtail_installer.exe install us-east-1

      .\logtail_installer.exe install us-east-1-internet

      .\logtail_installer.exe install us-east-1-acceleration

      Singapore

      .\logtail_installer.exe install ap-southeast-1

      .\logtail_installer.exe install ap-southeast-1-internet

      .\logtail_installer.exe install ap-southeast-1-acceleration

      Australia (Sydney)

      .\logtail_installer.exe install ap-southeast-2

      .\logtail_installer.exe install ap-southeast-2-internet

      .\logtail_installer.exe install ap-southeast-2-acceleration

      Malaysia (Kuala Lumpur)

      .\logtail_installer.exe install ap-southeast-3

      .\logtail_installer.exe install ap-southeast-3-internet

      .\logtail_installer.exe install ap-southeast-3-acceleration

      Indonesia (Jakarta)

      .\logtail_installer.exe install ap-southeast-5

      .\logtail_installer.exe install ap-southeast-5-internet

      .\logtail_installer.exe install ap-southeast-5-acceleration

      Philippines (Manila)

      .\logtail_installer.exe install ap-southeast-6

      .\logtail_installer.exe install ap-southeast-6-internet

      .\logtail_installer.exe install ap-southeast-6-acceleration

      Thailand (Bangkok)

      .\logtail_installer.exe install ap-southeast-7

      .\logtail_installer.exe install ap-southeast-7-internet

      .\logtail_installer.exe install ap-southeast-7-acceleration

      India (Mumbai)

      .\logtail_installer.exe install ap-south-1

      .\logtail_installer.exe install ap-south-1-internet

      .\logtail_installer.exe install ap-south-1-acceleration

      Japan (Tokyo)

      .\logtail_installer.exe install ap-northeast-1

      .\logtail_installer.exe install ap-northeast-1-internet

      .\logtail_installer.exe install ap-northeast-1-acceleration

      South Korea (Seoul)

      .\logtail_installer.exe install ap-northeast-2

      .\logtail_installer.exe install ap-northeast-2-internet

      .\logtail_installer.exe install ap-northeast-2-acceleration

      Germany (Frankfurt)

      .\logtail_installer.exe install eu-central-1

      .\logtail_installer.exe install eu-central-1-internet

      .\logtail_installer.exe install eu-central-1-acceleration

      UAE (Dubai)

      .\logtail_installer.exe install me-east-1

      .\logtail_installer.exe install me-east-1-internet

      .\logtail_installer.exe install me-east-1-acceleration

      UK (London)

      .\logtail_installer.exe install eu-west-1

      .\logtail_installer.exe install eu-west-1-internet

      .\logtail_installer.exe install eu-west-1-acceleration

    Installation path

    You can install Logtail for 32-bit Windows or Logtail for 64-bit Windows on your Windows server. The installation path varies based on the operating system.

    Important

    After you run the installation command, Logtail is automatically installed in the default installation path.

    • Logtail for 32-bit Windows

      • Installation path of Logtail for 32-bit Windows in a 32-bit Windows operating system: C:\Program Files\Alibaba\Logtail

      • Installation path of Logtail for 32-bit Windows in a 64-bit Windows operating system: C:\Program Files (x86)\Alibaba\Logtail

        Note

        You can run 32-bit and 64-bit applications in a 64-bit Windows operating system. The operating system stores 32-bit applications in a separate x86 directory to ensure compatibility.

    • Logtail for 64-bit Windows

      You can install Logtail for 64-bit Windows only in a 64-bit Windows operating system. The installation path is C:\Program Files\Alibaba\Logtail.

    View the status of Logtail

    View the status of Logtail to check whether Logtail is installed on your server.

    1. Open the Run window and enter services.msc to open the Services window.

    2. View the status of the LogtailDaemon or LogtailWorker service. For Logtail V1.0.0.0 or later, view the status of the LogtailDaemon service. For Logtail V0.x.x.x, view the status of the LogtailWorker service.

      If the services are in the Running state, Logtail is installed.

    View the version of Logtail

    Go to the installation path and open the app_info.json file. The value of the logtail_version field in the file is the Logtail version.

    In the following example, the Logtail version is 1.0.0.0. 

    {
    "logtail_version" : "1.0.0.0"
}

    Update Logtail

    To update Logtail, you must download and decompress the most recent installation package. Then, you can install Logtail as prompted to complete the update. For more information, see Install Logtail.

    Important

    • During an update, Logtail is automatically uninstalled and then reinstalled. The original files in the installation path are deleted. Before you update Logtail, we recommend that you back up the files.

    • If you want to update Logtail for 32-bit Windows to Logtail for 64-bit Windows in a 64-bit Windows operating system, you must uninstall Logtail for 32-bit Windows and then reinstall Logtail for 64-bit Window.

    Start and stop Logtail

    1. Log on to your server.

    2. Choose Start Menu > Control Panel > Administrative Tools > Services.

    3. In the Services dialog box, select the service that you want to manage.

      • For Logtail V0.x.x.x, select LogtailWorker.

      • For Logtail V1.0.0.0 or later, select LogtailDaemon.

    4. Right-click the service and select Start, Stop, or Restart.

    Uninstall Logtail

    Run Windows PowerShell or Command Prompt as an administrator. Go to the logtail_installer directory and run the following command to uninstall Logtail. The directory contains the files that are extracted from the installation package. 

    .\logtail_installer.exe uninstall

    After Logtail is uninstalled, the Logtail installation directory is deleted. However, some configuration files are retained in the C:\LogtailData directory. You can manually delete the files based on your business requirements. The following configuration files are retained:

    • checkpoint: contains information about the checkpoints that are generated by Logtail plug-ins. This file is generated only if the Logtail plug-ins are used.

    • user_config.d: contains local collection configurations.

      JSON files are considered collection configurations. For example, /usr/local/ilogtail/user_log_config.json is considered a collection configuration.

    • logtail_check_point: contains information about the checkpoints that are generated by Logtail.

    • users: contains the user identifier files that are configured.