Log streaming: Google BigQuery

Fastly's Real-Time Log Streaming feature can send log files to BigQuery, Google's managed enterprise data warehouse.

Prerequisites

Before adding BigQuery as a logging endpoint for Fastly services you will need to:

• Register for a Google Cloud Platform (GCP) account.
• Create a service account on Google's website.
• Obtain the private_key and client_email from the JSON file associated with the service account.
• Enable the BigQuery API.
• Create a BigQuery dataset.
• Add a BigQuery table.

Creating a service account

BigQuery uses service accounts for third-party application authentication. To create a new service account, follow the instructions in the Google Cloud documentation. Keep the following in mind when creating the service account:

• The service account must be assigned the Big Query Data Editor role to write to the table you use for Fastly logging. See BigQuery Roles for details about the default permissions assigned to the Big Query Data Editor role.

  

• Set the key type to JSON when creating the service's private key pair.

If you elect to use Google service account impersonation in order to avoid storing keys with Fastly you may use this same service account for that purpose. Our guide to creating an Google IAM role provides further details on this feature.

Obtaining the private key and client email

When you create the BigQuery service account, a JSON file automatically downloads to your computer. This file contains the credentials for your BigQuery service account. Open the file and make a note of the values of the private_key and client_email fields.

Enabling the BigQuery API

To send your Fastly logs to your BigQuery table, you'll need to enable the BigQuery API in the Google Cloud Platform API Manager.

Creating the BigQuery dataset

After you've enabled the BigQuery API, follow these instructions to create a BigQuery dataset:

1. Open the BigQuery page in the Cloud Console.
2. In the Explorer panel, select the project where you want to create the dataset.
3. In the details panel, click Create dataset.
4. In the Dataset ID field, enter a name for the dataset (e.g., fastly_bigquery).
5. Click the Create dataset button.

Adding a BigQuery table

After you've created the BigQuery dataset, you'll need to add a BigQuery table. There are four ways of creating the schema for the table:

• Edit the schema using the BigQuery web interface.
• Edit the schema using the text field in the BigQuery web interface.
• Use an existing table.
• Set the table to automatically detect the schema.

Follow these instructions to add a BigQuery table:

1. Open the BigQuery page in the Cloud Console.

2. In the Explorer panel, expand your project and select the BigQuery dataset you created previously.

3. In the Source section, select Empty Table from the Create table from: menu. The Create table dialog appears.

   

4. In the Table name field, enter a name for the table (e.g., logs).

5. In the Schema section of the BigQuery website, use the interface to add fields and complete the schema. See the example schema section for details.

6. Click the Create Table button.

Adding BigQuery as a logging endpoint

Follow these instructions to add BigQuery as a logging endpoint. As part of configuration, you can elect to configure Google IAM role-based service account impersonation to avoid storing secrets. Read our guide on creating a Google IAM role for more information on this feature.

1. Review the information in our guide to setting up remote log streaming.
2. Click the Google BigQuery Create endpoint button. The Create a BigQuery endpoint page appears.
3. Fill out the Create a BigQuery endpoint fields as follows:
   • In the Name field, enter a human-readable name for the endpoint.
   • In the Placement area, select where the logging call should be placed in the generated VCL. Valid values are Format Version Default, waf_debug (waf_debug_log), and None. Read our guide on changing log placement for more information.
   • In the Log format field, enter the data to send to BigQuery. See the example format section for details.
   • In the Access Method area, select how Fastly will access Google resources for purposes of log delivery. Select either User Credentials or IAM Role.
   • If you selected User Credentials, enter the following fields:
     • In the Email field, enter the client_email address associated with the BigQuery service account.
     • In the Secret key field, enter the value of the private_key associated with your BigQuery service account.
     • In the Project ID field, enter the ID of your Google Cloud Platform project.
     • In the Dataset field, enter the name of your BigQuery dataset.
     • In the Table field, enter the name of your BigQuery table.
     • In the Template field, optionally enter an strftime compatible string to use as the template suffix for your table.
   • If you selected IAM Role, enter the following fields:
     • In the Service Account Name field, enter the name of the service account email address you selected when configuring Google IAM service account impersonation.
     • In the Project ID field, enter the ID of your Google Cloud Platform project.
     • In the Dataset field, enter the name of your BigQuery dataset.
     • In the Table field, enter the name of your BigQuery table.
     • In the Template field, optionally enter an strftime compatible string to use as the template suffix for your table.
4. Click the Create button to create the new logging endpoint.
5. Click the Activate button to deploy your configuration changes.

Example format

Data sent to BigQuery must be serialized as a JSON object, and every field in the JSON object must map to a string in your table's schema. The JSON can have nested data in it (e.g., the value of a key in your object can be another object). Here's an example format string for sending data to BigQuery:

1{
2  "timestamp": "%{strftime(\{"%Y-%m-%dT%H:%M:%S"\}, time.start)}V",
3  "client_ip": "%{req.http.Fastly-Client-IP}V",
4  "geo_country": "%{client.geo.country_name}V",
5  "geo_city": "%{client.geo.city}V",
6  "host": "%{if(req.http.Fastly-Orig-Host, req.http.Fastly-Orig-Host, req.http.Host)}V",
7  "url": "%{json.escape(req.url)}V",
8  "request_method": "%{json.escape(req.method)}V",
9  "request_protocol": "%{json.escape(req.proto)}V",
10  "request_referer": "%{json.escape(req.http.referer)}V",
11  "request_user_agent": "%{json.escape(req.http.User-Agent)}V",
12  "response_state": "%{json.escape(fastly_info.state)}V",
13  "response_status": %{resp.status}V,
14  "response_reason": %{if(resp.response, "%22"+json.escape(resp.response)+"%22", "null")}V,
15  "response_body_size": %{resp.body_bytes_written}V,
16  "fastly_server": "%{json.escape(server.identity)}V",
17  "fastly_is_edge": %{if(fastly.ff.visits_this_service == 0, "true", "false")}V
18}

Example schema

The BigQuery schema for the example format shown above would look something like this:

timestamp:TIMESTAMP,client_ip:STRING,geo_country:STRING,geo_city:STRING,host:STRING,url:STRING,request_method:STRING,request_protocol:STRING,request_referer:STRING,request_user_agent:STRING,response_state:STRING,response_status:STRING,response_reason:STRING,response_body_size:STRING,fastly_server:STRING,fastly_is_edge:BOOLEAN