Logstash および Bluemix のログ・コレクター

Liberty は実行時に、ログ・イベント、トレース・イベント、初期障害データ・キャプチャー機能 (ffdc) イベント、 アクセス・ログ・イベント、およびガーベッジ・コレクション・イベントなど、さまざまなイベントを生成します。 特に、多くのサーバーを管理しているときや複数のサーバーが異なるプラットフォームで稼働しているとき (専用ハードウェアとクラウドなど)、 すべてのサーバーのイベントを統合して、イベントを検索、フィルタリング、分析できるようにすると便利です。 また、問題判別データ用のパーシスタント・ファイル・ストレージがない環境で Liberty を使用する場合に、別のサーバーにイベントを保管すると便利であることがあります。

Liberty では現在、リモートでイベントを統合するのに役立つ Logstash および Bluemix のログ・コレクター・フィーチャーが提供されています。これらのコレクターは、発生しているイベントを収集し、フィールドに分割し、構成済みの Logstash または Bluemix のログ・コレクション・サーバーにイベントを安全に転送します。コレクターは、以下の 1 つ以上のタイプのデータを送信するように構成することができます。
  • メッセージ・ログ・イベント
  • トレース・ログ・イベント
  • HTTP アクセス・ログ・イベント (Liberty サーバーから)
  • FFDC ログ・イベント
  • ガーベッジ・コレクション・イベント (IBM JDK の場合のみ使用可能)

Logstash コレクター

Logstash コレクター・フィーチャー (logstashCollector-1.0 または logstashCollector-1.1) は、ユーザーが提供する Logstash サーバーにイベントを送信します。

Logstash を Elasticsearch 検索サーバーおよび Kibana ダッシュボード (これらはすべて、ユーザーが提供、セットアップ、管理します) と一緒に使用して、エンタープライズ全体のログやその他のイベントの統合ビューを示すことができます。 Logstash コレクターを使用してイベントを転送する場合に、Liberty サーバー・マシンでセットアップする必要がある別のプロセスやエージェントはありません。

図 1. Logstash コレクター
この図は、logstash イベント・パイプラインを通る Elasticsearch サーバーへのイベントの流れを示しています。

イベント構造体

コレクターは、フィールド名と値のペアのセットとして各イベントを送信します。 異なるタイプのイベントにはそれぞれ、固有のフィールド・セットがあります。 独自の Kibana ダッシュボードを作成する際には、各イベントに含まれるフィールドを知っていると便利です。
注: logstashCollector-1.0 フィーチャーには、logstashCollector-1.1 フィーチャーおよび bluemixLogCollector-1.1 フィーチャーとは別のフィールド名があります。
以下は共通のフィールドで、すべてのイベントに存在します。
表 1. 共通イベント・タイプ
logstashCollector-1.0 フィールド名 logstashCollector-1.1 / bluemixLogCollector-1.1 フィールド名 フィールドの説明
type type イベント・タイプを識別するストリング
datetime was_datetime イベントが発生した時刻
hostName host イベントのソースであるサーバーのホスト名

ホスト名の設定ルールについて詳しくは、Docker で実行中の Liberty での Logstash および Bluemix ログ・コレクターの使用を参照してください。

wlpUserDir was_userDir イベントのソースであるサーバーのユーザー・ディレクトリー。例えば、D:¥wlp¥usr など。
serverName was_serverName イベントのソースであるサーバーのサーバー名

サーバー名の設定ルールについて詳しくは、Docker で実行中の Liberty での Logstash および Bluemix ログ・コレクターの使用を参照してください。

sequence was_sequence イベントの順序番号 (同じタイム・スタンプのレコードをソートする場合に便利です)
共通フィールドのほかに、各イベント・タイプに固有のフィールドもあります。
  • メッセージ・イベント
    表 2. メッセージ・イベント (タイプ: 「liberty_message」:)
    logstashCollector-1.0 フィールド名 logstashCollector-1.1 / bluemixLogCollector-1.1 フィールド名 フィールドの説明
    severity   重大度標識 (F = 致命的、E = エラー、W = 警告、A = 監査、I = 通知、O = システム出力、R = システム・エラー)
      loglevel

    重大度標識 (FATAL、ERROR、WARNING、AUDIT、INFO、CONFIG、DETAIL)

    messageId was_messageId ログ行内のメッセージ ID。これを使用して、特定タイプのエラーを検索することができます (SRVE0250I など)
    methodName was_methodName ログ・レコードのメソッド名
    className was_className ログ・レコードのクラス名
    loggerName モジュール (module) ログ・レコードのロガー名
    threadId was_threadId ログ行内のスレッド ID (00000015 など)。スレッド ID は、数値ではなく、ストリングです。
    message message ログ・レコードのメッセージ。メッセージ ID で始まります。
  • トレース・イベント
    表 3. トレース・イベント (タイプ: 「liberty_trace」:)
    logstashCollector-1.0 フィールド名 logstashCollector-1.1 / bluemixLogCollector-1.1 フィールド名 フィールドの説明
    severity   重大度標識 (1 = 良い、2 = より良い、3 = 最も良い、> = 入り口、< = 出口)
      loglevel 重大度標識 (FINE、FINER、FINEST、ENTRY、EXIT)
    methodName was_methodName ログ・レコードのメソッド名
    className was_className ログ・レコードのクラス名
    loggerName モジュール (module) ログ・レコードのロガー名
    threadId was_threadId ログ行内のスレッド ID (00000015 など)。スレッド ID は、数値ではなく、ストリングです。
    message message ログ・レコードのメッセージ
  • HTTP アクセス・ログ・イベント
    表 4. HTTP アクセス・ログ・イベント (タイプ: 「liberty_accesslog」:)
    logstashCollector-1.0 フィールド名 logstashCollector-1.1 / bluemixLogCollector-1.1 フィールド名 フィールドの説明
    uriPath was_uriPath 要求された URL のパス情報。 これには、照会パラメーター (/pushworksserver/ push/apps/tags など) は含まれません
    requestMethod was_requestMethod 使用される HTTP verb (GET など)
    remoteHost was_remoteHost リモート・ホスト IP アドレス (127.0.0.1 など)
    userAgent was_userAgent 要求の userAgent 値
    requestProtocol was_requestProtocol プロトコル・タイプ (HTTP/1.1 など)
    queryString was_queryString

    HTTP 要求の照会ストリングを表すストリング (color=blue&size=large など)

    bytesReceived was_bytesReceived URL で受信したバイト数 (94 など)
    responseCode was_responseCode HTTP 応答コード (200 など)
    elapsedTime was_elapsedTime 要求の処理にかかった時間 (ミリ秒)。
    requestHost was_requestHost 要求ホスト IP アドレス (127.0.0.1 など)
    requestPort was_requestPort 要求のポート番号
  • FFDC イベント
    表 5. FFDC イベント (タイプ: 「liberty_ffdc」:)
    logstashCollector-1.0 フィールド名 logstashCollector-1.1 / bluemixLogCollector-1.1 フィールド名 フィールドの説明
    className was_className FFDC エントリーを出力したクラス
    exceptionName was_exceptionName FFDC エントリーで報告された例外
    probeID was_probeID クラス内の FFDC ポイントの固有 ID
    stackTrace was_stackTrace FFDC インシデントのスタック・トレース
    objectDetails was_objectDetails FFDC インシデントのインシデント詳細
    threadId was_threadId FFDC インシデントのスレッド ID
  • ガーベッジ・コレクション・イベント
    表 6. ガーベッジ・コレクション・イベント (タイプ: 「liberty_gc」:)
    logstashCollector-1.0 フィールド名 logstashCollector-1.1 / bluemixLogCollector-1.1 フィールド名 フィールドの説明
    heap was_heap 使用可能ヒープの合計
    usedHeap was_usedHeap 使用済みヒープの量
    duration was_duration ガーベッジ・コレクション実行時の所要時間 (マイクロ秒)
    gcType was_gcType ガーベッジ・コレクション・イベントのタイプ (Nursery、Global など)
    reason was_reason ガーベッジ・コレクションの理由

Docker で実行中の Liberty での Logstash および Bluemix ログ・コレクターの使用

Liberty サーバーを Docker コンテナーまたは他の仮想化環境で実行する場合、host/hostName および serverName/was_serverName は以下のように設定されます。

host/hostName フィールドは、以下の値のうち、最初に使用可能になる値に設定されます。
  • CONTAINER_HOST 環境変数の値
  • ${defaultHostName} Liberty 構成変数の値
  • JDK で報告される正規ホスト名
serverName/was_serverName は、以下の値のうち、最初に使用可能になる値に設定されます。
  • CONTAINER_NAME 環境変数の値
  • ${wlp.server.name} Liberty 構成変数の値

Liberty サーバーを Bluemix コンテナー・サービスで実行する場合、CONTAINER_HOST および CONTAINER_NAME は既に設定されています。

Liberty サーバーを Liberty Docker 集合で使用する場合、CONTAINER_HOST および CONTAINER_NAME は既に設定されています。

Liberty サーバーを Docker コンテナー (またはお客様が管理する他の仮想環境) で実行する場合は、イメージの実行時に、CONTAINER_HOST 環境変数および CONTAINER_NAME 環境変数を設定してください。そうすることによって、Logstash コレクターまたは Bluemix ログ・コレクターが、送信レコードを適切なホストおよびコンテナー名に確実にタグ付けするので、問題判別時に役立ちます。これらの環境変数を設定しなかった場合は、複数のコンテナーからのイベントを表示するダッシュボードを使用する際に、どのコンテナーがどのイベントを送信したのかを判別しにくくなる場合があります。Docker コンテナーの開始時に、以下のようなコマンドを使用します。
docker run -d -e LICENSE=accept -e CONTAINER_NAME=yourContainerName -e CONTAINER_HOST=yourContainerHost --name=yourContainerName yourImageName

トピックのタイプを示すアイコン 概念トピック



タイム・スタンプ・アイコン 最終更新: Friday, 16 September 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-dist&topic=cwlp_analytics_collectors
ファイル名: cwlp_analytics_collectors.html