Ops エージェントを使用して Apache からログを収集する

Ops エージェントを使用して、Compute Engine 仮想マシン(VM)インスタンスにインストールされた Apache ウェブサーバーから収集された syslog ログを収集して表示する方法について説明します。このクイックスタートの手順と同様のプロセスを使用して、他のサードパーティ アプリケーションをモニタリングできます。

このクイックスタートでは、以下のことを行います。

  1. Compute Engine VM インスタンスを作成し、Ops エージェントをインストールします。
  2. Apache ウェブサーバーをインストールします。
  3. Apache ウェブサーバーの Ops エージェントを構成します。
  4. ログ エクスプローラでログを表示します。
  5. ログベースのアラートを作成します。
  6. アラートをテストします。
  7. クリーンアップします。

このタスクを Google Cloud コンソールで直接行う際の順を追ったガイダンスについては、「ガイドを表示」をクリックしてください。

ガイドを表示


始める前に

  1. 組織で定義されているセキュリティの制約により、次の手順を完了できない場合があります。トラブルシューティング情報については、制約のある Google Cloud 環境でアプリケーションを開発するをご覧ください。

  2. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
  3. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  4. Google Cloud プロジェクトで課金が有効になっていることを確認します

  5. Compute Engine, Cloud Monitoring, and Cloud Logging API を有効にします。

    API を有効にする

  6. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  7. Google Cloud プロジェクトで課金が有効になっていることを確認します

  8. Compute Engine, Cloud Monitoring, and Cloud Logging API を有効にします。

    API を有効にする

VM インスタンスを作成する

  1. Google Cloud コンソールのナビゲーション パネルで、[Compute Engine] を選択してから、[VM インスタンス] を選択します。

    [VM インスタンス] に移動

  2. [インスタンスを作成] をクリックして、VM を作成します。

  3. [名前] フィールドにわかりやすい名前を入力します。
  4. [マシンタイプ] フィールドで [e2-small] を選択します。
  5. [ブートディスク] セクションで、[Debian GNU/Linux] をデフォルト設定のままにします。
  6. [ファイアウォール] セクションで、[HTTP トラフィックを許可する] と [HTTPS トラフィックを許可する] の両方を選択します。
  7. [オブザーバビリティ - Ops エージェント] セクションで、[Monitoring と Logging 用の Ops エージェントをインストールする] を選択します。
  8. [作成] をクリックします。

Apache ウェブサーバーをインストールする

Apache ウェブサーバーを Compute Engine VM インスタンスにインストールする手順は次のとおりです。

  1. [VM インスタンス] ページで、新しい VM を見つけて [接続] 列に移動し、[SSH] をクリックします。

    接続できない場合は、SSH のトラブルシューティングをご覧ください。

  2. パッケージ リストを更新するには、次のコマンドをクリップボードにコピーし、SSH ターミナルにコマンドを貼り付け、Enter キーを押します。

    sudo apt-get update
    
  3. SSH ターミナルで、「パッケージ リストを読み取っています...完了」のメッセージを確認した後、次のコマンドを実行して、Apache2 ウェブサーバーをインストールします。

    sudo apt-get install apache2 php7.0
    

    インストールを続行するように求められたら、Y と入力します。インストールのコマンドが失敗した場合、sudo apt-get install apache2 php を使用します。

  4. コマンド プロンプトが返されたら、[VM インスタンス] ページに移動し、VM の外部 IP アドレスを次の URL にコピーします。

    http://EXTERNAL_IP
    
  5. Apache ウェブサーバーに接続するには、新しいブラウザタブを開き、前のステップの URL を入力します。

    ウェブサーバーが正常にインストールされると、ブラウザタブに Apache2 Debian のデフォルト ページが表示されます。

    Apache2 のデフォルト ページを表示。

Apache ウェブサーバーのログと指標を収集する

これらの手順では、Apache ウェブサーバーからログと指標を収集するように Ops エージェントを構成します。
  1. VM インスタンスの SSH ターミナルに移動します。 ターミナルを開いていない場合は、次のようにします。

    1. Google Cloud コンソールのナビゲーション パネルで、[Compute Engine] を選択してから、[VM インスタンス] を選択します。

      [VM インスタンス] に移動

    2. 新しい VM を見つけて、[SSH] をクリックします。

  2. 次のコマンドをコピーして、インスタンスのターミナルに貼り付け、Enter キーを押します。

    # Configures Ops Agent to collect telemetry from the app and restart Ops Agent.
    
    set -e
    
    # Create a back up of the existing file so existing configurations are not lost.
    sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak
    
    # Configure the Ops Agent.
    sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
    metrics:
      receivers:
        apache:
          type: apache
      service:
        pipelines:
          apache:
            receivers:
              - apache
    logging:
      receivers:
        apache_access:
          type: apache_access
        apache_error:
          type: apache_error
      service:
        pipelines:
          apache:
            receivers:
              - apache_access
              - apache_error
    EOF
    
    sudo service google-cloud-ops-agent restart
    sleep 60
    

    上記のコマンドにより、Apache ウェブサーバーからログと指標を収集して取り込むための構成が作成されます。詳細については、Apache ウェブサーバーの Ops エージェントを構成するをご覧ください。

  3. コマンド プロンプトが表示されるまで待ちます。これは少なくとも 60 秒かかります。

Apache ウェブサーバーのログを表示する

Google Cloud コンソールでログを表示するには、ログ エクスプローラを使用します。

  1. Google Cloud コンソールのナビゲーション パネルで、[ロギング] を選択してから、[ログ エクスプローラ] を選択します。

    [ログ エクスプローラ] に移動

    最新のログが [クエリ結果] ペインに表示されます。

  2. ツールバーで [クエリを表示] が有効になっていることを確認します。

  3. Apache ウェブサーバーのログを表示するには、次のクエリを作成して実行します。

    1. Google Cloud プロジェクト セレクタから Google Cloud プロジェクトのリストを展開し、Google Cloud プロジェクト ID をクリップボードにコピーします。

    2. 次の式で、コピーした ID を PROJECT_ID に貼り付け、クエリエディタにコピーします。

      resource.type="gce_instance"
      logName=("projects/PROJECT_ID/logs/apache_access" OR "projects/PROJECT_ID/logs/apache_error")
      

      前のクエリが実行されると、apache_access ログエントリと apache_error ログエントリのみが表示されます。

    3. [クエリを実行] をクリックします。

      クエリの結果が [クエリ結果] ペインに表示されます。

Apache ウェブサーバーからログと指標を収集するように Ops エージェントを構成し、それらのログを表示しました。次のステップでは、ログに特定のパターンが発生したときに通知するアラート ポリシーを作成します。

メール通知チャンネルを作成する

アラート ポリシーを作成する前に、アラート ポリシーで使用する通知チャンネルを構成します。Cloud Monitoring は、メール、Slack、PagerDuty、Pub/Sub など、多くの異なる種類の通知チャンネルをサポートしています。詳細については、通知チャンネルを作成して管理するをご覧ください。 メールで通知されるには、次のようにします。
  1. Google Cloud コンソールのナビゲーション パネルで、[Monitoring] を選択してから、 [アラート] を選択します。

    [アラート] に移動

  2. ツールバーで [通知チャンネルの編集] をクリックします。
  3. [通知チャンネル] ページで [メール] までスクロールし、[新しく追加] をクリックします。
  4. メールアドレス(表示名 My email など)を入力して、[保存] をクリックします。

ログベースのアラートの作成

特定のメッセージがログエントリに表示されたときに通知を受け取るには、ログベースのアラートを作成します。このセクションでは、ログエントリに 404 Not Found メッセージが表示されたときに通知されるように、ログベースのアラートを作成します。

  1. Google Cloud コンソールのナビゲーション パネルで、[ロギング] を選択してから、[ログ エクスプローラ] を選択します。

    [ログ エクスプローラ] に移動

  2. [クエリ結果] ツールバーで、 [アラートを作成] をクリックします。ログベースのアラート ポリシー ペインが開きます。

  3. [アラートの詳細] で、[アラート ポリシー名] フィールドに「404 Not Found」と入力します。

  4. [このアラートに含めるログを選択] で、次の操作を行います。

    1. ログフィルタのテキスト ボックスにあるコンテンツをすべて削除します。
    2. 次のクエリをコピーして、ログフィルタ テキスト ボックスに貼り付けます。

      severity>=DEFAULT /help httpRequest.status=404
      

      以前のログフィルタでは、severity のレベルが DEFAULT 以上で、テキスト /help が含まれ、404httpRequest ステータスが含まれるログエントリが検索されます。

  5. [通知頻度と自動クローズ期間の設定] セクションで、次のようにします。

    1. [通知の間隔] フィールドを [5 分] に設定します。
    2. [インシデントの自動クローズ期間] フィールドを [30 分] に設定します。
  6. [通知対象] で [通知チャンネル] メニューからメールを選択し、[保存] をクリックします。

アラート ポリシーをテストする

アラート ポリシーをテストするには、次の手順を行います。

  1. VM インスタンスの SSH ターミナルに移動します。 ターミナルを開いていない場合は、次のようにします。

    1. Google Cloud コンソールのナビゲーション パネルで、[Compute Engine] を選択してから、[VM インスタンス] を選択します。

      [VM インスタンス] に移動

    2. 新しい VM を見つけて、[SSH] をクリックします。
  2. サーバーで架空のページ localhost/help を検索するには、次のコマンドを実行します。

    curl localhost/help
    

    ターミナルに 404 Not Found メッセージが表示されると、メール通知が送信されます。このプロセスが完了するまで数分かかります。

    受信するメール通知は、次の例のようになります。

    ログベースのアラートの例はメール通知になります。

  3. 新しいログエントリを表示するには、次のようにします。

    1. Google Cloud コンソールのナビゲーション パネルで、[ロギング] を選択してから、[ログ エクスプローラ] を選択します。

      [ログ エクスプローラ] に移動

    2. ツールバーで [現在の位置に移動] をクリックします。

Apache ウェブサーバーからログと指標を収集するように Ops エージェントを構成しましたが、ログを表示したのみです。Apache ウェブサーバーの指標を表示する方法については、Ops エージェントを使用した Apache ウェブサーバーの指標の収集: トラフィックの生成をご覧ください。

クリーンアップ

このページで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、次の手順を行います。

新しいプロジェクトを作成し、プロジェクトがもう必要でなくなった場合は、プロジェクトを削除します。

既存のプロジェクトを使用した場合は、次のようにします。

  1. VM を作成した場合は、それを削除します。

    1. Google Cloud コンソールで、[VM インスタンス] ページに移動します。

      [VM インスタンス] に移動

    2. 削除するインスタンスのチェックボックスを選択します。
    3. インスタンスを削除するには、 [その他の操作] をクリックし、[削除] をクリックしてから、指示に沿って操作します。
  2. 作成したアラート ポリシーを削除します。

    1. Google Cloud コンソールのナビゲーション パネルで、[Monitoring] を選択してから、 [アラート] を選択します。

      [アラート] に移動

    2. 作成したアラート ポリシーを選択して、[削除] をクリックします。

次のステップ