Datadog Log Delivery

RTLD may automatically deliver compressed log data to Datadog by submitting HTTPS POST requests to it. Datadog will collect these requests as they are pushed from the CDN. Each request contains a compressed JSON document that describes one or more log entries.

Key information:

• The format for log data delivered to Datadog is JSON Array. This log format does not provide information that uniquely identifies a set of log data. As a result, there is no way to check for gaps in sequence numbers when attempting to identify missing log data.
• The set of available log fields varies by RTLD module: RTLD CDN | RTLD Rate Limiting | RTLD WAF

To prepare Datadog for log delivery

1. From within the Datadog portal, copy your API key.
2. Identify the Datadog location to which log data will be delivered.
3. Upon completing the above steps, you should create a log delivery profile for Datadog.

To set up a log delivery profile

1. From the Real-Time Log Delivery CDN page, click + New Log Delivery Profile.

   1. Open the desired property.

      1. Select either your private space or a team space.
      2. Click on the desired property.

   2. From the left pane, click on the desired environment.

   3. From the left pane, click Realtime Log Delivery.

2. From the Profile Name option, assign a name to this log delivery profile.

3. From the Log Delivery Method option, select Datadog.

4. Define how RTLD will communicate with Datadog.

   1. From the Datadog Site option, select the Datadog location to which log data will be delivered.
   2. From the Datadog API Key option, paste your Datadog API key. This API key authorizes our service to upload log data to Datadog.
   3. From the Datadog Service Attribute Value option, type a value that identifies the data delivered as a result of this profile. Our service sets Datadog’s service reserved attribute to this value.

5. 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

6. From the Downsample the Logs option, determine whether to reduce the amount of log data that will be delivered. For example, you may choose to only deliver 1% of your log data.

   • All Log Data: Verify that the Downsample the Logs option is cleared.

   • 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 within your web server(s).

     RTLD CDN Only: Downsampling log data also reduces usage charges for this service.

7. Determine whether log data will be filtered.

   • RTLD CDN

8. By default, all log fields are enabled on a new log delivery profile. Clear each field for which log data should not be reported. Adjust the set of log fields that will be included within this log delivery profile from within the Fields section.

   Log fields are categorized. You may add or remove individual fields by expanding a category and then marking or clearing specific log fields. Alternatively, add or remove all of the log fields associated with a category by marking or clearing the desired category.

   RTLD CDN Only: You may also log request headers, response headers, and cookies by adding them through the Custom Request Headers, Custom Response Headers, and Custom Cookies options.i

   You may either select the name of the desired header or cookie, or type its name and then press ENTER. 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.

   TODO: Verify

9. Click Create Log Delivery Profile.

Filtering Log Data #

Filter log data to only include relevant information and to reduce the amount of data being ingested. Filtering options vary by RTLD module.

Filtering RTLD CDN Log Data#

You may filter by:

• Hostname: Filter log data to only include traffic directed to the desired hostname(s). Set up hostname filtering within the Filter by Hostname section.

  • Filter log data by one or more hostname(s) by:

    1. Determine whether log data will be filtered to include or exclude requests to the selected hostname(s) by selecting either Matches or Does Not Match, respectively.
    2. Click within the Hostnames option and select the desired hostname(s).
    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 hostname: Verify that a hostname has not been defined within the Hostnames option.

    Remove a hostname by clicking on its x.

• User Agent: Filter log data to only include traffic that was requested by a client whose user agent matches a RE2-compatible regular expression pattern. Set up user agent filtering within the Filter by User Agent option.

  • Filter log data by user agent: Type a RE2-compatible regular expression 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.

• Status Code: Filter log data to only include traffic for specific status code(s). Set up status code filtering within the Filter by Status Code section.

  • Filter log data by status code: Select each status code class (e.g., 2xx or 3xx) for which log data will be delivered.

  • Upload all log data regardless of status code: Verify that a status code class (e.g., 2xx and 3xx) has not been defined within this option.

    Remove a status code class by clicking on its x.