Edge Diagnostics allows you to diagnose your server, DNS, and network problems from Akamai servers around the world.
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 users may encounter. With Edge Diagnostics API you can diagnose common problems you may experience when delivering content to your users, except for China CDN.
Check these descriptions to learn more about the available categories of operations and operations they include.
These operations fetch data required by other operations.
- List available edge server locations. This operation returns locations of all active edge servers you can use to run diagnostic tools.
- List GTM properties. This operation lists all Global Traffic Management (GTM) properties you have access to and can run diagnostics for. You need this data if you want to run Get domain details with dig or Test network connectivity with MTR operations for a GTM hostname.
- List Test IP and Target IP for a GTM hostname. This operation returns test and target IPs for a GTM hostname. You need this data if you want to run the Test network connectivity with MTR operation for a GTM hostname.
- List IP acceleration hostnames. This operation lists IP acceleration hostnames you have access to and can generate a diagnostic link to collect diagnostic data.
These operations let you primarily diagnose issues in the traffic between a client and edge servers. You can also use these tools for other issues.
- Translate Error String. This operation returns details, including logs, about an error with a specific reference code.
- Collect and check user diagnostic data. If users of a particular domain are experiencing similar issues, generate a diagnostic link and send it to the users. After they click it, Edge Diagnostics gathers diagnostic data for users to submit. You can then use the Get diagnostic data of a group operation to check the gathered data and start troubleshooting. If you generated more than one link, use the List groups operation to check their details.
These operations get basic data from an edge server.
- Verify an IP. This operation checks whether an IP belongs to an edge server. This is useful if you want to make sure that an IP that tries to reach your content comes from the Akamai network. Also, for IPs positively verified, you can run further diagnostics with Request content with cURL, Get domain details with dig, and Test network connectivity with MTR operations.
- Locate an IP network. This operation returns geolocation data of IP's network.
- Verify and locate an IP. This operation combines Verify an IP and Locate an IP network operations. It simultaneously verifies if an IP belongs to an edge network and fetches IP's network geolocation data.
- Get error statistics. This operation returns error statistics for a URL or CP code based on the 9-second traffic sample from the last 2 minutes. You can also use it to check logs for each error.
- Run synchronous or asynchronous GREP operations. They return logs for edge server IPs from either the last 6 or 24 hours depending on the server and traffic conditions. Check Asynchronous processes for more details about these operations.
- Translate an Akamaized URL. This operation fetches basic information about an Akamaized URL (ARL), such as typecode, origin server, content provider (CP) code, serial number, and time to live (TTL).
- Metadata tracer. Launch a metadata tracing request to get information about latest behaviors and criteria applied to a Property Manager property. Then Check a metadata tracing request status to see the results.
These operations let you primarily diagnose issues in the traffic between an edge and origin server. You can also use these tools for other issues.
- Request content with cURL. This operation provides the raw HTML for requests from any IP address or location. You can use it to verify, if users can connect to a URL, check request and response headers, and test the URL with interjected headers.
- Get domain details with dig. This operation returns a typical dig response. You can use it to get DNS details for a hostname of domain name from a particular location or edge server IP. The results may help you diagnose issues with domain name resolutions.
- Test network connectivity with MTR. This operation checks the traffic between a location or an IP belonging to an edge network and an IP or a hostname. With this, you can verify if the traffic between a specific source and destination suffers packets' loss or latency.
If you're not sure where the problem is and which tool could help you identify the issue, use Problem scenarios.
In Problem scenarios you'll find several tools stitched up. With one request you run several tools and get the data and suggestions necessary to identify the cause of the issue.
- Run the URL health check. This problem scenario asynchronously translates a URL and runs GREP, Get domain details with dig, Request content with cURL, and Test network connectivity with MTR for the URL.
- Run the Connectivity problems scenario. This problem scenario enables you to troubleshoot slow download and high response time. It asynchronously runs GREP, Request content with cURL, and Test network connectivity with MTR for a URL.
- Run the Content problems scenario. This problem scenario enables you to troubleshoot incorrect or missing objects or stale content being served and partial downloads. It asynchronously runs GREP and Request content with cURL.