カスタムログ形式

Fastly のカスタムログ形式は2つのバージョンがあります。新規のログエンドポイントはデフォルトでバージョン2のログ形式となります。バージョン1のログエンドポイントをバージョン2のログ形式にアップグレードすることができます。また、継続性を考慮してバージョン1形式に見えるバージョン2の作成を行うことも可能です。下記のバージョン2のログ形式の主な利点についても説明しています。

バージョン2のログ形式

この表は Fastly のバージョン2のログ形式についての詳細を記載しています。表に示すように、すべての変数の先頭にパーセント記号（ % ）を付ける必要があります。

バージョン1のログ形式

この表は Fastly のバージョン1のログ形式についての詳細を記載しています。表に示すように、すべての変数の先頭にパーセント記号（%）を付ける必要があります。

バージョン2のログ形式へのアップグレード

ログエンドポイントをバージョン2ログ形式にアップグレードするには、次の手順に従ってください。

1. Fastly コントロールパネルにログインし。
2. All services ページから適切なサービスを選択します。検索ボックスを使用すると、ID、名称、ドメインでの検索が行えます。
3. Edit configuration ボタンをクリックし、オプションを選択してアクティブバージョンをクローンします。設定画面が開きます。

4. Logging リンクをクリックします。Logging endpoints 設定画面を開きます。バージョン1のログ形式を使用するログエンドポイントがある場合は、それらが更新可能であることを示すメッセージが表示されます。

   

5. ログエンドポイントの名前をクリックして編集します。Edit this endpoint ページが表示されます。

   

6. Convert to Log Format Version 2 ボタンをクリックします。Convert to log format version 2 ページが表示されます。

   

7. 出力形式を選択する：
   • Use compatible output を使用することを推奨します。この設定では、タイムスタンプの文字列は変更されませんが、ログの書式は変更されます。新しい形式は Apache のログ形式と互換性があります。
   • Maintain legacy output はバージョン2形式ですが、生成されるログ文字列は同じになります。これは、%t が %{now}V に、%r が %{req.url}V に、%b は ％{resp.http.Content-Lenght}V となることを意味します。
8. Select ボタンをクリックします。Edit this endpoint ページが表示されます。
9. Update ボタンをクリックして、 該当ログエンドポイントをバージョン2ログ形式にアップグレードします。
10. Activate ボタンをクリックしてサービスをデプロイします。

APIでアップグレードする

Fastly API を使用してログエンドポイントをアップグレードするには、アップグレードが必要なサービスのアクティブなバージョンをクローンしたバージョンか、ロックされていない非アクティブバージョンに対して、次のコマンドを実行します：

1
curl -X PUT -H 'Fastly-Key: FASTLY_API_TOKEN' -H 'Content-Type: application/json' 'https://api.fastly.com/service/<your Fastly service ID>/version/<version number>/logging/<log type>/<log name>' --data-binary '{"format_version":"2"}'

ここで log type はアップグレードするエンドポイントのタイプです：

• cloudfiles
• ftp
• heroku
• logentries
• loggly
• logshuttle
• openstack
• papertrail
• s3
• scalyr
• sumologic
• syslog

format_version フィールドはオブジェクトごとのフィールドであることに注意してください。ある1つのログオブジェクトで変更しても、他のオブジェクトには影響ありません。たとえば、Google Cloud Storage エンドポイントをアップグレードするには、エンドポイントの名前が「GCS Test」の場合、cURLコマンドは次のようになります。

1
curl -X PUT -H 'Fastly-Key: FASTLY_API_TOKEN' -H 'Content-Type: application/json' 'https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs/GCS%20Test' --data-binary '{"format_version":"2"}'

ログバージョンの判別

サービスが現在使用しているログバージョンを判別するには、次の cURL コマンドを実行します。

1
curl -X GET -H 'Fastly-Key: FASTLY_API_TOKEN'  'https://api.fastly.com/service/<your Fastly service ID>/version/<version number>/logging/<log type>/<log name>'

log type は ftp、 heroku、logentries、 loggly、 logshuttle、 papertrail、 s3、 scalyr、 sumologic、 syslogです。cURL コマンドによって、該当バージョンの設定内容の詳細が JSON 形式で出力されます。例えば：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "address": "logs.papertrailapp.com",
    "created_at": "2016-04-01T15:37:30+00:00",
    "deleted_at": null,
    "format": "time.start.msec time.to_first_byte time.elapsed req.body_bytes_read req.bytes_read resp.http.content-length server.region client.ip %>s \"req.method req.url req.proto\" \"req.http.referer\" \"req.http.user-agent\"",
    "format_version": "2",
    "hostname": "logs.papertrailapp.com",
    "name": "fastly",
    "port": "11111",
    "public_key": null,
    "response_condition": "LOG /",
    "service_id": "1a2b3c4d5e6f7g8h9j0k",
    "updated_at": "2016-04-01T19:47:47+00:00",
    "version": "123"
}

format_version フィールドは、使用されているログ形式に応じて 1または 2のいずれかが表示されます。

バージョン2ログ形式の利点

バージョン2ログ形式を使用する主な利点は、次のとおりです。

• ログは vcl_deliver ではなく vcl_log で生成され、vcl_log はオブジェクトがブラウザに渡された後に実行されるので、さまざまなサイズ変数を正確に設定することができます。
• %t ディレクティブは Apache ログ形式と互換性があります。バージョン1では、非標準の時刻形式を使用していました。
• %r "first line of request" ディレクティブは、Apache ログ形式と互換性があります。バージョン1では、プロトコルを残していました。
• HTTP ヘッダーを除いたレスポンスサイズを表す ％b ディレクティブを使用することにより、より正確な情報が取得できます。バージョン1では、オリジンサーバから送られる Content-Length を使用しましたが、これは不正確な場合があります（特に ESI を利用している場合）。
• 意味あるすべての Apache ログディレクティブを追加しました。バージョン1では、より小さなサブセットを使用していました。

バージョン2のログをバージョン1のように表示する

バージョン1のデフォルトのログ形式は次のとおりです。

%h %l %u %t %r %>s

バージョン2のほとんどのディレクティブとはまったく同じです - %t と %r だけが異なっています。バージョン2のログ形式にアップグレードした後、新しい `％{…}V' を使ってバージョン1のログと同じ出力を実現することができます。それは次のようなログディレクティブになります。

%h %l %u %{now}V %{req.method}V %{req.url}V %>s

さらに、バージョン1で %b ディレクティブを使用している場合、代わりにこのディレクティブを使用することができます：

%{resp.http.Content-Length}V