Docker からのログとメトリクスの収集

ステップ 1: アクセス キーの作成

「アクセス キー」の手順に従って、Sumo アクセス ID とキーを作成します。次の手順で Docker ホストに Collector をセットアップするとき、アクセス ID とキーを指定する必要があります。 

ステップ 2: 各 Docker ホストへの Collector のインストール

Collector をインストールするホストのオペレーティング システムに対応する手順に従ってください。 

• Linux への Collector のインストール
• MacOS への Collector のインストール

ステップ 3: Docker ログ Source の設定

1. Sumo Web アプリケーションで、[Manage Data (データの管理)] > [Collection (コレクション)] > [Collection (コレクション)] を選択します。
2. Docker ホストにインストールされた Collector に移動して、[Add (追加)] > [Add Source (Source の追加)] を選択します。
3. [Docker Logs (Docker ログ)] を選択します。[Docker Logs (Docker ログ)] ページが開きます。
4. 以下の Source フィールドを設定します。
   1. Name (名前): (必須)。
   2. Description (説明): (省略可能)。
   3. URI。Docker デーモンの URI を入力します。
      • モニタリング対象の Docker コンテナと同じホストで Collector が動作する場合、非ネットワーク型 Unix ソケットとして以下を入力します。
        unix:///var/run/docker.sock
      • Docker ホスト以外のマシンで Collector が動作する場合は、Docker 環境変数から URI を指定できます。docker-machine コマンドを実行して Docker 環境変数を見つけます。
        $ docker-machine env machine-name
        
        例:

      • $ docker-machine env default
        export DOCKER_TLS_VERIFY="1"
        export DOCKER_HOST="tcp://192.168.99.100:2376"
        export DOCKER_CERT_PATH="/Users/sumo/.docker/machine/machines/default"
        export DOCKER_MACHINE_NAME="default"
        # Run this command to configure your shell: 
        # eval "$(docker-machine env default)"
        

        
        DOCKER_HOST 変数の値を取得し、"tcp" を "https" に変更して、その値を URI として入力します。例:
        https://192.168.99.100:2376
   4. Cert Path (証明書パス)。(リモート アクセスの場合のみ必須) Collector が動作するローカル マシンの証明書ファイルへのパスを入力します。上の例では、証明書パスは /Users/sumo/.docker/machine/machines/default です。
   5. [Collect From (収集元)] と [Container Filters (コンテナ フィルタ)]。すべてのコンテナから収集する場合は、[All Containers (すべてのコンテナ)] ラジオ ボタンをクリックします。コンテナを選択して収集する場合は、[Specified Container Filters (指定したコンテナ フィルタ)] ラジオ ボタンをクリックして、[Container Filters (コンテナ フィルタ)] フィールドにフィルタ表現を指定します。コンテナ フィルタを定義する方法の詳細については、後述の「コンテナ フィルタの定義の詳細」を参照してください。
      • デフォルトでは、最大 40 個のコンテナから収集できます。制限値を大きくするには、Collector サービスを停止し、collector.properties ファイル (Collector のインストール ディレクトリの config サブディレクトリ内) を編集して、docker.maxPerContainerConnections プロパティを追加します。サポートされる最大値は 100 です。この後、Collector サービスを起動します。この設定ファイルの変更方法の詳細については、「collector.properties」を参照してください。
   6. Source Host (Source ホスト): Source ホストのホスト名または IP アドレスを入力します。指定しないと、ホストは Docker が動作するマシンと見なされます。ホスト名は最大 128 文字です。
      必要に応じて、Docker 変数を使用して Source Host 値を作成できます。詳細については、「変数を使用した sourceCategory と sourceHost の設定」を参照してください。
   7. Source Category: (必須) Sumo Source Category (prod/web/docker/logs など) を入力します。[Source Category] メタデータ フィールドは、Source を整理してラベル付けするための基本的な構成要素です。詳細については、「メタデータの命名規則」と「ベスト プラクティス: 良い Source Category、悪い Source Category」を参照してください。
      必要に応じて、Docker 変数を使用して Source Category 値を作成できます。詳細については、「変数を使用した sourceCategory と sourceHost の設定」を参照してください。
5. 詳細オプションを設定します。
   1. Enable Timestamp Parsing (タイムスタンプ parse の有効化)。デフォルトでは、このオプションはオンになっています。
   2. Time Zone (タイム ゾーン): デフォルトは、[Use time zone from log file (ログ ファイルのタイム ゾーンを使用)] です。
   3. Timestamp Format (タイムスタンプ形式)。デフォルトは、[Automatically detect the format (形式を自動検出)] です。
   4. Encoding (エンコーディング): デフォルトは、「UTF-8」です。
   5. Enable Multiline Processing (複数行処理の有効化): 
      • Detect messages spanning multiple lines (複数行メッセージの検出)。デフォルトでは、このオプションはオンになっています。
      • Infer Boundaries (境界の推定): デフォルトでは、このオプションはオンになっています。
      • Boundary Regex (境界正規表現): 複数行処理が有効で、[Infer Boundaries (境界の推定)] が無効な場合は、メッセージ境界用の正規表現を入力します。
6. 処理ルールを設定します。詳細については、「処理ルール」を参照してください。

ステップ 4: Docker 統計情報 Source の追加

1. Sumo で [Manage Data (データの管理)] > [Collection (コレクション)] > [Collection (コレクション)] を選択します。
2. Docker ホストにインストールされた Collector に移動して、[Add (追加)] > [Add Source (Source の追加)] を選択します。
3. [Docker Stats (Docker 統計情報)] を選択し、[Content Type (コンテンツタイプ)] で [Logs (JSON) (ログ (JSON))] を選択して、JSON ログとしてデータを収集します。

4. 次の Source フィールドを設定します。
   1. Name (名前): (必須)
   2. Description (説明): (省略可能)
   3. URI。Docker デーモンの URI を入力します。
      • モニタリング対象の Docker コンテナと同じホストで Collector が動作する場合、非ネットワーク型 Unix ソケットとして以下を入力します。
        unix:///var/run/docker.sock
      • Docker ホスト以外のマシンで Collector が動作する場合は、Docker 環境変数から URI を指定できます。Docker 環境変数を見つけるには、docker-machine コマンドを実行します。このコマンドの構文は、$ docker-machine env machine-name です。
        例:
        
        $ docker-machine env default
export DOCKER_TLS_VERIFY="1"
export DOCKER_HOST="tcp://192.168.99.100:2376"
export DOCKER_CERT_PATH="/Users/sumo/.docker/machine/machines/default"
export DOCKER_MACHINE_NAME="default"
# Run this command to configure your shell: 
# eval "$(docker-machine env default)"

DOCKER_HOST 変数の値の「tcp」を「https」に変更し、その値を URI として入力します。たとえば、https://192.168.99.100:2376 のようになります。
   4. Cert Path (証明書パス)。(リモート アクセスの場合のみ必須) Collector が動作するローカル マシンの証明書ファイルへのパスを入力します。上の例では、証明書パスは /Users/sumo/.docker/machine/machines/default です。
   5. [Collect From (収集元)] と [Container Filters (コンテナ フィルタ)]。すべてのコンテナから収集する場合は、[All Containers (すべてのコンテナ)] ラジオ ボタンをクリックします。コンテナを選択して収集する場合は、[Specified Container Filters (指定したコンテナ フィルタ)] ラジオ ボタンをクリックして、[Container Filters (コンテナ フィルタ)] フィールドにフィルタ表現を指定します。コンテナ フィルタを定義する方法の詳細については、後述の「コンテナ フィルタの定義の詳細」を参照してください。
      • デフォルトでは、最大 40 個のコンテナから収集できます。制限値を大きくするには、Collector サービスを停止し、collector.properties ファイル (Collector のインストール ディレクトリの config サブディレクトリ内) を編集して、docker.maxPerContainerConnections プロパティを追加します。サポートされる最大値は 100 です。この後、Collector サービスを起動します。この設定ファイルの変更方法の詳細については、「collector.properties」を参照してください。
   6. Source Host (Source ホスト): Source ホストのホスト名または IP アドレスを入力します。指定しないと、ホストは Docker が動作するマシンと見なされます。ホスト名は最大 128 文字です。必要に応じて、Docker 変数を使用して Source Host 値を作成できます。詳細については、「変数を使用した sourceCategory と sourceHost の設定」を参照してください。
   7. Source Category: (必須) Sumo Source Category (prod/web/docker/logs など) を入力します。必要に応じて、Docker 変数を使用して Source Host 値を作成できます。詳細については、「変数を使用した sourceCategory と sourceHost の設定」を参照してください。
   8. Scan Interval (スキャン間隔): このオプションでは、Source のスキャン頻度を設定します。間隔を短くすると、メッセージの量が増えて、ご使用の環境で追加の料金が発生する場合があります。最小許容スキャン間隔は、1 秒です。

ステップ 5: Docker 用 Sumo アプリケーションのインストール

Docker 用 Sumo アプリケーションでは、Docker コンテナの運用状況を把握できます。このアプリケーションのダッシュボードを使用すると、CPU、メモリ、およびネットワークに関するコンテナのパフォーマンスの統計を表示できます。また、コンテナのイベント、たとえば、開始や停止などの重要なコマンドも表示できます。  

インストールの手順については、「Docker アプリケーションのインストール」を参照してください。

ステップ 6:  検索の実行とダッシュボードの使用

この時点で、Sumo は Docker データを受信中です。Docker から収集されるログの例については、「Docker メッセージのサンプル」を参照してください。クエリの例については、「クエリのサンプル」の「作成または開始されたコンテナ」を参照してください。  

Docker 用 Sumo アプリケーションによって提供されるダッシュボードについては、「Docker アプリケーション ダッシュボード」を参照してください。