ログストリーミング: Kafka

1. リモートログストリーミングの設定に関するガイドをご確認ください。
2. Apache Kafka エリアで、Create endpoint をクリックします。
3. Create an Apache Kafka endpoint フィールドに次のように入力します。
   • Name フィールドに分かりやすいエンドポイントの名前を入力します。
   • Placement セクションでは、生成される VCL にログコールが配置される場所を選択します。有効な値は Format Version Default、waf_debug (waf_debug_log)、None です。詳細については、ログ配置の変更に関するガイドをご覧ください。
   • Log format フィールドには、ログ形式に使用する Apache 形式の文字列や VCL 変数を任意で入力します。詳細については、形式例のセクションをご覧ください。
   • Brokers フィールドには、1つ以上のサーバー (Kafka ブローカー) のホスト名または IP アドレスを入力します。デフォルトでは、ポート9092を使用します。デフォルトのポートと異なる場合、ホスト名に形式 :[port] (例: :9093) を使用してポートを追加してください。複数のサーバーをコンマ区切りの文字列を使用して指定することができます。
   • Topic フィールドには、ログを送信するトピック名を入力します。
   • (オプション) Maximum bytes フィールドには、Kafka の生成リクエストメッセージの最大サイズをバイト単位で入力します。
   • (オプション) Parse key-values コントロールから、Kafka レコードヘッダへログ形式内のキーと値のペアを解析するかどうかを選択します。キーと値のペアは、フォーマットされたログ行を key=val として導き、コンマ区切りでなければなりません。キーも値も二重引用符から始めることはできません。キーはの先頭には任意の数のスペースを置くことができますが、スペースを含めることはできず、少なくとも1文字が必要となります。値は、key= 内で空にすることができます。ログ行にキーと値のペア __record_key を含めて、パーティションするレコードキーを指定します。ログは、Kafka の統一したスティッキーパーティション戦略に従ってパーティション化されます。指定されたレコードキーがない場合、Fastly の Kafka クライアントは、トピックの利用可能なパーティションにログメッセージを均一に配信します。
   • (オプション) Write acknowledgement エリアでは、リーダーの Kafka ブローカーが生成リクエストを正常に受信する必要がある適切な書き込み確認を選択します。Fastly の Kafka クライアントは、指数バックオフとジッタで失敗した生成リクエストの限定的再配信を試み、thundering herd シナリオを低減します。
   • (オプション) Compression codec エリアには、ログの圧縮に使用する適切なコーデックを選択します。
   • (オプション) Use SASL コントロールから、SASL 認証を有効にするかどうかを選択します。SASL 認証は、TLS の暗号化と同時に有効にすることができます。Yes を選択すると、追加の SASL 認証フィールドが表示されます。
   • SASL authentication mechanism メニューから、SASL クライアント認証のユーザー名とパスワードの認証に使用する適切なチャレンジレスポンスを選択します。
   • User フィールドに、SASL クライアント認証ユーザー名を入力します。
   • Password フィールドに、SASL クライアント認証パスワードを入力します。
   • (オプション) Use TLS コントロールから、Kafka エンドポイントで TLS 暗号化を有効にするかどうかを選択します。TLS 暗号化は、SASL 認証と同時に有効にすることができます。Yes を選択すると、追加の TLS フィールドが表示されます。
   • TLS hostname フィールドに、ログの送信先サーバーの証明書を検証するためのホスト名を任意で入力します。これは、証明書のサブジェクト代替名 (SAN) フィールドの1つと同じである必要があります。コモンネーム (CN) はサポートされていません。 ホスト名が指定されない場合、Brokers フィールドにある最初のブローカーのホスト名が使用されます。このフィールドは、Use TLS メニューから Yes を選択した場合にのみ表示されます。
   • (オプション) TLS CA certificate フィールドには、Kafka ブローカーの証明書が有効であることを確認するために使用する認証機関 (CA) の証明書をコピー＆ペーストしてください。アップロードする証明書は PEM 形式である必要があります。周知の認証機関によって署名されてない場合には、証明書のアップロードを熟慮してください。TLS 証明書が周知の機関によって署名されていれば、必要ありません。このフィールドは、Use TLS メニューから Yes を選択した場合にのみ表示されます。
   • (オプション) TLS client certificate フィールドには、Kafka ブローカーへの認証に使用する TLS クライアント証明書をコピー＆ペーストしてください。アップロードする TLS クライアント証明書は PEM 形式で、なおかつクライアントキーを添付する必要があります。TLS クライアント証明書により、Fastly が接続を実行していることを Kafka サーバーが認証できるようになります。このフィールドは、Use TLS メニューから Yes を選択した場合にのみ表示されます。
   • (オプション) TLS client key フィールドには、Kafka ブローカーへの認証に使用する TLS クライアントキーをコピー＆ペーストしてください。アップロードする TLS クライアントキーは、PEM 形式で、TLS クライアント証明書を添付する必要があります。TLS クライアントキーにより、Fastly が接続を実行していることを Kafka ブローカーが認証できるようになります。このフィールドは、Use TLS メニューから Yes を選択した場合にのみ表示されます。
4. Create をクリックして新規のログエンドポイントを作成します。
5. Activate をクリックして設定への変更をデプロイします。

フォーマットの例

以下に示すのは、Apache Kafka にデータを送信する書式指定文字列の例です。書式指定文字列の詳細については、こちらをご覧ください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{
  "timestamp": "%{strftime(\{"%Y-%m-%dT%H:%M:%S%z"\}, time.start)}V",
  "client_ip": "%{req.http.Fastly-Client-IP}V",
  "geo_country": "%{client.geo.country_name}V",
  "geo_city": "%{client.geo.city}V",
  "host": "%{if(req.http.Fastly-Orig-Host, req.http.Fastly-Orig-Host, req.http.Host)}V",
  "url": "%{json.escape(req.url)}V",
  "request_method": "%{json.escape(req.method)}V",
  "request_protocol": "%{json.escape(req.proto)}V",
  "request_referer": "%{json.escape(req.http.referer)}V",
  "request_user_agent": "%{json.escape(req.http.User-Agent)}V",
  "response_state": "%{json.escape(fastly_info.state)}V",
  "response_status": %{resp.status}V,
  "response_reason": %{if(resp.response, "%22"+json.escape(resp.response)+"%22", "null")}V,
  "response_body_size": %{resp.body_bytes_written}V,
  "fastly_server": "%{json.escape(server.identity)}V",
  "fastly_is_edge": %{if(fastly.ff.visits_this_service == 0, "true", "false")}V
}