Skip to content
This repository has been archived by the owner. It is now read-only.
AMPBench: AMP URL validation and troubleshooting tools (DEPRECATED)
JavaScript HTML TypeScript Other
Branch: master
Clone or download

Latest commit

Latest commit e099857 Mar 17, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
amp-story Update caches.json Aug 2, 2019
docs New /docs folder. Added walkthrough doc. Oct 28, 2016
public Add shutdown banner Nov 14, 2019
tests fixed all testing Aug 17, 2017
validator Commits supporting Combo update #85 Oct 10, 2018
views Add shutdown banner Nov 14, 2019
.eslintrc Tweak rules Sep 11, 2018
.gitignore Validator rollup + fix #10 Oct 9, 2017
.gitpod Update .gitpod Oct 1, 2018
.travis.yml Disabled node 6 tests Nov 14, 2019
.travis_script.sh Fix URL Oct 4, 2018
AUTHORS Preparation commit for AMP Project GitHub repo. Oct 5, 2016
CONTRIBUTING.md remove outdated contribution info Apr 26, 2019
LICENSE Preparation commit for AMP Project GitHub repo. Oct 5, 2016
README.md Update README.md Mar 17, 2020
SCREENSHOT.png Updated SCREENSHOT.png for README.md. Apr 13, 2017
SCREENSHOT.tiff Updated SCREENSHOT.png for README.md. Apr 13, 2017
ampbench_handlers.js Auto-update validator Aug 2, 2019
ampbench_lib.js eslint fixes Aug 2, 2019
ampbench_lib_sd.js Fix permissions Sep 11, 2018
ampbench_main.js eslint --fix Sep 11, 2018
ampbench_routes.js Add 299 warning header Nov 18, 2019
ampbench_util.js Fix permissions Sep 11, 2018
app.yaml Report UA being used: #13 Apr 11, 2017
gulpfile.js Fixed the testing Aug 17, 2017
karma.conf.js testing Jul 6, 2017
logo.png Rewiring to use chrome.storage.local Oct 20, 2017
package-lock.json Auto-update validator Aug 2, 2019
package.json Redirect to GitHub source Feb 5, 2020
redirect-all.js Redirect to GitHub source Feb 5, 2020

README.md

Build Status

AMPBench: AMP URL Validation and Troubleshooting

Status

The hosted version of ampbench was shut down in February 2020. For the rationale and alternatives, see issue #126.

There are no plans to remove the source code from its canonical location at https://github.com/ampproject/ampbench, but if it is important to you, we recommend making a copy.

Guides

Walkthrough article: Debug AMP pages with AMPBench, an open source app from the AMP Project.

What does it do?

AMPBench is a web application and service that validates AMP URLs + their associated Structured Data.

During AMP URL validation, it builds referable, support-friendly sharable URLs such as the following:

AMPBench in action

License

AMPBench is licensed under the Apache 2.0 LICENSE.

Disclaimer

AMPBench is not an official Google product.

Getting the code and running it

Install the Node.js Active LTS version on your system. E.g., by downloading or by using a package manager or by using NVM.

Now do the following from a terminal command-line session:

$ git clone https://github.com/ampproject/ampbench.git
$ cd ampbench
$ npm install
$ node ampbench_main.js

Also try navigating to these links from your web browser:

Even try this from the command-line:

$ curl http://localhost:8080/version/
$ curl http://localhost:8080/raw?url=https://ampbyexample.com/
$ curl http://localhost:8080/api?url=https://ampbyexample.com/
$ curl http://localhost:8080/api1?url=https://ampbyexample.com/
$ curl http://localhost:8080/api2?url=https://ampbyexample.com/

Utilities

AMPBench includes some useful debug utility commands that can in some cases help with troubleshooting, such as when a full validation fails on a URL by returning unexpected server responses.

The /debug... commands attempt to follow fetch requests and display relevant request and response details in a similar spirit to the curl -I [--head]... utility.

Use these as follows in the browser:

and:

Or, with the command-line compatible _cli equivalents, in a terminal session:

$ curl https://ampbench.appspot.com/debug_cli?url=https://ampbyexample.com

and:

$ curl https://ampbench.appspot.com/debug_curl_cli?url=https://ampbyexample.com

The /debug and /debug_cli versions use a smartphone HTTP User Agent. The /debug_curl and /debug_curl_cli variants use the curl (desktop and server-side) User Agent.

The applied User Agent is reported in the output and can be seen in the resulting HTTP request headers as in the following examples.

For /debug...:

{"User-Agent":"Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2725.0 Mobile Safari/537.36","host":"ampbyexample.com"}

and for /debug_curl...:

{"User-Agent":"curl/7.43.0","host":"ampbyexample.com"}

Deploying AMPBench to the Cloud

Deploying AMPBench to Google Compute Engine

To deploy AMPBench to the App Engine flexible environment, you need to have a Google Cloud Platform Console project.

Please review the following documentation:

From within the ampbench source root folder, deplyoment to Google Compute Engine, App Engine flexible environment, should be similar to the following sequence.

Run gcloud init:

$ gcloud init

Deploy and run:

$ gcloud app deploy 

Deploying AMPBench to Amazon Web Services (AWS)

AWS Elastic Beanstalk uses highly reliable and scalable services that are available in the AWS Free Usage Tier and supports apps developed in Node.js, such as AMPBench, out-of-the-box.

Please review the following documentation:

Make sure to set up AWS with your account credentials:

The Elastic Beanstalk Command Line Interface (EB CLI) is configured as follows:

From within the ampbench source root folder, deplyoment to AWS Elastic Beanstalk environment should be similar to the following:

$ eb init # only initially or when the configuration changes
$ eb deploy

Configuring AMPBench via the environment variables

AMPBench supports configuration of the port to listen on via the PORT environment variable. e.g.

    PORT=8080 npm start

AMPBench also supports Google Analytics tracking using gtag configuration. To enable this simply define the GTAG_ID environment variable. e.g.

    GTAG_ID=UA-123456789-1 npm start
You can’t perform that action at this time.