eCDN Logpush Filter

Create eCDN Logpush Job with Filter

Use the B2C CLI:

# Required scopes: sfcc.cdn-zones, sfcc.cdn-zones.rw
export SFCC_CLIENT_ID='your-account-manager-client-id'
export SFCC_CLIENT_SECRET='your-account-manager-client-secret'
export SFCC_SHORTCODE='your-short-code'

npx @salesforce/b2c-cli ecdn logpush jobs create \
  --tenant-id abcd_stg --zone stg-abcd-example-com.cc-ecdn.net \
  --name ExampleLogPushJob \
  --destination-path 's3://example-bucket/log?region=us-east-1' \
  --ownership-token 'your-ownership-challenge-token' \
  --log-type http_requests \
  --log-fields CacheCacheStatus,ClientRequestHost,ClientRequestPath,EdgeResponseStatus,EdgeStartTimestamp \
  --filter '{"where":{"key":"ClientRequestPath","operator":"contains","value":"/example-path"}}'

Alternatively, use the API:

curl "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",
  "filter": "{\"where\":{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/example-path\"}}",
  "logFields": [
    "CacheCacheStatus",
    "CacheResponseBytes",
    "ClientRequestPath",
    "ClientRequestBytes",
    "ClientRequestHost",
    "ClientRequestUserAgent",
    "EdgeResponseStatus",
    "EdgeResponseBytes",
    "EdgeStartTimestamp",
    "EdgeTimeToFirstByteMs"
  ]
}'

Successful Response

A successful response returns 201.

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

Filter Detail

The following table shows the supported comparison operators along with example values.

To add filters, provide the filter criteria in the form of escaped JSON strings with the format {\"where\":{\"key"\:\"<field>\",\"operator\":\"<comparison_operator>\",\"value\":\"<value>\"}}.

note: - The \“Key”\ field value must correspond to one of the available fields listed in eCDN Logpush Log Field.

• For the Firewall events dataset, filtering is not supported for the following fields: Action, Description, Kind, MatchIndex,Metadata, OriginatorRayID, RuleID, and Source.

Logical Operators in Filter

• Filters can be connected using AND, OR logical operators.
• Logical operators can be nested.

Here are some examples of how the logical operators can be implemented. X, Y, and Z are used to represent filter criteria:

• X AND Y AND Z - {"where":{"and":[{X},{Y},{Z}]}}
• X OR Y OR Z - {"where":{"or":[{X},{Y},{Z}]}}
• X AND (Y OR Z) - {"where":{"and":[{X}, {"or":[{Y},{Z}]}]}}
• (X AND Y) OR Z - {"where":{"or":[{"and": [{X},{Y}]},{Z}]}}

Example Request

In this example, the eCDN logpush job sends the logs to the S3 bucket only if the log has ClientRequestPath that contains “/example-path” and EdgeResponseStatus includes 502, 503, and 504.

curl "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",
  "filter": "{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/example-path\"}, {\"key\":\"EdgeResponseStatus\",\"operator\":\"in\",\"value\":[502, 503, 504]}]}}",
  "logFields": [
    "CacheCacheStatus",
    "CacheResponseBytes",
    "ClientRequestPath",
    "ClientRequestBytes",
    "ClientRequestHost",
    "ClientRequestUserAgent",
    "EdgeResponseStatus",
    "EdgeResponseBytes",
    "EdgeStartTimestamp",
    "EdgeTimeToFirstByteMs"
  ]
}'