Log streaming: Google Cloud Storage

1. Review the information in our guide to setting up remote log streaming.
2. In the Google Cloud Services area, click Create endpoint.
3. Fill out the Create a Google Cloud Storage (GCS) 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, optionally enter an Apache-style string or VCL variables to use for log formatting. Consult the example format section for details.
   • (Optional) In the Timestamp format field, enter a timestamp format for log files. The default is an strftime compatible string. Our guide on changing where log files are written provides more information.
   • In the Email field, enter the client_email address listed in the JSON file associated with the service account you created on Google's website.
   • In the Bucket name field, enter the name of the GCS bucket in which to store the logs.
   • In the Access Method area, select how Fastly will access Google resources for purposes of log delivery. Valid values are User Credentials and IAM Role.
   • If you selected User Credentials, fill out the following fields:
     • In the Email field, enter the client_email address listed in the JSON file associated with the service account you created on Google's website.
     • In the Secret key field, enter the private_key value listed in the JSON file associated with the service account you created on Google's website. We strip out the JSON newline escape characters for you so don't worry about removing them.
   • If you selected IAM Role, fill out the following field:
     • In the Service Account Name field, enter the service account ID which was created for you from the service account name you entered when configuring Google IAM service account impersonation. The service account ID comes before the @ in the service account email. For example, if your service account email is my-name@projectid.iam.gserviceaccount.com, the service account ID is my-name.
     • In the Project ID field, enter the ID of your Google Cloud Platform project.
   • (Optional) In the PGP public key field, enter a PGP public key that Fastly will use to encrypt your log files before writing them to disk. You will only be able to read the contents by decrypting them with your private key. The PGP key should be in PEM (Privacy-Enhanced Mail) format. Read our guide on log encryption for more information.
   • (Optional) In the Period field, enter an interval (in seconds) to control how frequently your log files are rotated. Rotation entails the finalization of one file object and the start of a new one, never removing any previously created file object. This value defaults to 3600 seconds.
4. Click Advanced options and fill out the fields as follows:
   • (Optional) In the Path field, enter the path within the bucket to store the files. The path ends with a trailing slash. If this field is left empty, the files will be saved in the bucket's root path. Our guide on changing where log files are written provides more information.
   • In the Select a log line format area, select the log line format for your log messages. Our guide on changing log line formats provides more information.
   • (Optional) In the Compression field, select the compression format you want applied to the log files. Our guide on changing log compression options provides more information.
5. Click Create to create the new logging endpoint.
6. Click Activate to deploy your configuration changes.

Example format

The following is an example format string for sending data to GCS. Our discussion of format strings provides more information.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{
  "timestamp": "%{strftime(\{"%Y-%m-%dT%H:%M:%S%z"\}, time.start)}V",
  "client_ip": "%{req.http.Fastly-Client-IP}V",
  "geo_country": "%{client.geo.country_name}V",
  "geo_city": "%{client.geo.city}V",
  "host": "%{if(req.http.Fastly-Orig-Host, req.http.Fastly-Orig-Host, req.http.Host)}V",
  "url": "%{json.escape(req.url)}V",
  "request_method": "%{json.escape(req.method)}V",
  "request_protocol": "%{json.escape(req.proto)}V",
  "request_referer": "%{json.escape(req.http.referer)}V",
  "request_user_agent": "%{json.escape(req.http.User-Agent)}V",
  "response_state": "%{json.escape(fastly_info.state)}V",
  "response_status": %{resp.status}V,
  "response_reason": %{if(resp.response, "%22"+json.escape(resp.response)+"%22", "null")}V,
  "response_body_size": %{resp.body_bytes_written}V,
  "fastly_server": "%{json.escape(server.identity)}V",
  "fastly_is_edge": %{if(fastly.ff.visits_this_service == 0, "true", "false")}V
}