eCDN Logpush

eCDN Logpush は、eCDN ログをバッチ単位で指定した宛先に配信します。eCDN ログには、クライアントの IP アドレス、リクエストされた URL、ユーザーエージェント文字列、ファイアウォールイベントの詳細 (ブロックされたリクエスト、ファイアウォールルールのトリガーなど) をはじめとする有用な情報が含まれます。

eCDN Logpush を使用して Logpush ジョブを作成する場合、http_requests、firewall、および pageshield イベントで使用可能なフィールドのリストを表示できます。また、HTTP リクエストやファイアウォールイベントなど、配信するログタイプを指定できるほか、さまざまな宛先タイプを指定することもできます。

Amazon S3 バケット用の Logpush ジョブを作成 (所有権の確認手順が必要)
Google Cloud Storage 用の Logpush ジョブを作成 (所有権の確認手順が必要)
Azure 用の Logpush ジョブを作成
Datadog 用の Logpush ジョブを作成
Splunk 用の Logpush ジョブを作成
HTTPS 用の Logpush ジョブを作成
Kinesis 用の Logpush ジョブを作成

Amazon S3 バケット用の Logpush ジョブの作成

前提条件

Amazon S3 宛先へのログプッシュを有効にするには、次の手順を実行します。

S3 バケットを作成します。詳細については、AWS S3 のドキュメントを参照してください。
Amazon S3 コンソールで、S3 > Bucket > Permissions > Bucket Policy に移動し、ポリシーを編集して貼り付け、「Resource」(リソース) の値を自分のバケットパスに置き換えます。AWS Principal は CDN プロバイダーが所有しているため、変更しないでください。

1{ "Id": "PutObjPolicy", "Version": "2012-10-17", "Statement": [ { "Sid": "AllowObjectFromeCDNLogpush", "Action": [ "s3:PutObject" ], "Effect": "Allow", "Resource": "arn:aws:s3:::example-bucket/*", "Principal": { "AWS": [ "arn:aws:iam::391854517948:user/cloudflare-logpush" ] } } ] }

不完全なファイルを回避し、ストレージコストを最小限に抑えるため、eCDN Logpush を使用して S3 マルチパートアップロード用のルールを設定する際は、AbortIncompleteMultipartUpload アクションを使用してください。詳細については、マルチパートアップロードを使用したオブジェクトのアップロードとコピー_を参照してください。

Note

Amazon S3 バケット所有権トークンの作成

eCDN Logpush は、CDN-API Logpush API を介して eCDN ログを Amazon S3 に直接プッシュすることをサポートしています。

ただし、ログを AWS S3 バケットに直接プッシュする eCDN Logpush ジョブを作成する前に、その S3 バケットの所有権を証明する必要があります。これを行うには、所有権トークンファイルをバケットの宛先に書き込みます。また、同じバケット内の宛先パスごとに、一意の所有権チャレンジトークンを作成する必要があります。

宛先パスで特別な文字列 {DATE} を使用して、ログを日別のサブディレクトリに分けることができます。たとえば、s3://customer-bucket/logs/{DATE}?region=us-east-1\&sse=AES256 のように指定します。ログが保存されると、ディレクトリの名前は YYYYMMDD 形式の日付に置き換えられます (例: 20230215)。

リクエストの例:

1curl "https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/ownership" --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "destinationPath": "s3://example-bucket/log?region=us-east-1" }

レスポンスの例:

{ "data": { "destinationPath": "s3://example-bucket/log?region=us-east-1", "fileName": "log/ownership-challenge-072fd6be.txt" } }

Amazon S3 用の Logpush ジョブ API 呼び出しの作成

前のセクションで行われた呼び出しに基づいて `ownershipChallengeToken` を設定します。destinationPath は、所有権トークンの生成時に指定したものと同じである必要があります。詳細については、パラメーター、オプションのパラメーター、および制限の各セクションを参照してください。

Logpush ジョブ API 呼び出しの例:

1curl --location `https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs` --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "name": "ExampleLogPushJob", "destinationPath": "s3://example-bucket/log?region=us-east-1", "logType": "http_requests", "ownershipChallengeToken": "Put your ownership challenge token here", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ] }

API 呼び出しレスポンスの例: 201 ステータスコード

1{"data": {"jobId": 213543,"name": "ExampleLogPushJob","logType": "http_requests","logFields": ["CacheCacheStatus","CacheResponseBytes","ClientRequestPath","ClientRequestBytes","ClientRequestHost", "ClientRequestUserAgent","EdgeResponseStatus","EdgeResponseBytes","EdgeStartTimestamp","EdgeTimeToFirstByteMs"],"destinationPath":"s3://example-bucket/log?region=us-east-1","enabled": false,"createdOn":"2023-04-18T17:18:43Z"}}

Google Cloud Storage (GCS) 用の Logpush ジョブの作成

前提条件

GCS 宛先へのログプッシュを有効にするには、次の手順を実行します。

GCS バケットを作成します。
Cloudflare は、Google Cloud Identity and Access Management (IAM) を使用して Google Cloud Storage バケットにアクセスします。Cloudflare の IAM サービスアカウントには、そのバケットに対する管理者権限が必要です。logpush@cloudflare-data.iam.gserviceaccount.com を、Storage Object Admin (ストレージオブジェクト管理者) 権限を持つメンバーとして追加します。これにより、Cloudflare は所有権の確認とログを GCS バケットにプッシュできるようになります。

GCS 所有権トークンの作成

eCDN Logpush は、CDN Logpush APIを介して eCDN ログを Google Cloud Storage (GCS) に直接プッシュすることをサポートしています。

ただし、ログを GCS バケットにプッシュする eCDN Logpush ジョブを作成する前に、GCS バケットの所有権を証明する必要があります。これを行うには、所有権トークンファイルをバケットの宛先に書き込みます。また、同じバケット内の宛先パスごとに、一意の所有権チャレンジトークンを作成する必要があります。
宛先パスで特別な文字列 {DATE} を使用して、ログを日別のサブディレクトリに分けることができます。たとえば、gs://customer-bucket/logs/{DATE} のように指定します。ログが保存されると、ディレクトリの名前は YYYYMMDD 形式の日付に置き換えられます (例: 20230215)。

リクエストの例:`

1curl "https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/ownership" --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "destinationPath": "gs://cflogpushtest/http_requests/{DATE}" }

レスポンスの例:

{ "data": { "destinationPath": "gs://cflogpushtest/http_requests/20251008", "fileName": "http_requests/20251008/ownership-challenge-072fd6be.txt" } }

GCS 用の Logpush ジョブ API 呼び出しの作成

前のセクションで実行した呼び出しに基づいて、ownershipChallengeToken を設定します。`destinationPath` は、所有権トークンの生成時に指定したものと同じである必要があります。詳細については、パラメーター、オプションのパラメーター、および制限の各セクションを参照してください。

Logpush ジョブ API 呼び出しの例:

1curl --location `https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs` --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "name": "ExampleLogPushJob", "destinationPath": "gs://cflogpushtest/http_requests/{DATE}", "logType": "http_requests", "ownershipChallengeToken": "Put your ownership challenge token here", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ] }

API 呼び出しレスポンスの例: 201 ステータスコード

1{"data": {"jobId": 213543,"name": "ExampleLogPushJob","logType": "http_requests","logFields": ["CacheCacheStatus","CacheResponseBytes","ClientRequestPath","ClientRequestBytes","ClientRequestHost", "ClientRequestUserAgent","EdgeResponseStatus","EdgeResponseBytes","EdgeStartTimestamp","EdgeTimeToFirstByteMs"],"destinationPath":"gs://cflogpushtest/http_requests/{DATE}","enabled": false,"createdOn":"2023-04-18T17:18:43Z"}}

Azure Logpush ジョブの作成

前提条件

Azure 宛先に対してログプッシュを有効にするには、次の手順を実行します。

Blob Storage コンテナを作成します。詳細については、Azure の手順 ↗ を参照してください。
Blob Storage コンテナへのアクセスを保護し、制限するために、Shared Access Signature (共有アクセス署名: SAS) ↗ を作成します。
Storage Explorer ↗ を使用してコンテナに移動し、コンテナを右クリックして署名を作成します。署名の有効期限を現在の日付から少なくとも 5 年後に設定し、書き込み権限のみを付与します。
destinationPath 属性の一部として SAS URL を指定します。
SAS トークンの有効期限が切れると Logpush はログのプッシュを停止するため、有効期限は少なくとも 5 年に設定する必要があります。

Azure 用宛先構成の例:

1“azure://cflogpushtest.blob.core.windows.net//cflogpush/{DATE}?sv=2024-11-04&ss=b&srt=o&sp=wactf&se=2030-09-23T22:27:16Z&st=2025-09-23T14:12:16Z&spr=https&sig=abcdefgh%3D”

Cloudflare は、指定された Azure 宛先にテストデータをプッシュするテスト呼び出しを行います。成功した場合、Logpush ジョブが作成されます。失敗した場合は、Logpush ジョブの作成は失敗します。

Azure 用の Logpush ジョブ API 呼び出しの作成

次の例では、Azure の宛先パスを使用して Logpush ジョブを作成します。詳細については、パラメーター、オプションのパラメーター、および制限の各セクションを参照してください。

1curl --location `https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs` --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "name": "ExampleLogPushJob", "destinationPath": "azure://cflogpush.blob.core.windows.net//cflogpush/{DATE}?sv=2024-11-04&ss=b&srt=o&sp=wactf&se=2030-01-01T00:00:00Z&st=2025-01-01T00:00:00Z&spr=https&sig=abcdefghIJKLMNOP%3D", "logType": "http_requests", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ] }

API 呼び出しレスポンスの例: 201 ステータスコード

1{"data": {"jobId": 213543,"name": "ExampleLogPushJob","logType": "http_requests","logFields": ["CacheCacheStatus","CacheResponseBytes","ClientRequestPath","ClientRequestBytes","ClientRequestHost", "ClientRequestUserAgent","EdgeResponseStatus","EdgeResponseBytes","EdgeStartTimestamp","EdgeTimeToFirstByteMs"],"destinationPath":"azure://cflogpush.blob.core.windows.net//cflogpush/{DATE}?sv=2024-11-04&ss=b&srt=o&sp=wactf&se=2030-01-01T00:00:00Z&st=2025-01-01T00:00:00Z&spr=https&sig=abcdefghIJKLMNOP%3D","enabled": false,"createdOn":"2023-04-18T17:18:43Z"}}

Datadog Logpush ジョブの作成

前提条件

Datadog 宛先へのログプッシュを有効にするには、次の手順を実行します。

宛先構成のホスト名として、http-intake.logs.datadoghq.com/v1/input または http-intake.logs.datadoghq.com/api/v2/logs のいずれかを指定します。
Datadog ドキュメントを使用して Datadog API キーを取得します。これは必須フィールドです。
サービス、ホスト名、Datadog の ddsource フィールド、および ddtags フィールドを URL パラメーターとして設定できます。これらのパラメーターは オプション ですが、ログのインデックス作成や処理に役立つ場合があります。詳細については、Datadog ドキュメントの Logs セクション ↗を参照してください。なお、これらのパラメーターの値には特殊文字を含めることができ、その場合は URL エンコードする必要があります。

Datadog 用宛先構成の例:

1"datadog://<DATADOG_ENDPOINT_URL>?header_DD-API-KEY=<DATADOG_API_KEY>&ddsource=cloudflare&service=<SERVICE>&host=<HOST>&ddtags=<TAGS>”

Cloudflare は、指定された Datadog 宛先構成にテストデータをプッシュするテスト呼び出しを行います。成功した場合、Logpush ジョブが作成されます。失敗した場合は、Logpush ジョブの作成は失敗します。

Datadog 用の Logpush ジョブ API 呼び出しの作成

次の例では、Datadog の宛先パスを使用して Logpush ジョブを作成します。詳細については、パラメーター、オプションのパラメーター、および制限の各セクションを参照してください。

1curl --location `https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs` --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "name": "ExampleLogPushJob", "destinationPath": "datadog://<DATADOG_ENDPOINT_URL>?header_DD-API-KEY=<DATADOG_API_KEY>&ddsource=cloudflare&service=<SERVICE>&host=<HOST>&ddtags=<TAGS>", "logType": "http_requests", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ] }

API 呼び出しレスポンスの例: 201 ステータスコード

1{"data": {"jobId": 213543,"name": "ExampleLogPushJob","logType": "http_requests","logFields": ["CacheCacheStatus","CacheResponseBytes","ClientRequestPath","ClientRequestBytes","ClientRequestHost", "ClientRequestUserAgent","EdgeResponseStatus","EdgeResponseBytes","EdgeStartTimestamp","EdgeTimeToFirstByteMs"],"destinationPath":"datadog://<DATADOG_ENDPOINT_URL>?header_DD-API-KEY=<DATADOG_API_KEY>&ddsource=cloudflare&service=<SERVICE>&host=<HOST>&ddtags=<TAGS>","enabled": false,"createdOn":"2023-04-18T17:18:43Z"}}

Splunk Logpush ジョブの作成

前提条件

次の値を使用して Splunk 宛先を構成します。

<SPLUNK_ENDPOINT_URL>: ポートを含む Splunk の Raw HTTP Event Collector URL。例: splunk.cf-analytics.com:8088/services/collector/raw
- Logpush ジョブの構成および設定時、Cloudflare は Splunk エンドポイントが /services/collector/raw であることを想定しています。
<SOURCE_TYPE>: Splunk のソースタイプ。例: cloudflare:json
<SPLUNK_AUTH_TOKEN>: URL エンコードされた Splunk 認証トークン。例: Splunk%20e6d94e8c-5792-4ad1-be3c-29bcaee0197d
- Splunk で HEC が有効になっていることを確認します。詳細については、Splunk Analytics Integrations を参照してください。
- 不正な URL を追加すると、API リクエストは 504 エラーで失敗します。通常、Splunk Cloud エンドポイント URL には、ホスト名の前に http-inputs- のような文字列が含まれます。
<SPLUNK_CHANNEL_ID>: 一意のチャネル ID。これはランダムな GUID で、次のいずれかの方法で生成できます。
- GUID Generator ↗ などのオンラインツール。
- コマンドライン。例: python \-c 'import uuid; print(uuid.uuid4())'
<INSECURE_SKIP_VERIFY>: ブール値。Cloudflare では、この値を false に設定することを推奨しています。true に設定すると、Splunk の例に示されている curl の -k オプションを使用するのと同等になるためです。これは、HEC が自己署名証明書を使用している場合を除き、推奨されません。

Splunk 用宛先構成の例:

1"splunk://<SPLUNK_ENDPOINT_URL>?channel=<SPLUNK_CHANNEL_ID>&insecure-skip-verify=<INSECURE_SKIP_VERIFY>&sourcetype=<SOURCE_TYPE>&header_Authorization=<SPLUNK_AUTH_TOKEN>"

Cloudflare は、指定されたエンドポイントにテストデータをプッシュするテスト呼び出しを行います。成功した場合、Logpush ジョブが作成されます。失敗した場合は、Logpush ジョブの作成は失敗します。

Splunk 用の Logpush ジョブ API 呼び出しの作成

次の例では、Splunk の宛先パスを使用して Logpush ジョブを作成します。詳細については、パラメーター、オプションのパラメーター、および制限の各セクションを参照してください。

1curl --location `https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs` --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "name": "ExampleLogPushJob", "destinationPath": "splunk://<SPLUNK_ENDPOINT_URL>?channel=<SPLUNK_CHANNEL_ID>&insecure-skip-verify=<INSECURE_SKIP_VERIFY>&sourcetype=<SOURCE_TYPE>&header_Authorization=<SPLUNK_AUTH_TOKEN>", "logType": "http_requests", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ] }

API 呼び出しレスポンスの例: 201 ステータスコード

1{"data": {"jobId": 213543,"name": "ExampleLogPushJob","logType": "http_requests","logFields": ["CacheCacheStatus","CacheResponseBytes","ClientRequestPath","ClientRequestBytes","ClientRequestHost", "ClientRequestUserAgent","EdgeResponseStatus","EdgeResponseBytes","EdgeStartTimestamp","EdgeTimeToFirstByteMs"],"destinationPath":"splunk://<SPLUNK_ENDPOINT_URL>?channel=<SPLUNK_CHANNEL_ID>&insecure-skip-verify=<INSECURE_SKIP_VERIFY>&sourcetype=<SOURCE_TYPE>&header_Authorization=<SPLUNK_AUTH_TOKEN>","enabled": false,"createdOn":"2023-04-18T17:18:43Z"}}

HTTPS Logpush ジョブの作成

前提条件

HTTPS 宛先を構成します。

宛先の検証時に行われるファイルアップロードで、圧縮された内容 {"content":"tests"} を含む gzip 形式の test.txt.gz ファイルを受け入れられることを確認します。そうでない場合は、たとえば error validating destination: error writing object: error uploading のようなエラーが返されます。
リクエストヘッダーを設定するには、“header_*” URL パラメーターを指定します。
- HTTPS エンドポイントには、設定した “header_*” URL パラメーターと競合するカスタム URL パラメーターを含めることはできません。
- これらのパラメーターは、適切に URL エンコードする必要があります。たとえば、空白には “%20” を使用します。そうしないと、一部の特殊文字が正しくデコードされない可能性があります。
destinationconf では、特殊な “header*” パラメーターに加えて、URL パラメーターを指定できます。
- URL エンコードされていない特殊文字は、アップロード時にエンコードされます。

HTTPS エンドポイント用宛先構成の例:

1https://logs.example.com?header_Authorization=Basic%20REDACTED&tags=host:salesforce.com,dataset:http_requests

HTTPS エンドポイント用の Logpush ジョブ API 呼び出しの作成

この例では、HTTPS 宛先エンドポイントを使用して Logpush ジョブを作成します。詳細については、パラメーター、オプションのパラメーター、および制限の各セクションを参照してください。

1curl --location `https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs` --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "name": "ExampleLogPushJob", "destinationPath": "https://logs.example.com?header_Authorization=Basic%20REDACTED&tags=host:salesforce.com,dataset:http_requests", "logType": "http_requests", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ] }

API 呼び出しレスポンスの例: 201 ステータスコード

1{"data": {"jobId": 213543,"name": "ExampleLogPushJob","logType": "http_requests","logFields": ["CacheCacheStatus","CacheResponseBytes","ClientRequestPath","ClientRequestBytes","ClientRequestHost", "ClientRequestUserAgent","EdgeResponseStatus","EdgeResponseBytes","EdgeStartTimestamp","EdgeTimeToFirstByteMs"],"destinationPath":"https://logs.example.com?header_Authorization=Basic%20REDACTED&tags=host:salesforce.com,dataset:http_requests","enabled": false,"createdOn":"2023-04-18T17:18:43Z"}}

Kinesis Logpush ジョブの作成

前提条件

Kinesis 宛先を構成します。

次の信頼関係を使用して、Cloudflare Logpush が引き受ける IAM ロールを作成します。

1{
2    "Version": "2012-10-17",
3    "Statement": [
4        {
5             "Effect": "Allow",
6             "Principal": {
7                 "AWS": [
8                     "arn:aws:iam::391854517948:user/cloudflare-logpush"
9                 ]
10             },
11             "Action": "sts:AssumeRole"
12        }
13    ]
14}

IAM ロールに、Kinesis ストリームに対して PutRecord アクションを実行する権限があることを確認します。

<AWS_REGION>、<YOUR_AWS_ACCOUNT_ID>、<STREAM_NAME> を実際の値に置き換えます。

1{
2    "Version": "2012-10-17",
3    "Statement": [
4        {
5             "Effect": "Allow",
6             "Action": "kinesis:PutRecord",
7             "Resource": "arn:aws:kinesis:<AWS_REGION>:<YOUR_AWS_ACCOUNT_ID>:stream/<STREAM_NAME">
8        }
9    ]
10}

(オプション) STS Assume Role を使用する場合は、Logpush ジョブのリクエストで sts-external-id を destination_conf パラメーターとして含めることができます。詳細については、Securely Using External ID for Accessing AWS Accounts Owned by Others ↗ (外部 ID を使用した他者所有の AWS アカウントへの安全なアクセス) を参照してください。

AWS Kinesis への Logpush 設定用宛先構成の例: kinesis://<STREAM_NAME>?region=<AWS_REGION>&sts-assume-role-arn=arn:aws:iam::<YOUR_AWS_ACCOUNT_ID>:role/<IAM_ROLE_NAME>

Kinesis 用の Logpush ジョブ API 呼び出しの作成

次の例では、Kinesis を使用して Logpush ジョブを作成します。詳細については、パラメーター、オプションのパラメーター、および制限の各セクションを参照してください。

1curl --location `https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs` --request 'POST' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data-raw `{ "name": "ExampleLogPushJob", "destinationPath": "kinesis://<STREAM_NAME>?region=<AWS_REGION>&sts-assume-role-arn=arn:aws:iam::<YOUR_AWS_ACCOUNT_ID>:role/<IAM_ROLE_NAME>", "logType": "http_requests", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ] }

API 呼び出しレスポンスの例: 201 ステータスコード

1{"data": {"jobId": 213543,"name": "ExampleLogPushJob","logType": "http_requests","logFields": ["CacheCacheStatus","CacheResponseBytes","ClientRequestPath","ClientRequestBytes","ClientRequestHost", "ClientRequestUserAgent","EdgeResponseStatus","EdgeResponseBytes","EdgeStartTimestamp","EdgeTimeToFirstByteMs"],"destinationPath":"kinesis://<STREAM_NAME>?region=<AWS_REGION>&sts-assume-role-arn=arn:aws:iam::<YOUR_AWS_ACCOUNT_ID>:role/<IAM_ROLE_NAME>","enabled": false,"createdOn":"2023-04-18T17:18:43Z"}}

パラメーター

Name: サイト名。ジョブの作成後に変更することはできません。
Destination Path: ログの受信先となる宛先パス。各宛先タイプの前提条件には、destinationPath 属性の取得方法が記載されています。
Ownership Challenge Token: この属性は、AWS S3 および Google Cloud Storage の宛先に必須です。HTTPS、Datadog、Azure、Splunk、Kinesis などのその他の宛先では不要です。
Log Type: S3 バケットで受信するログのタイプ。現在、使用可能なタイプは http_requests、firewall_events、page_shield_events です。
Log Fields: 使用可能なログフィールド。ログのタイプによって異なります。詳細については、eCDN Logpush ログフィールドを参照してください。

オプションのパラメーター

Filter: フィルターを使用すると、ログに含める特定のタイプのイベントを選択したり、分析に不要なイベントを削除したりできます。ログにフィルターを適用することで、最も重要なデータに注力して、不要なノイズを避けることができます。

詳細については、eCDN Logpush フィルターを参照してください。

制限事項

ゾーンごとに作成できる Logpush ジョブは最大 2 つです。

Logpush ジョブの有効化

eCDN Logpush ジョブは、作成時点では有効になっていません。ログの受信を開始するには、Logpush ジョブを有効にする必要があります。詳細は、CDN Zones API の概要を参照してください。

1curl "https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs/{jobId}" \ --request 'PUT' \ --header 'Authorization: Bearer {access_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ "enabled": true }'

リクエストの例

1{ "enabled": true }

成功レスポンス

成功した場合は、200 が返されます。

1{ "data": { "jobId": 213543, "name": "ExampleLogPushJob", "logType": "http_requests", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ], "destinationPath": "s3://example-bucket/log?region=us-east-1", "enabled": true, "createdOn": "2023-04-18T17:18:43Z" } }

eCDN Logpush ログの JSON 出力データ

この例は、eCDN Logpush ジョブから出力される JSON ログを示しています。

1{ "CacheCacheStatus": "dynamic", "CacheResponseBytes": 12191, "ClientRequestPath": "/404", "ClientRequestBytes": 2161, "ClientRequestHost": "edge01.sfcc-ecdn-test5.net", "ClientRequestUserAgent": "Fuzz Faster U Fool v1.5.0-dev", "EdgeResponseStatus": 410, "EdgeResponseBytes": 39065, "EdgeStartTimestamp": "2023-04-18T17:29:16Z", "EdgeTimeToFirstByteMs": 504, "ClientRequestSource":"eyeball" }

Logpush ジョブのリスト

詳細は、CDN Zones API の概要を参照してください。

1curl "https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs" --request 'GET' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json'

成功した場合は、200 が返されます。

1{ "data": [ { "jobId": 213543, "name": "ExampleLogPushJob", "logType": "http_requests", "logFields": [ "CacheCacheStatus", "CacheResponseBytes", "ClientRequestPath", "ClientRequestBytes", "ClientRequestHost", "ClientRequestUserAgent", "EdgeResponseStatus", "EdgeResponseBytes", "EdgeStartTimestamp", "EdgeTimeToFirstByteMs" ], "destinationPath": "s3://example-bucket/log?region=us-east-1", "enabled": true, "createdOn": "2023-04-18T17:18:43Z" } ] }

Logpush ジョブの削除

詳細は、CDN Zones API の概要を参照してください。

1curl "https://{shortcode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/f_ecom_bcxj_prd/zones/{zoneId}/logpush/jobs/{jobId}" --request 'DELETE' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json'

成功した場合は、204 が返されます。

eCDN Logpush に関するよくある質問 (FAQ)

Logpush ジョブが誤って無効になってしまい、一定期間のログを取り逃しました。取り逃したログを取得する方法はありますか?
- いいえ。eCDN Logpush は、ログが利用可能になり次第、それらを S3 バケットにプッシュするため、欠落したログを後から補完することはできません。
ログのプッシュ頻度を調整できますか?
- eCDN Logpush は、可能な限り早いタイミングで、指定された宛先にログをバッチでプッシュします。
所有権トークンを作成しましたが、S3 バケットにファイルが表示されません。
- eCDN Logpush がバケットにファイルを書き込めるように、S3 バケットポリシーを確認してください。Amazon S3 への eCDN Logpush の有効化セクションに示されているとおりに Resource の値を置き換えてポリシーを編集し、そのポリシーを S3 > Bucket > Permissions > Bucket Policy に貼り付けてください。