- Install globally using
npm install -g akamai-error-lookup - Configure your Akamai API credentials in
auth.edgerc - Run
hashref [errorReference]
A command line utility to lookup Akamai error reference numbers (e.g. Reference #18.2d351ab8.1557333295.a4e16ab).
If you work on a website hosted behind Akamai's CDN you will, on occasion, see an Akamai Reference # error number. These occur when Akamai catches an error, as opposed to the origin serving an error, such as a DNS resolution failure or an origin connection error.
In these scenarios Akamai reports an error reference number:
Using hashref you can lookup the details of the #Ref error number to diagnose the root cause of the error:
hashref 11.2e373217.1558103133.1dedf6b
npm install -g akamai-error-lookup
You'll need to create an auth.edgerc file and configure it with your Akamai API credentials as described here.
You can save auth.edgerc in either the current directory or in the home directory (node -p require('os').homedir()).
Using the home directory means you can install the package globally and call hashref from any location.
If the auth.edgerc file is not found you'll receive the following error message:
hashref [errorReference] [options]
--decode <true|false> Enable or disable decoding of URLs and user-agent [true]
--no-color Switches off colour output
--version Display version number
--help Display this help
By default all output will be decoded, so that fields such as user-agent and URL are more readable. Use --decode false to switch this off.
If your terminal has problems rendering the colour output then you can switch it off by using --no-color.
Prints out akamai-error-lookup's version number.
Displays the help screen.
The default terminal output contains a selective subset of the more salient fields returned by Akamai's API.
The full json response is automatically written to the operating system's default directory for temporary files (node -p require('os').tmpdir()). The location is displayed as part of the terminal output:
Writing full response to [C:\Users\foo\AppData\Local\Temp\11.2e373217.1558514903.f6c71e.json]
Note: On Linux systems this will be /tmp rather than /var/tmp which means these files will not persist a system reboot. If you want to retain them, copy them elsewhere.
akamai-error-lookup uses the npm package debug. If you set the environment variable debug to hashref you'll see full debug output.
set debug=hashref
hashref [errorReference]
DEBUG=hashref hashref [errorReference]
$env:debug="hashref"
node akamai-error-lookup [errorReference]
The Change Log as been moved to its own file, CHANGELOG.md, and can be found here