個々の VM に Ops エージェントをインストールする

Ops エージェントは、Compute Engine インスタンスのログと指標を収集して、Cloud Logging にログを送信し、Cloud Monitoring に指標を送信します。

始める前に

エージェントをインストールするには、次のものが必要です。

コマンドラインを使用したエージェントのインストール

コマンドラインを使用してエージェントをインストールするには、次の手順を行います。

最新バージョンのエージェントをインストールする

エージェントの最新バージョンをインストールする手順は次のとおりです。

Linux

  1. SSH または同様のツールを使用して、VM インスタンスへのターミナル接続を開き、sudo アクセス権があることを確認します。

  2. たとえば、ホーム ディレクトリなど、書き込みアクセス権があるディレクトリに移動します。

  3. 下記を実行します。

    curl -sSO https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.sh
    sudo bash add-google-cloud-ops-agent-repo.sh --also-install
    

Windows

  1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。

  2. PowerShell アイコンを右クリックし、[管理者として実行] を選択して、管理者権限で PowerShell ターミナルを開きます。

  3. 次の PowerShell コマンドを実行します。

    (New-Object Net.WebClient).DownloadFile("https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.ps1", "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1")
    Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall"
    

特定のバージョンのエージェントをインストールする

特定のバージョンのエージェントをインストールするには、次の手順を行います。

Linux

  1. SSH または同様のツールを使用して、VM インスタンスへのターミナル接続を開き、sudo アクセス権があることを確認します。

  2. たとえば、ホーム ディレクトリなど、書き込みアクセス権があるディレクトリに移動します。

  3. エージェントのインストール スクリプトをダウンロードします。

    curl -sSO https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.sh
    

    add-google-cloud-ops-agent-repo.sh スクリプトを実行するときに、次のフラグを設定することもできます。

    • --verbose: スクリプトの実行中に詳細ログを有効にします。
    • --also-install: エージェント パッケージ リポジトリを追加した後にエージェントをインストールします。
    • --version: スクリプトをインストールするエージェントのバージョンを設定します。
    • --uninstall: エージェントをアンインストールします。
    • --remove-repo: エージェントをインストールまたはアンインストールした後に、対応するエージェント パッケージ リポジトリを削除します。
    • --dry-run: スクリプト実行のドライランのみがトリガーされ、実行するはずのコマンドを出力します。
    • --uninstall-standalone-logging-agent: 従来の Logging エージェント(StackdriverLogging)をアンインストールします。
    • --uninstall-standalone-monitoring-agent: 従来の Monitoring エージェント(StackdriverMonitoring)をアンインストールします。

    詳細と使用例については、スクリプトのコメントをご覧ください。

  4. エージェントのパッケージ リポジトリを追加して、エージェントをインストールします。

    1. インストール可能なエージェントのバージョンを選択する方法については、すべてのエージェント バージョンを一覧表示するをご覧ください。

    2. 本番環境では、下位互換性のない変更を含む可能性のあるメジャー バージョンをインストールしないように、メジャー バージョンに固定することをおすすめします。メジャー バージョンに固定するには、次のコマンドを実行します。

      sudo bash add-google-cloud-ops-agent-repo.sh --also-install \
        --version=MAJOR_VERSION.*.*
      

      たとえば、エージェントの 1.x.x に固定するには、次のコマンドを実行します。

      sudo bash add-google-cloud-ops-agent-repo.sh --also-install \
        --version=1.*.*
      
    3. 特定のバージョンのエージェントをインストールするには、次のコマンドを実行します。

      sudo bash add-google-cloud-ops-agent-repo.sh --also-install \
        --version=MAJOR_VERSION.MINOR_VERSION.PATCH_VERSION
      

正常に実行されたら、インストール スクリプトを削除します。

  • エージェントが期待どおりに動作していることを確認するには、次のコマンドを実行します。

    sudo systemctl status google-cloud-ops-agent"*"
    

    エージェントのステータスは OK である必要があります。

インストールに問題がある場合は、トラブルシューティング ページをご覧ください。

Windows

  1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。

  2. PowerShell アイコンを右クリックし、[管理者として実行] を選択して、管理者権限で PowerShell ターミナルを開きます。

  3. エージェントのインストール スクリプトをダウンロードします。

    (New-Object Net.WebClient).DownloadFile("https://dl.google.com/cloudagents/add-google-cloud-ops-agent-repo.ps1", "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1")
    

    add-google-cloud-ops-agent-repo.ps1 スクリプトを実行するときに、次のフラグを設定することもできます。

    • -Verbose: スクリプトの実行中に詳細ログを有効にします。
    • -AlsoInstall: エージェント パッケージ リポジトリを追加した後にエージェントをインストールします。
    • -Version: スクリプトをインストールするエージェントのバージョンを設定します。
    • -Uninstall: エージェントをアンインストールします。
    • -RemoveRepo: エージェントをインストールまたはアンインストールした後に、対応するエージェント パッケージ リポジトリを削除します。
    • -WhatIf: スクリプト実行のドライランのみがトリガーされ、実行するはずのコマンドを出力します。
    • -UninstallStandaloneLoggingAgent: 従来の Logging エージェント(StackdriverLogging)をアンインストールします。
    • -UninstallStandaloneMonitoringAgent: 従来の Monitoring エージェント(StackdriverMonitoring)をアンインストールします。

    詳細と使用例については、スクリプトのコメントをご覧ください。

  4. エージェントのパッケージ リポジトリを追加して、エージェントをインストールします。

    1. インストール可能なエージェントのバージョンを選択する方法については、すべてのエージェント バージョンを一覧表示するをご覧ください。

    2. 本番環境では、下位互換性のない変更を含む可能性のあるメジャー バージョンをインストールしないように、メジャー バージョンに固定することをおすすめします。メジャー バージョンに固定するには、次のコマンドを実行します。

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -Version MAJOR_VERSION.*.*"
      

      たとえば、エージェントの 1.x.x に固定するには、次のコマンドを実行します。

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -Version 1.*.*"
      
    3. 特定のバージョンのエージェントをインストールするには、次のコマンドを実行します。

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -Version version-number"
      

      次に例を示します。

      Invoke-Expression "${env:UserProfile}\add-google-cloud-ops-agent-repo.ps1 -AlsoInstall -Version 1.0.1"
      

正常に実行されたら、インストール スクリプトを削除します。

  • エージェントが期待どおりに動作していることを確認するには、次のコマンドを実行します。

    Get-Service google-cloud-ops-agent
    

    エージェントのステータスは Running である必要があります。

インストールに問題がある場合は、トラブルシューティング ページをご覧ください。

Google Cloud Console を使用したエージェントのインストール

エージェントは、Cloud Monitoring ダッシュボードの Compute Engine または Cloud Console のページから、個々の VM にインストールできます。

Cloud Monitoring

  1. Cloud Console で、Google Cloud プロジェクトを選択します。

    Cloud Console に移動

  2. ナビゲーション パネルで [Monitoring] を選択します。

  3. [モニタリング] のナビゲーション ペインで、[ダッシュボード] を選択します。

  4. ダッシュボードの表で [VM インスタンス] エントリを見つけて、名前をクリックします。

次のスクリーンショットに示すように、[VM インスタンス] ダッシュボードの [在庫] タブにすべての VM が表示され、エージェントのステータス列が含まれています。

Monitoring の [VM インスタンス] ダッシュボードにエージェントのステータスが表示されている。

[エージェント] 列には、次の値が報告されます。

  • 未検出: エージェントがインストールされていません。Cloud Monitoring が Compute Engine インスタンスにインストールされているエージェントを検出しない場合は、次の手順でエージェントをインストールできます。

    • エージェントをインストールする VM インスタンスを選択します。
    • [インスタンス] テーブルで [エージェントをインストール] オプションをクリックします。これにより、インストール ワークフローがダッシュボードに表示され、手順に沿って操作します。Ops エージェントは、インストールされるデフォルトのエージェントですが、インストール ワークフローには、従来のエージェントをインストールするためのリンクが記載されています。

      Ops エージェントはデフォルトで指標とログの両方を収集します。このデフォルト動作は、Ops エージェントを構成することで変更できます。

  • Ops エージェント: Ops エージェントを実行しています。

  • 従来のエージェント: 従来の Monitoring または Logging エージェントを実行しています。Ops エージェントへの移行については、従来のエージェントから Ops エージェントへの移行をご覧ください。

  • 該当なし: この VM は、エージェントの実行に対応していないプラットフォームです。

  • VM stop: VM が実行されていないため、エージェントのステータスは不明です。

Compute Engine

  1. Cloud Console の [VM インスタンス] ページに移動します。

    VM インスタンス

  2. エージェントをインストールする VM の名前をクリックします。[詳細] ページが開きます。

  3. [オブザーバビリティ] タブをクリックします。[オブザーバビリティ] ページが開きます。

  4. [Ops Agent のインストール] をクリックします。

  5. [Cloud Shell で実行] をクリックします。 Cloud Shell が開き、インストール コマンドを貼り付けます。

  6. キーボードの Enter キーを押してコマンドを実行します。

  7. [承認] をクリックして、Cloud Shell でエージェントをインストールできるようにします。Cloud Shell に次のような行が表示された場合、インストールは成功しています。

    Instance: projects/example-project/zones/us-west1-a/instances/example-vm successfully runs ops-agent
    

オプションのタスク

このセクションでは、一般的なメンテナンス タスクを行う方法について説明します。

HTTP プロキシを構成する

HTTP プロキシを使用して Logging API と Monitoring API にリクエストをプロキシする場合は、次の操作を行います。

Linux

  1. 次の構成ファイルを編集します(まだファイルが存在しない場合は作成します)。

     /etc/systemd/system.conf
    
  2. ファイルに以下を追加します。

     DefaultEnvironment="HTTP_PROXY=http://proxy-ip:proxy-port" "HTTPS_PROXY=http://proxy-ip:proxy-port" "NO_PROXY=http://metadata.google.internal"  # Skip proxy for the local Metadata Server.
    
  3. 環境変数を再読み込みします。

     sudo systemctl daemon-reload
    
  4. VM インスタンスで次のコマンドを実行して、エージェントを再起動します。

     sudo systemctl restart google-cloud-ops-agent.target
    

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 metadata.google.internal /m
    

エージェント バージョンの決定

システムで Logging エージェントのバージョンを確認するには、VM インスタンスで次のコマンドを実行します。

CentOS / RHEL

Red Hat または CentOS Linux 上で次のコマンドを実行します。

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' \
     google-cloud-ops-agent

Debian / Ubuntu

Debian または Ubuntu で次のコマンドを実行します。

dpkg-query --show --showformat \
    '${Package} ${Version} ${Architecture} ${Status}\n' \
     google-cloud-ops-agent

SLES / SUSE

SUSE で次のコマンドを実行します。

rpm --query --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\n' \
     google-cloud-ops-agent

Windows

Windows で次のコマンドを実行します。

googet installed google-cloud-ops-agent

エージェントの再起動

構成ファイルの変更を取得するには、Logging エージェントを再起動する必要があります。エージェントを再起動するには、次の手順を使用します。

Linux

インスタンスで次のコマンドを実行します。

 sudo service google-cloud-ops-agent restart

Windows

  1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。

  2. PowerShell アイコンを右クリックし、[管理者として実行] を選択して、管理者権限で PowerShell ターミナルを開きます。

  3. 次の PowerShell コマンドを実行します。

Restart-Service google-cloud-ops-agent -Force

エージェントをアップグレードする

Logging エージェントを最新リリースにアップグレードするには、次の手順を使用します。

Linux

エージェントを最新バージョンにアップグレードするには、次のコマンドを実行します。

sudo bash add-google-cloud-ops-agent-repo.sh --also-install

エージェントを特定のメジャー バージョンの最新のポイント リリースにアップグレードするには、次のコマンドを実行します。

sudo bash add-google-cloud-ops-agent-repo.sh --also-install \
  --version=MAJOR_VERSION.*.*

Windows

最新のエージェント リリースにアップグレードするには:

  1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。

  2. PowerShell アイコンを右クリックし、[管理者として実行] を選択して、管理者権限で PowerShell ターミナルを開きます。

    Copy-Item -Path "C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml" -Destination "C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.bak"
    
  3. 次の PowerShell コマンドを実行して、インストール済みのエージェントを削除し、インストール コマンドを実行します。

    googet -noconfirm remove google-cloud-ops-agent
    googet -noconfirm install google-cloud-ops-agent
    

すべてのエージェント バージョンを一覧表示する

エージェントで利用可能なバージョンを一覧表示するには、次のコマンドを実行します。

CentOS / RHEL

エージェントで使用可能なバージョンを一覧表示します。

sudo yum list --showduplicates google-cloud-ops-agent

Debian / Ubuntu

エージェントで使用可能なバージョンを一覧表示します。

sudo apt-cache madison google-cloud-ops-agent

SLES / SUSE

エージェントで使用可能なバージョンを一覧表示します。

sudo zypper search -s google-cloud-ops-agent

Windows

エージェントで使用可能なバージョンを一覧表示します。

googet available google-cloud-ops-agent

エージェントをアンインストールする

Logging エージェントとその構成ファイルを削除するには、次の手順を使用します。

エージェントをアンインストールした後、Google Cloud Console がこの変更を報告するまでに最大で 1 時間かかることがあります。

Linux

次のコマンドを実行します。

sudo bash add-google-cloud-ops-agent-repo.sh --uninstall

Windows

Ops エージェントをアンインストールする手順は次のとおりです。

  1. RDP または同様のツールを使用してインスタンスに接続し、Windows にログインします。

  2. PowerShell アイコンを右クリックし、[管理者として実行] を選択して、管理者権限で PowerShell ターミナルを開きます。

  3. 次の PowerShell コマンドを実行します。

    googet -noconfirm remove google-cloud-ops-agent
    

リモート パッケージ アクセスを使用しない VM

Logging エージェントのインストールには、エージェント パッケージと(Linux では)その依存関係の両方用に、リモートのパッケージ リポジトリへのアクセスが必要です。

VPC-SC またはプライベート ネットワークを使用している場合は、ネットワーク構成により上流リポジトリからエージェントの依存関係をインストールする機能に影響することがあります。エージェント パッケージ自体には、限定公開の Google アクセスを使用してアクセスできます。

VM ホストのセキュリティ ポリシーでリモートのパッケージ リポジトリへのアクセスを拒否している場合は、事前にインストールされたエージェントを使用してカスタム VM イメージを作成し、そのイメージ内でパッケージ管理を無効にすることをおすすめします。

次のステップ