Setting up Google Cloud Storage Log Delivery

Applies To:

HTTP LargeThis platform has been optimized to cache and deliver static content (e.g., HTML, CSS, JavaScript, ISO, multimedia, and software downloads, etc.) over HTTP or HTTPS.

HTTP SmallLegacy. If you are currently serving traffic over this platform, then you may continue to do so. However, we recommend that you serve your traffic over our more robust HTTP Large platform.

ADNThe Application Delivery Network platform has been optimized to deliver dynamic content (e.g., login credentials, account information, etc.) over HTTP or HTTPS. Typically, user-specific and database-driven content are served over this platform.

Real-Time Log DeliveryDelivers near real-time log data to your web server, an AWS S3 bucket, an Azure Block Blob, Splunk Enterprise, Sumo Logic, or Datadog.

RTLD may automatically deliver compressed log data to a Google Cloud Storage bucket by submitting HTTPS PUT requests to it. Each request adds an object to a Cloud Storage bucket. This object contains a compressed JSON or CSV document that uniquely identifies a set of log data and describes one or more log entries.

Learn more: RTLD CDN | RTLD Rate Limiting | RTLD WAF

RTLD applies gzip compression to log data. Google Cloud Storage stores compressed log data as an object with a gz file extension.
Learn more.

To create a log delivery profile

Create or identify a Google Cloud Storage bucket to which log data will be posted.

Key information:
- The recommended configuration is to set the Access control option to Uniform.
- Set the Encryption option to Google-managed encryption key.
View Google Cloud Storage documentation on how to create a bucket.
Add the following user to the bucket and assign it the Storage Object Creator role:

vdms-partner-gcs-transfer@maw-partner-gcs.iam.gserviceaccount.com

View Google Cloud Storage documentation on how to set up an IAM policy for a bucket.
Optional. Set up Google Cloud to process the log data that will be posted to it.

Example:

Load logs into BigQuery and then leverage BigQuery functionality through the BigQuery Browser Tool.
Navigate to the Real-Time Log Delivery CDN | Rate Limiting | WAF page. From the main menu, navigate to More and then find Real-Time Log Delivery under Analytics. Select either CDN, WAF, or RL.
Click Add Profile.
From the Log Delivery Method option, select Google Cloud Storage.
Set the Bucket option to the name of the Google Cloud Storage bucket to which log data will be posted.
Optional. Set the Prefix option to the desired prefix that defines a virtual log file storage location and/or a prefix that will be added to each object added to your bucket.
Learn more.
- A prefix should not start with a forward slash.
- A forward slash within the specified prefix is interpreted as a delimiter for a virtual directory.
- A trailing forward slash means that the specified value only defines a virtual directory path within your Google Cloud Storage bucket where logs will be stored. If the specified value ends in a character other than a forward slash, then the characters specified after the forward slash will be prepended to the file name for each log file uploaded to Google Cloud Storage.
  
  Sample prefix:
  
  logs/CDN/siteA_
  
  The above prefix will store log files in the following virtual directory:
  
  /logs/CDN
  
  The file name for each log file uploaded to Google Cloud Storage will start with siteA_.
  
  Sample log file name:
  
  siteA_adn_0001_123_20210111_50550000F98AB95B_1.json
From the Log Format option, select whether to format log data using our standard JSON format, as a JSON array, as JSON lines, or as a CSV (RTLD CDN only).

Learn more: RTLD CDN | RTLD Rate Limiting | RTLD WAF
From the Downsample the Logs option, determine whether all or downsampledReduces the amount of log data that will be delivered. For example, you may choose to only deliver 1% of your log data. log data will be delivered.
- All Log Data: Verify that the Downsample the Logs option is disabled.
- Downsampled Log Data: Downsample logs to 0.1%, 1%, 25%, 50%, or 75% of total log data by enabling the Downsample the Logs option and then selecting the desired rate from the Downsampling Rate option.
  
  Use this capability to reduce the amount of data that needs to be processed or stored by Google Cloud Storage.
  RTLD CDN Only: Downsampling log data also reduces usage charges for this service.
Log delivery setup varies according to whether you are delivering log data for CDN traffic, threats identified by WAF, or rate limited requests.
To set up RTLD CDN
1. From the Log Delivery section, mark each delivery platform for which real-time log data may be delivered.
2. From the Filter by Edge CNAME section, perform one of the following steps:
  - Filter log data by one or more edge CNAME(s)
    
    Determine whether log data will be filtered to include or exclude requests to the selected edge CNAME(s) by selecting either Matches or Does Not Match, respectively.
    
    Select one or more edge CNAMEs from the option directly to the right of the above option.
    
    Filter the list by typing the entire or partial hostname. For example, typing co will filter the list to include all hostnames that contain co (e.g., cdn.example.com and corp.example.org).
  - Upload all log data regardless of edge CNAME
    
    Verify that an edge CNAME has not been defined within this section.
3. From the Filter by User Agent option, perform one of the following steps:
  - Filter log data by user agent
    
    Type a RE2-compatible regular expressionThis type of value is interpreted as a regular expression that defines a pattern of characters. pattern that identifies the set of user agents by which log data will be filtered.
  - Upload all log data regardless of user agent
    
    Set it to a blank value.
4. From the Filter by Status Code section, perform one of the following steps:
  - Filter log data by status code
    
    Mark each status code class (e.g., 2xx or 3xx) for which log data will be delivered. Clear all other status code classes.
  - Upload all log data regardless of status code
    
    Clear all status code classes (e.g., 2xx and 3xx).
5. From the Log file contains the following fields section, perform the following steps:
  1. Add the request headers, response headers, and cookies that will be logged for each request from the Custom Request Headers, Custom Response Headers, and Custom Cookies options.
    
    You may either select or type the name of the desired headers and/or cookies. Click on the list to add additional headers or cookies. Remove a header or cookie by clicking on its x.
    
    Although other settings take effect quickly, it may take up to 90 minutes before data for custom request/response headers and cookies is logged.
  2. Click Expand All.
  3. Mark each field that will be reported for each request submitted to the CDN.
  4. Clear each field for which log data should not be reported.
  Add or clear all of the fields associated with a category by marking or clearing the category's header.
To set up RTLD Rate Limiting
1. From the Filter by Edge CNAME section, perform one of the following steps:
  - Filter log data by one or more edge CNAME(s)
    
    Determine whether log data will be filtered to include or exclude requests to the selected edge CNAME(s) by selecting either Matches or Does Not Match, respectively.
    
    Select one or more edge CNAMEs from the option directly to the right of the above option.
    
    Filter the list by typing the entire or partial hostname. For example, typing co will filter the list to include all hostnames that contain co (e.g., cdn.example.com and corp.example.org).
  - Upload all log data regardless of edge CNAME
    
    Verify that an edge CNAME has not been defined within this section.
2. From the Filter by Country section, perform one of the following steps:
  - Filter log data by one or more countries:
    
    Determine whether log data will be filtered to include or exclude requests to the selected countries by selecting either Matches or Does Not Match, respectively.
    
    Select one or more countries from the option directly to the right of the above option.
    
    Filter the list by typing the entire or partial country name. For example, typing un will filter the list to include all countries that contain un (e.g., United States and United Kingdom).
  - Upload all log data regardless of country of origin:
    
    Verify that a country has not been defined within this section.
3. From the Filter by User Agent option, perform one of the following steps:
  - Filter log data by user agent
    
    Type a RE2-compatible regular expressionThis type of value is interpreted as a regular expression that defines a pattern of characters. pattern that identifies the set of user agents by which log data will be filtered.
  - Upload all log data regardless of user agent
    
    Set it to a blank value.
4. From the Filter by Client IP option, perform one of the following steps:
  - Filter log data by one or more IP addresses:
    
    Determine whether log data will be filtered to include or exclude requests to the selected IP addresses by selecting either Matches or Does Not Match, respectively.
    
    Type one or more IP addresses within the option directly to the right of the above option.
  - Upload all log data regardless of IP address:
    
    Verify that an IP address has not been defined within this section.
5. From the Filter By Action Type option, perform one of the following steps:
  - Filter log data by one or more enforcement action(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected enforcement action(s) by selecting either Matches or Does Not Match, respectively.
    
    Select or type the name for one or more enforcement action(s).
  - Upload all log data regardless of enforcement action:
    
    Verify that an enforcement action has not been defined within this section.
6. From the Filter By Request Method option, perform one of the following steps:
  - Filter log data by one or more request method(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected request method(s) by selecting either Matches or Does Not Match, respectively.
    
    Select or type the name for one or more request method(s).
  - Upload all log data regardless of request method:
    
    Verify that a request method has not been defined within this section.
7. From the Filter By Scope Name option, perform one of the following steps:
  - Filter log data by one or more security application manager(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected security application manager(s) by selecting either Matches or Does Not Match, respectively.
    
    Select or type the name for one or more security application manager(s).
  - Upload all log data regardless of security application manager:
    
    Verify that a security application manager(s) has not been defined within this section.
8. From the Filter By Action Limit ID option, perform one of the following steps:
  - Filter log data by one or more rate rule(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected rate rules(s) by selecting either Matches or Does Not Match, respectively.
    
    Type the name for one or more rate rule(s).
  - Upload all log data regardless of rate rule:
    
    Verify that a rate rule has not been defined within this section.
9. From the Filter By URL Regex option, perform one of the following steps:
  - Filter log data by URL
    
    Type a RE2-compatible regular expressionThis type of value is interpreted as a regular expression that defines a pattern of characters. pattern that identifies the set of URLs by which log data will be filtered.
  - Upload all log data regardless of URL
    
    Set it to a blank value.
10. From the Log file contains the following fields section, perform the following steps:
  1. Mark each field that will be reported for each request submitted to the CDN.
  2. Clear each field for which log data should not be reported.
To set up RTLD WAF
1. From the Filter by Edge CNAME section, perform one of the following steps:
  - Filter log data by one or more edge CNAME(s)
    
    Determine whether log data will be filtered to include or exclude requests to the selected edge CNAME(s) by selecting either Matches or Does Not Match, respectively.
    
    Select one or more edge CNAMEs from the option directly to the right of the above option.
    
    Filter the list by typing the entire or partial hostname. For example, typing co will filter the list to include all hostnames that contain co (e.g., cdn.example.com and corp.example.org).
  - Upload all log data regardless of edge CNAME
    
    Verify that an edge CNAME has not been defined within this section.
2. From the Filter by Country section, perform one of the following steps:
  - Filter log data by one or more countries:
    
    Determine whether log data will be filtered to include or exclude requests to the selected countries by selecting either Matches or Does Not Match, respectively.
    
    Select one or more countries from the option directly to the right of the above option.
    
    Filter the list by typing the entire or partial country name. For example, typing un will filter the list to include all countries that contain un (e.g., United States and United Kingdom).
  - Upload all log data regardless of country of origin:
    
    Verify that a country has not been defined within this section.
3. From the Filter by User Agent option, perform one of the following steps:
  - Filter log data by user agent
    
    Type a RE2-compatible regular expressionThis type of value is interpreted as a regular expression that defines a pattern of characters. pattern that identifies the set of user agents by which log data will be filtered.
  - Upload all log data regardless of user agent
    
    Set it to a blank value.
4. From the Filter By Security Application Manager option, perform one of the following steps:
  - Filter log data by one or more security application manager(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected security application manager(s) by selecting either Matches or Does Not Match, respectively.
    
    Select or type the name for one or more security application manager(s).
  - Upload all log data regardless of security application manager:
    
    Verify that a security application manager(s) has not been defined within this section.
5. From the Filter By Access Rule option, perform one of the following steps:
  - Filter log data by one or more access rule(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected access rule(s) by selecting either Matches or Does Not Match, respectively.
    
    Select or type the name for one or more access rule(s).
  - Upload all log data regardless of access rule:
    
    Verify that an access rule has not been defined within this section.
6. From the Filter By Custom Rule option, perform one of the following steps:
  - Filter log data by one or more custom rule(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected custom rule(s) by selecting either Matches or Does Not Match, respectively.
    
    Select or type the name for one or more custom rule(s).
  - Upload all log data regardless of custom rule:
    
    Verify that a custom rule has not been defined within this section.
7. From the Filter By Managed Rule option, perform one of the following steps:
  - Filter log data by one or more managed rule(s):
    
    Determine whether log data will be filtered to include or exclude requests to the selected managed rule(s) by selecting either Matches or Does Not Match, respectively.
    
    Select or type the name for one or more managed rule(s).
  - Upload all log data regardless of managed rule:
    
    Verify that a managed rule has not been defined within this section.
8. From the Log file contains the following fields section, perform the following steps:
  1. Mark each field that will be reported for each request submitted to the CDN.
  2. Clear each field for which log data should not be reported.
Set the Log Delivery Enabled option to the "on" position.
Click Save.

Log File Naming Convention

The log data stored within an object is compressed using gzip. Each object follows this naming convention:

Log Type_AN_Profile ID_Date Stamp_Agent ID_Sequence Number.File Extension.gz

The JSON document contained within an object follows this naming convention:

Log Type_AN_Profile ID_Date Stamp_Agent ID_Sequence Number.File Extension

Sample file name (RTLD CDN - JSON log format):

adn_0001_123_20210111_50550000F98AB95B_1.json

Sample file name (RTLD Rate Limiting - JSON log format):

rl_0001_123_20210111_50550000F98AB95B_1.json

Sample file name (RTLD WAF - JSON log format):

waf_0001_123_20210111_50550000F98AB95B_1.json

Each of the above file naming variables are described below.

Variable	Description
Log Type	Represents the type of log data. RTLD CDN: Identifies the delivery platform for which CDN activity was logged. Valid values are: wpc: HTTP Large platform wac: HTTP Small platform adn: Application Delivery Network platform RTLD Rate Limiting: This variable is always set to rl. RTLD WAF: This variable is always set to waf.
AN	Represents your CDN account number (e.g., 0001). This account number may be viewed from the upper-right hand corner of the MCC.
Profile ID	Represents the system-defined ID for your Real-Time Log Delivery configuration. You cannot currently view the system-defined ID assigned to your Real-Time Log Delivery configuration from within the MCC.
Date Stamp	Represents the date on which the log file was generated. Syntax: YYYYMMDD Example: 20210110
Agent ID	Represents a unique ID that identifies the Real-Time Log Delivery software agent that generated the log file.
Sequence Number	Represents a sequential number that identifies the order in which the log file was generated by the software agent identified above. Each software agent assigns a sequential number to the log files that it generates. A gap between log files generated on the same day by the same software agent indicates missing log data. Learn more. Key information: This number starts at 0. This number resets to 0 at the start of a new day (UTC).
File Extension	Represents the file extension for the log file. This file extension varies by log format. JSON Log Format: json JSON Array Log Format: json_array JSON Lines Log Format: json_lines

More Information

RTLD may deliver log data to one or more of the following destinations:

Your web server(s) | An AWS S3 Bucket| An Azure Block Blob container | Splunk Enterprise | Sumo Logic | Datadog | Google Cloud Storage | New Relic (RTLD CDN and RTLD Rate Limiting)
Log fields vary by RTLD module.

Learn more: RTLD CDN | RTLD Rate Limiting | RTLD WAF
Verifying Log Data