viewing Apigee X documentation.
View Apigee Edge documentation.
The API Monitoring Investigate view displays pivot tables of metrics and attributes for all API traffic, to help you compare activity for different metrics.
To access the Investigate view, follow the steps in Accessing API Monitoring and select Investigate.
The figure below shows the UI with Investigate selected.
By default, the Investigate view displays three tables:
- Fault Code by Time
- Fault Code by Status Code
- Fault Source by Proxy
Each cell in a table shows the number of responses for a subset of the data. As an example, take a look at the first three columns of the Fault Code by Time table.
The first cell in row 1 shows the number of responses (
444) with fault code
steps.json2xml.SourceUnavailable that were returned from
18:18 - 18:24, on the selected date.
The first cell in row 2 shows the numbers of responses (
during the same time
interval for which the fault code was not set for some reason.
To learn about this particular fault code, see JSON to XML policy runtime error troubleshooting.
2xx status codes
Requests that return a 2xx status code were successfully received and understood. Normally, most requests will return a 2xx status code. If you are primarily interested in viewing data for unsuccessful requests, you might want to restrict the displayed data to requests with status codes other than 2xx, to make the data easier to interpret. To do so, toggle the Show 2xx Status Code button, at the top-right of the Investigate view, to the left (off) position.
With this setting, the Investigate view only displays data from requests with response codes different from 2xx.
Viewing the distribution of cell data
You can get a more granular view of the data for an individual table cell by clicking the cell. This displays the distribution of the cell data by several different attributes.
To see an example of this, first select Region in the Graphs menu to display the table shown below.
In the data for this example, there is just one region,
If there were data for other regions, you would see additional rows in the table.
Now, click the first cell in the table.
This displays several tables in the right-hand pane of the Investigate view. The first table is shown below.
The top of the pane displays the conditions that specify the cell data, in this case the region and time interval.
Below that, the table "Distribution by Fault Code" displays the number of responses for each fault code in the data. In this example, there are just two fault code values:
The counts for the fault codes add up to
496, the total count in the
As another example, scroll down in the right-hand pane until you reach the table labeled "Distribution by Status Code," as shown below.
In this case, there are two status codes in the data:
Again, the counts add up to
Using the Investigate view to diagnose an issue
You can use the Investigate view to diagnose API issues For example, suppose you receive an alert that indicates that the 5xx error rate exceeds the specified threshold. To investigate this issue, you might perform the following tasks in the Investigate view:
- View the FAULT CODE BY TIME table to view the fault code activity over the last hour.
- View the FAULT CODE BY STATUS CODE table to identify specific HTTP status codes associated with the fault codes whose counts have increased over the last hour, as identified in the previous step.
- View the FAULT CODE BY PROXY matrix to identify the API proxies that are triggering the fault codes identified in the previous step.
- Set up an alert to further assist you with diagnosing the issue.