The container OS is Ubuntu Configuration is set via command-line arguments passed via the docker run command. Sandbox origin or sandbox - an Apache server running within the container that hosts ESI examples by default, but can also be used to mount a local directory of ESI files for quick and easy testing. Remote origin - an upstream server for ETS to forward requests to. Playground - real-time, test-as-you-type ESI testing tool.
|Published (Last):||7 June 2014|
|PDF File Size:||19.41 Mb|
|ePub File Size:||3.41 Mb|
|Price:||Free* [*Free Regsitration Required]|
Overview Once you extend your web content onto the Akamai edge network and apply various Akamai features to accelerate and manipulate content, you need to be able to troubleshoot any problems your own users may encounter. The Diagnostic Tools API allows you to diagnose many common problems Akamai customers experience when delivering content to their end users.
This major new API release supersedes the original version 1. Version 2 includes the following features: The new API now allows you to access data asynchronously to avoid long-running requests that often time out. See Asynchronous Requests for more information. It allows you to run many familiar networking tools such as dig, mtr, and curl, or get logs either from locations on the Akamai edge network, or from specific Akamai IP addresses.
A new error statistics feature allows you to research how edge servers communicate both with user client requests, and with your origin server.
You are also able to aggregate error statistics for each CP code , the main system you use to organize categories of web content.
This API version allows you to diagnose problems with any Global Traffic Management properties subdomains you administer. In addition to running tests on specific edge server locations or IP addresses, you can send individual end users diagnostic links to trace what happens to their requests. It also lets you emulate specific client-browser and geographical conditions. See ESI Debugger for more information. See Diagnostic Utilities for more information on available tools.
See the Resources section for a complete listing of API operations. Who should use this API Use this API to implement your own problem-resolution dashboard for Akamai-provisioned content, or to integrate it with other similar debugging tools.
Use the end-user operations to implement interfaces to solicit feedback from your own users. In addition to helping solve any problems your end users experience, consider also leveraging these batch tools to design more proactive interfaces to monitor performance. Some of the diagnostic tools this API makes available require certain features to be available under your product and contract.
For example, you need Global Traffic Management enabled to run the corresponding diagnostic tools , otherwise you get a error. Make sure the identity under which you provision the API has access to all the features for which you want diagnostic data.
Diagnostic utilities Many of the utilities this API makes available to you effectively extend the range of standard networking tools so that you can run them from arbitrary locations within the Akamai network, rather than from your local network. The API makes these diagnostic utilities available: Akamai Server Locations : This basic enabling utility lists available Akamai ghost server locations.
You may need this information to run other utilities from a set of edge server locations. You may need this information to run other utilities from a set of edge IP addresses. Dig, by edge IP or location : This uses the dig command to provide Domain Name Server DNS details for the location of the edge server and hostname or domain name, allowing you to diagnose issues with domain name resolution.
Mtr, by edge IP or location : This uses the mtr command to provide information about the route, number of hops, and time that Internet traffic packets take between the edge server and a remote host or destination. The results can show you where network delays are being introduced in the path.
Log Lines, by edge IP or location : This uses the grep command to retrieve and parse log records within the last 48 hours from either an edge server location or an IP address. Geolocation : This provides the geographic and network location of any IP address.
The results provide a URL to send to the end user. When the user visits the URL, the API captures user and mapping information that you may need to troubleshoot a problem. Global Traffic Management : This tool provides a mapping of subdomain properties to domain names, and corresponding edge IP addresses. Error Statistics : This provides details on errors that occur when delivering web content.
It reports syntax errors, evaluation messages to check whether the site is working properly, and all environment variables used for your test. Also, it provides features that let you emulate user geographical data and client-browser conditions. This introduces significant latencies when doing ordinary GET requests on the reporting data.
Requests can run minutes long, and can time out. To address this problem, version 2 of the Diagnostic Tools API introduces a new way to access the data asynchronously. Instead of getting the data directly, you launch a request to fetch it later, and poll the status of that request. When the data is ready, a response provides a link to the data in the same format as you would ordinarily get directly.
Otherwise store the API hypermedia link to check it directly. This represents the estimated number of seconds for when the data will be ready for you. Wait for the duration of the retryAfter interval, then either use the requestId to run the relevant check operation, or simply GET the link.
If the response yields a code, it means the process is still running, and the data is not yet ready. Once the response yields a code, it means the request has completed, and your data is now ready. The API makes the requested data available at that link for at least 24 hours. The API provides the following set of asynchronous operations as an alternative to accessing directly, but with latency: POST async request.
Edge Side Includes