Troubleshoot Fastly

Overview of troubleshooting Fastly

To verify the Fastly extension is working or to debug the Fastly extension, you can use the curl command to display certain response headers. The values of these response headers indicate whether or not Fastly is enabled and functioning properly.

Response headers and values:

  • Fastly-Magento-VCL-Uploaded should be present
  • X-Magento-Tags should be returned
  • Fastly-Module-Enabled should be either Yes or the Fastly extension version number
  • X-Cache should be either HIT or HIT, HIT
  • Cache-Control: max-age should be greater than 0
  • Pragma should be cache

To get values for these headers, you must run the following curl commands:

  • Staging or production URL (also referred to as the origin server)

    This command goes directly to the origin server, bypassing the Fastly extension; it returns the headers Fastly-Module-Enabled, Cache-Control: max-age, and Pragma

  • Live site URL

    This command goes through the Fastly extension and returns the Fastly-Magento-VCL-Uploaded and X-Cache headers

You should perform the test on your staging or production site. The Fastly extension isn’t necessary on your integration site, so there’s no point in testing it there.

Test your staging or production site

Test your staging or production site:

This section discusses how to use curl to get response headers from your staging or production site (that is, the origin server).

The URL format follows:

  • Staging: http[s]://staging.<your domain>.c.<project ID>.ent.magento.cloud
  • Production:

    • Load balancer URL: http[s]://<your domain>.c.<project ID>.ent.magento.cloud
    • Direct access to one of the three redundant servers: http[s]://<your domain>.{1|2|3}.<project ID>.ent.magento.cloud

If you don’t know your staging or production URLs, locate the Onboarding Spreadsheet in your Magento Enterprise Cloud Edition OneDrive account. Tab 3 (DNSSSLCDN) has access information for your staging and production systems. Use the values in the CNAME/Alias (No CDN) cell.

Enter the following command to test your site:

curl -k <staging or production URL> [-H 'Host: <public URL>'] -vo /dev/null -HFastly-Debug:1

For example, if you have a public URL www.mymagento.biz, enter a command similar to the following to test the production site:

curl -k https://www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud -H 'Host: www.mymagento.biz' -vo /dev/null -HFastly-Debug:1

If you do not have DNS set up for a public host name, enter a command similar to the following:

curl -k https://www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud -vo /dev/null -HFastly-Debug:1

The output for this command can be lengthy so the following is a summary only:

* STATE: INIT => CONNECT handle 0x600057800; line 1402 (connection #-5000)
* Rebuilt URL to: https://www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud/
* Added connection 0. The cache now contains 1 members
*   Trying 192.0.2.31...
* STATE: CONNECT => WAITCONNECT handle 0x600057800; line 1455 (connection #0)
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                             Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0* Connected to www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud (54.229.163.31) port 443 (#0)
* STATE: WAITCONNECT => SENDPROTOCONNECT handle 0x600057800; line 1562 (connection #0)
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0* ALPN, offering h2

  ... portion omitted for brevity ...

< Set-Cookie: mage-messages=%5B%5D; expires=Wed, 22-Nov-2017 17:39:58 GMT; Max-Age=31536000; path=/
< Pragma: cache
< Expires: Wed, 23 Nov 2016 17:39:56 GMT
< Cache-Control: max-age=86400, public, s-maxage=86400, stale-if-error=5, stale-while-revalidate=5
< X-Magento-Tags: cb_welcome_popup store cb cb_store_info_mobile cb_header_promotional_bar cb_store_info cb_discount-promo-bar cpg_2 cb_83 cb_81 cb_84 cb_85 cb_86 cb_87 cb_88 cb_89 p5646 catalog_product p5915 p6040 p6197 p6227 p7095 p6109 p6122 p6331 p7592 p7651 p7690
< Fastly-Module-Enabled: yes
< Strict-Transport-Security: max-age=31536000
	< Content-Security-Policy: upgrade-insecure-requests
< X-Content-Type-Options: nosniff
< X-XSS-Protection: 1; mode=block
< X-Frame-Options: SAMEORIGIN
< X-Platform-Server: i-dff64b52
<
* STATE: PERFORM => DONE handle 0x600057800; line 1955 (connection #0)
* multi_done
  0     0    0     0    0     0      0      0 --:--:--  0:00:02 --:--:--     0
* Connection #0 to host www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud left intact

The preceding example shows the correct values for Pragma, X-Magento-Tags, and Fastly-Module-Enabled.

Test your live site

This section discusses how to test your live site URL, which means the curl command goes through the Fastly extension. This command returns the values of the Fastly-Magento-VCL-Uploaded and X-Cache headers.

If you don’t have a live site set up with DNS, you can use either a static route or you can use the optional --resolve flag, which bypasses DNS name resolution.

To optionally set up a static route:

Set up a static route only if your site isn’t set up with DNS.

  1. Locate your operating system’s hosts file.
  2. Add the static route in the format:

    <ip address> <url>
    
Test your live site:

Enter the following command to test your live site URL:

curl http://<live URL> -vo /dev/null -HFastly-Debug:1 [--resolve]

Use --resolve only if your live URL isn’t set up with DNS.

For example,

http://www.mymagento.biz -vo /dev/null -HFastly-Debug:1

The output for this command is similar to the preceding command; following are only the unique headers returned by this command:

< Fastly-Magento-VCL-Uploaded: yes
< X-Cache: HIT, MISS

Resolve errors

This section provides suggestions for resolving errors you might find using the curl command.

Fastly-Module-Enabled is not present

Do the following:

  1. Install the Fastly module
  2. In the Magento Admin, set Fastly as the page cache.
  3. Push the changes to your staging or production server.

Fastly-Magento-VCL-Uploaded is not present

Upload the Fastly VCL

X-Cache includes MISS

If X-Cache is either HIT, MISS or MISS, MISS, enter the same curl command again to make sure the page wasn’t recently evicted from the cache.

If you get the same result, use the first curl command discussed in this topic to verify that:

  • Pragma is cache
  • X-Magento-Tags exists
  • Cache-Control: max-age is greater than 0

If the issue persists, another extension is likely resetting these headers. Repeat the following procedure as many times as necessary to identify which extension is resetting the headers:

  1. Log in to the Magento Admin as an administrator.
  2. Click Stores > Settings > Configuration > Advanced > Advanced.
  3. In the Disable Modules Output section in the right pane, locate an extension.
  4. From the list next to the extension name, click Disable.
  5. Click Save Config.
  6. Click System > Tools > Cache Management.
  7. Click Flush Magento Cache.
  8. Try the curl commands discussed in this topic again.
  9. If the results are the same, repeat the tasks discussed in this section to disable another extension.

When you isolate the extension that is resetting Fastly headers, contact the extension developer for additional assistance.