Using the service map - Amazon X-Ray
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Using the service map

View the X-Ray service map to identify services where errors are occurring, connections with high latency, or traces for requests that were unsuccessful.

Note

The X-Ray service map can display up to 10,000 nodes. In rare scenarios where the total number of service nodes exceeds this limit, you may receive an error and be unable to display a complete service map in the console.

Viewing the service map

X-Ray console

To view the service map

  1. Open the X-Ray console. The service map is displayed by default. You can also choose Service map from the left navigation pane.

    
                  X-Ray console service map page
  2. Choose a service node to view requests for that node, or an edge between two nodes to view requests that traveled that connection.

  3. Use the response distribution histogram to filter traces by duration, and select status codes for which you want to view traces. Then choose View traces to open the trace list with the filter expression applied.

The service map indicates the health of each node by coloring it based on the ratio of successful calls to errors and faults:

  • Green for successful calls

  • Red for server faults (500 series errors)

  • Yellow for client errors (400 series errors)

  • Purple for throttling errors (429 Too Many Requests)

If your service map is large, use the on-screen controls or mouse to zoom in and out and move the map around.

CloudWatch console

To view the service map in the CloudWatch console

  1. Open the CloudWatch console. Choose Service map under the X-Ray Traces section in the left navigation pane.

    
                  CloudWatch console service map page
  2. Choose a service node to view requests for that node, or an edge between two nodes to view requests that traveled that connection.

  3. Additional information is displayed below the service map, including tabs for metrics, alerts, and response time distribution. On the Metrics tab, select a range within each graph to drill-down to view more detail, or choose Faults or Errors options to filter traces. On the Response time distribution tab, select a range within the graph to filter traces by response time. You can view traces at any time by choosing View traces, or if a filter has been applied, choose View filtered traces.

The service map indicates issues within each node by outlining it with colors:

  • Red for server faults (500 series errors)

  • Yellow for client errors (400 series errors)

  • Purple for throttling errors (429 Too Many Requests)

If your service map is large, use the on-screen controls or mouse to zoom in and out and move the map around.

Filtering the service map by group

Using a filter expression, you can define criteria by which to include traces within a group. Use the following steps to then display that specific group in the service map.

X-Ray console

Choose a group name from the drop-down menu to the left of the search bar.

CloudWatch console

Choose a group name from the group filter on the top-left of the service map.

The service map will now be filtered to display traces that match the filter expression of the selected group.

Service map legend and options

The service map includes a legend and several options for customizing the map display.

X-Ray console

Display the service map legend by choosing the Map legend link at the top-right of the map. Service map options can be chosen at the bottom-right of the service map, including:

  • Service Icons toggles what is displayed within each node, displaying either the service icon, or the average response time and number of traces sent per minute during the chosen time range.

  • Node sizing: None sets all nodes to the same size.

  • Node sizing: Health sizes nodes by the number of impacted requests including errors, faults, or throttled requests.

  • Node sizing: Traffic sizes nodes by the total number of requests.

CloudWatch console

Choose the Legend and options drop-down at the top-right of the map. Choose what is displayed within nodes, including:

  • Metrics displays the average response time and number of traces sent per minute during the chosen time range.

  • Nodes displays the service icon within each node.

Choose additional map settings from the Preferences pane, which can be accessed via the gear icon at the top-right of the map. These settings include selecting which metric is used to determine the size of each node, and which canaries should be displayed on the map.