将 Cloud Logging 代理安装在单个虚拟机上

Logging 代理可将日志从虚拟机实例和选定的第三方软件包流式传输到 Cloud Logging。最好在所有虚拟机实例上都运行 Logging 代理。

Compute Engine 和 Amazon Elastic Compute Cloud (EC2) 的虚拟机映像不包含 Logging 代理,因此您必须完成这些步骤才能在这些实例上安装该代理。该代理可在 Linux 和 Windows 上运行。

如果您的虚拟机在 Google Kubernetes EngineApp Engine 中运行,那么该代理已包含在虚拟机映像中,因此您可以跳过此页面。

如果您运行的专业化日志记录工作负载需要比标准 Cloud Logging 代理更高的吞吐量和/或更高的资源效率,请考虑使用 Ops Agent

准备工作

若要安装该代理,请确保您拥有以下必备组件:

  • Google Cloud 项目或 Amazon Web Services (AWS) 帐号中受支持的虚拟机实例

    • 安装 Logging 代理时,至少需要 250 MiB 的内存,但建议留出 1 GiB 可用内存。

    此外,请确保您的虚拟机运行的是受支持的操作系统

  • 工作区,用于监控此虚拟机实例所在的 AWS 帐号。如需查阅价格信息,请参阅 Google Cloud 的运维套件的价格

  • 虚拟机实例上授权与 Cloud Logging 或 Cloud Monitoring 进行通信的凭据。默认情况下,Compute Engine 虚拟机实例通常具有正确的凭据。如果您属于以下任一种情况,则说明您可能没有正确的凭据,必须完成为代理授权过程:

    • 运行 AWS EC2 虚拟机实例时,您必须先在虚拟机上安装授权凭据,然后才能安装代理。

    • 运行非常旧的 Compute Engine 实例或者在未使用默认凭据的情况下创建的 Compute Engine 实例。

    要检查您是否具有正确的凭据,请运行验证 Compute Engine 凭据过程。

适用于 AWS EC2 虚拟机实例的 Google Cloud 项目

文档中提及与您的虚拟机实例相关联的 Google Cloud 项目时,对于 EC2 虚拟机实例,该短语指的是与您的 AWS 帐号相关联的 AWS 连接器项目

在您将 AWS 帐号连接到工作区时,就会创建一个 AWS 连接器项目。如需识别 AWS 连接器项目,请转到工作区的设置标签页。连接器项目列在 AWS 帐号标题下。项目 ID 列显示了与您的工作区关联的 Google Cloud 项目。

如需详细了解 AWS 连接器项目,请参阅工作区页面

没有远程软件包访问权限的虚拟机

安装 Logging 代理时需要访问远程软件包代码库,以获得代理软件包及其依赖项(在 Linux 上)。如果虚拟机主机的安全政策拒绝访问远程软件包代码库,我们建议在预装代理的情况下创建自定义虚拟机映像,并在该映像中停用软件包管理。

将代理安装在单个虚拟机上

如需安装代理,请按以下说明操作。

AMAZON LINUX AMI/CENTOS/RHEL

  1. 使用 SSH 或类似工具建立与虚拟机实例的终端连接,并确保您拥有 sudo 访问权限。

  2. 切换到您具有写入权限的目录,例如您的主目录。

  3. 添加代理的软件包代码库:

    curl -sSO https://dl.google.com/cloudagents/add-logging-agent-repo.sh
    sudo bash add-logging-agent-repo.sh
    
  4. 安装代理:

    1. 列出代理的可用版本,以选择要安装的版本:

      sudo yum list --showduplicates google-fluentd
      
    2. 对于生产环境,您可能需要固定到某个主要版本,以避免拉取可能包含向后不兼容更改的主要版本。如需固定到某个主要版本,请运行以下命令:

      sudo yum install -y google-fluentd-major-version.*
      

      例如,如果要固定到代理的 1.x.x 版本,请运行以下命令:

      sudo yum install -y google-fluentd-1.*
      
    3. 如果您不想固定到某个主要版本,可以选择其他安装选项之一:

      1. 如需安装代理的特定版本,请运行以下命令:

          sudo yum install -y google-fluentd-version-number
        
      2. 如需安装代理的最新版本,请运行以下命令:

          sudo yum install -y google-fluentd
        
  5. 安装配置文件。

    1. 对于非结构化日志记录,请运行以下命令:

      sudo yum install -y google-fluentd-catch-all-config
      
    2. 对于结构化日志记录,请运行以下命令:

      sudo yum install -y google-fluentd-catch-all-config-structured
      

      如需了解结构化日志记录,请参阅结构化日志记录指南。

  6. 启动代理服务

    sudo service google-fluentd start
    

您可以在安装脚本成功运行后将其删除。

  • 如需验证代理是否按预期工作,请运行以下命令:

    sudo service google-fluentd status
    

    代理的状态应为 OK

  • 您还可以检查日志并确保没有错误:

    tail /var/log/google-fluentd/google-fluentd.log
    

如果您在安装时遇到问题,请参阅问题排查页面。

DEBIAN/UBUNTU

  1. 使用 SSH 或类似工具建立与虚拟机实例的终端连接,并确保您拥有 sudo 访问权限。

  2. 切换到您具有写入权限的目录,例如您的主目录。

  3. 添加代理的软件包代码库:

    curl -sSO https://dl.google.com/cloudagents/add-logging-agent-repo.sh
    sudo bash add-logging-agent-repo.sh
    sudo apt-get update
    
  4. 安装代理:

    1. 列出代理的可用版本,以选择要安装的版本:

      sudo apt-cache madison google-fluentd
      
    2. 对于生产环境,您可能需要固定到某个主要版本,以避免拉取可能包含向后不兼容更改的主要版本。如需固定到某个主要版本,请运行以下命令:

      sudo apt-get install -y 'google-fluentd=major-version.*'
      

      例如,如果要固定到代理的 1.x.x 版本,请运行以下命令:

      sudo apt-get install -y 'google-fluentd=1.*'
      
    3. 如果您不想固定到某个主要版本,可以选择其他安装选项之一:

      1. 如需安装代理的特定版本,请运行以下命令:

          sudo apt-get install -y google-fluentd=version-number
        
      2. 如需安装代理的最新版本,请运行以下命令:

          sudo apt-get install google-fluentd
        
  5. 安装配置文件。

    1. 对于非结构化日志记录,请运行以下命令:

      sudo apt-get install -y google-fluentd-catch-all-config
      
    2. 对于结构化日志记录,请运行以下命令:

      sudo apt-get install -y google-fluentd-catch-all-config-structured
      

      如需了解结构化日志记录,请参阅结构化日志记录指南。

  6. 启动代理服务

    sudo service google-fluentd start
    

您可以在安装脚本成功运行后将其删除。

  • 如需验证代理是否按预期工作,请运行以下命令:

    sudo service google-fluentd status
    

    代理的状态应为 OK

  • 您还可以检查日志并确保没有错误:

    tail /var/log/google-fluentd/google-fluentd.log
    

如果您在安装时遇到问题,请参阅问题排查页面。

SLES / SUSE

  1. 使用 SSH 或类似工具建立与虚拟机实例的终端连接,并确保您拥有 sudo 访问权限。

  2. 切换到您具有写入权限的目录,例如您的主目录。

  3. 添加代理的软件包代码库:

    curl -sSO https://dl.google.com/cloudagents/add-logging-agent-repo.sh
    sudo bash add-logging-agent-repo.sh
    
  4. 安装代理:

    1. 列出代理的可用版本,以选择要安装的版本:

      sudo zypper search -s google-fluentd
      
    2. 对于生产环境,您可能需要固定到某个主要版本,以避免拉取可能包含向后不兼容更改的主要版本。如需固定到某个主要版本,请运行以下命令:

      sudo zypper install -y 'google-fluentd<major-version.0.0'
      

      例如,如果要固定到代理的 1.x.x 版本,请运行以下命令:

      sudo zypper install -y 'google-fluentd<2.0.0'
      
    3. 如果您不想固定到某个主要版本,可以选择其他安装选项之一:

      1. 如需安装代理的特定版本,请运行以下命令:

          sudo zypper install -y google-fluentd=version-number
        
      2. 如需安装代理的最新版本,请运行以下命令:

          sudo zypper install google-fluentd
        
  5. 安装配置文件。

    1. 对于非结构化日志记录,请运行以下命令:

      sudo zypper install -y google-fluentd-catch-all-config
      
    2. 对于结构化日志记录,请运行以下命令:

      sudo zypper install -y google-fluentd-catch-all-config-structured
      

      如需了解结构化日志记录,请参阅结构化日志记录指南。

  6. 启动代理服务

    sudo service google-fluentd start
    

您可以在安装脚本成功运行后将其删除。

  • 如需验证代理是否按预期工作,请运行以下命令:

    sudo service google-fluentd status
    

    代理的状态应为 OK

  • 您还可以检查日志并确保没有错误:

    tail /var/log/google-fluentd/google-fluentd.log
    

如果您在安装时遇到问题,请参阅问题排查页面。

WINDOWS

如需在运行 Windows 的虚拟机实例上安装代理,请执行以下步骤:

  1. 使用 RDP 或类似工具连接到您的实例,然后登录到 Windows。

  2. 打开 PowerShell 终端,然后运行以下 PowerShell 命令。您不需要具备管理员权限。

    cd $env:UserProfile;
    (New-Object Net.WebClient).DownloadFile("https://dl.google.com/cloudagents/windows/StackdriverLogging-v1-12.exe", ".\StackdriverLogging-v1-12.exe")
    .\StackdriverLogging-v1-12.exe
    

    或者,您可以转到以下网址以下载并运行代理的安装程序:

    https://dl.google.com/cloudagents/windows/StackdriverLogging-v1-12.exe

    要以静默方式安装代理,请将 /S 选项附加到安装程序的调用命令中:

    .\StackdriverLogging-v1-12.exe /S
    

    在“静默”模式下,请使用 /D 选项指定安装目录,例如:

    .\StackdriverLogging-v1-12.exe /S /D="C:\Google Cloud's operations suite\Logging\"
    

    您可以在安装程序成功完成安装后将其删除。

    如果您在安装时遇到问题,请参阅问题排查页面。

可选任务

本部分介绍如何执行常见的维护任务。

配置代理

代理会进行预先配置,以监控某些已知的日志位置。在 Linux 上,这些位置在由安装脚本自动提取的 google-fluentd-catch-all-config 软件包中进行描述。在 Windows 上,代理默认监控 Windows 事件日志。如果要调整代理配置,请参阅配置 Logging 代理

配置 HTTP 代理

如果使用 HTTP 代理将请求代理到 Logging API 和 Monitoring API,则请执行以下操作:

LINUX

  1. 修改以下配置文件(如果该文件不存在,则应创建):

     /etc/default/google-fluentd
    
  2. 添加以下几行内容:

     export http_proxy="http://proxy-ip:proxy-port"
     export https_proxy="http://proxy-ip:proxy-port"
     export no_proxy=169.254.169.254  # Skip proxy for the local Metadata Server.
    
  3. 通过在虚拟机实例上运行以下命令来重启 Logging 代理。

     sudo service google-fluentd restart
    

WINDOWS

  1. 如果您使用的是 HTTP 代理,请通过管理员命令提示符运行以下命令。这样做可设置 http_proxyhttps_proxy 环境变量,以便代理可以使用出站 HTTPS 将数据发送到 Logging:

    setx http_proxy http://proxy-ip:proxy-port /m
    setx https_proxy http://proxy-ip:proxy-port /m
    setx no_proxy 169.254.169.254 /m
    

确定代理版本

如需确定系统中 Logging 代理的版本,请在虚拟机实例上运行以下命令:

AMAZON LINUX AMI/CENTOS/RHEL

在 Amazon Linux、Red Hat 或 CentOS Linux 上运行以下命令:

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' \
     google-fluentd 
google-fluentd-catch-all-config
google-fluentd-catch-all-config-structured

DEBIAN/UBUNTU

在 Debian 或 Ubuntu 上运行以下命令:

dpkg-query --show --showformat \
    '${Package} ${Version} ${Architecture} ${Status}\n' \
     google-fluentd 
google-fluentd-catch-all-config
google-fluentd-catch-all-config-structured

SLES / SUSE

在 SUSE 上运行以下命令:

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' \
     google-fluentd 
google-fluentd-catch-all-config
google-fluentd-catch-all-config-structured

WINDOWS

在 Windows 上运行以下命令:

reg query HKLM\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\GoogleStackdriverLoggingAgent\ /v Version

重启代理

您必须重启 Logging 代理才能才能使配置文件中的更改生效。要重启代理,请按以下说明操作。

LINUX

在您的实例上运行以下命令:

 sudo service google-fluentd restart

重启 Logging 代理后,您可能需要发送测试消息

WINDOWS

需要管理员权限:要重启代理,请在 PowerShell 终端中运行以下命令:

Restart-Service -Name StackdriverLogging

升级代理

要将 Logging 代理升级到最新版本,请按以下说明操作:

AMAZON LINUX AMI/CENTOS/RHEL

在 Amazon Linux、Red Hat 或 CentOS Linux 上运行以下命令:

sudo yum upgrade google-fluentd

上一个命令不会更改代理的配置文件。如需获取最新的默认配置和内容全面的配置文件,请在您的实例上运行以下命令:

sudo yum upgrade google-fluentd google-fluentd-catch-all-config

DEBIAN/UBUNTU

在 Debian 或 Ubuntu 上运行以下命令:

sudo apt-get update
sudo apt-get install --only-upgrade google-fluentd

之前的命令不会更改代理的配置文件。如需获取最新的默认配置和内容全面的配置文件,请在您的实例上运行以下命令:

sudo apt-get install --only-upgrade -o Dpkg::Options::="--force-confnew" google-fluentd-catch-all-config
sudo apt-get install --only-upgrade google-fluentd

SLES / SUSE

在 SUSE 上运行以下命令:

sudo zypper update google-fluentd

上一个命令不会更改代理的配置文件。要获取最新的默认配置和内容全面的配置文件,请在您的实例上运行以下命令:

sudo zypper update google-fluentd google-fluentd-catch-all-config

WINDOWS

要升级到最新的代理版本,请按照此页面上在 Windows 上安装部分的说明安装最新代理。安装程序会提示您卸载以前的代理版本。

卸载代理

要移除 Logging 代理及其配置文件,请按以下说明操作。

AMAZON LINUX AMI/CENTOS/RHEL

在 Amazon Linux、Red Hat 或 CentOS Linux 上运行以下命令:

sudo service google-fluentd stop
sudo yum remove google-fluentd google-fluentd-catch-all-config

DEBIAN/UBUNTU

在 Debian 或 Ubuntu 上运行以下命令:

sudo service google-fluentd stop
sudo apt-get remove google-fluentd google-fluentd-catch-all-config

SLES / SUSE

在 SUSE Linux 上运行以下命令:

sudo service google-fluentd stop
sudo zypper remove google-fluentd google-fluentd-catch-all-config

WINDOWS

在 Windows 控制面板中,选择卸载程序。您应该会在可卸载的程序列表中看到 Logging 代理