Service maps in APM

This describes how to create, customize, and use the New Relic APM service maps feature.

Access to this feature depends on your paid subscription level [external link] .

Requirements

The ability to use service map features in New Relic APM depends on your New Relic agent version:

Feature Requirements
App visibility

For your app to appear in service maps, one of the following must be true:

Host and instance visibility

To view specific hosts, instances, and types of database information, your agent must meet the same minimum agent versions as the APM database and instance feature and use any of the compatible database drivers.

Database-only visibility

New Relic APM's service maps feature includes the ability to opt out of the deeper, host and instance level view. However, to view databases in service maps without the instance-level details, you must still meet the same minimum agent versions as the Database and slow queries features.

Create maps

The APM service maps feature helps you create your first map by providing default map or architecture suggestions that automatically build a default map (if you have more than ten reporting apps). To view these suggested maps, go to rpm.newrelic.com/apm > Service Maps > Suggested maps.

To create a new map from scratch:

  1. Go to rpm.newrelic.com/apm > Service Maps > Map list > Create new map [plus circle].

    OR

    To copy an existing map, go to rpm.newrelic.com/apm > Service Maps > (select a map) > Save as new.

  2. Name your map.
  3. Rearrange, group, or add nodes on the map as needed.

Save, rename, share maps

Use the following map functions to customize your maps:

Save
  • To save changes to a map, select Save.
  • To create a copy of the current map, select Save as new.

To preserve any changes you make to a shared map when you have read-only access, first create an editable copy of the map by selecting Save as new, and then make your changes.

Rename

To rename a map:

  1. Go to rpm.newrelic.com/apm > Service Maps > (select a map).
  2. Select the pencil [fa-pencil] icon next to the map name.
  3. Change the name, then select Save.
Share

New service maps default to private. To change your sharing settings:

  1. Go to rpm.newrelic.com/apm > Service Maps > (select a map).
  2. Select the pencil [fa-pencil] icon next to the map name.
  3. Clear the Make this map private checkbox.
  4. To share a link to the map, select its permalink.
Change owner

If you have Admin rights on the account, you can take ownership of other users' shared maps. This feature is useful when the original owner of a shared map is no longer a user on the account.

To take ownership of a shared map:

  1. Go to rpm.newrelic.com/apm > Service Maps > (select a map).
  2. Select Change owner, or select the pencil [fa-pencil] icon next to the map name.
  3. Click Yes in the confirmation dialog to take ownership of the map.

Admins can take ownership of each other's maps. When you take ownership of a map and the original owner is not an Admin on the account, the original owner will have read-only access.

Add or remove nodes on maps

After you create or save a map, build out your map by adding nodes to it. Nodes are added to the map differently based on the node type.

To remove any node from the map, mouse over the node, then select the remove X icon.

Applications, Mobile apps, plugins

Nodes for applications, mobile apps, and plugins (including databases) need to be added to the map in order to add any other nodes. Nodes are added and connected into the map as you select them. The check mark [check mark] icon means that node is already on the map.

To add New Relic monitored apps or plugins to maps:

  1. Go to rpm.newrelic.com/apm > Service Maps > (select a map) > App/Service.
  2. Select any applications from the App/Servicelist.
  3. Rearrange or group together as needed.
Browser, databases, external services, connected apps

In the New Relic UI, your out-of-process services are referred to as web external or background external data. To add Browser apps, databases, external services, or other connected apps to the map:

  1. Select an incoming or outgoing connection widget.
  2. From the list of connections, mouse over an app or service, then select the plus [plus icon] icon.
  3. Rearrange as needed.
crop-incoming-outgoing-service-maps.png
Custom nodes

To add a custom node to the map:

  1. Go to rpm.newrelic.com/apm > Service Maps > (select a map > App/Service.
  2. From the App/Service list, select Create custom node.
  3. Name the node.
  4. Add connections: Select the left (for incoming) or right (for outgoing) arrow arrow-right icons. Then select the plus plus-circle icon on your target node.
  5. Select Save.
  6. Rearrange as needed.

To add or remove custom node connections:

  1. Mouse over the custom node and select the pencil pencil icon.
  2. Select the left (for incoming) or right (for outgoing) arrow arrow-right icons.
  3. To add a connection, select the plus plus-circle icon.
  4. To remove a connection, select the minus minus-circle icon.
  5. Select Save.
crop-custom-connections-service-maps.png

Move around the map

Move around the map by panning or zooming in and out.

If you want to... Do this...
Pan the map
  • In pan arrows mode, click and drag.
  • In drag-select mode, hold the Alt key, then click and drag.
Zoom in and out In either mode, zoom in and out by scrolling the mouse wheel.
View your entire map in traffic light mode Zoom out until node details fade out and are replaced by health status colors.
Toggle the traffic light view on and off Select Views, then select Traffic light mode.
View all the nodes and their dependencies Select Discover your environment.
Drill down into more detail from a node Use standard UI functions.

Select, arrange, group nodes

Click on a node to select it and view its performance summary. You can also select multiple nodes at once, to group and ungroup them:

Select nodes

To select one node, click on the node. To select multiple nodes:

  • Click the drag-select icon to switch to drag-select mode. Click and drag the mouse to draw a square around the nodes you want to select.

    OR

  • Hold the Shift key and click on each node you want to select.
Arrange nodes

Auto-arrange cannot be undone. Consider saving a copy of your map first.

  • To arrange nodes on the map, select one or more node, then drag to a snap point on the map.
  • To automatically organize all your nodes and connections, select Auto-arrange map.
Group and ungroup nodes
If you want to... Do this...
Group nodes together on the map Select two or more nodes, then select Create group.
Name your new group Mouse over the group, then select the pencil pencil icon.
Rename an existing group Select the pencil pencil icon.
Remove nodes from a group

Select the group, then select the minus minus-circle icon for each item you want to remove.

Delete maps

To delete a map:

  1. Go to rpm.newrelic.com/apm > Service Maps > (select a map).
  2. Select the map name's pencil [fa-pencil] icon.
  3. Select Delete map.

Identify issues with external services

If your app connects to an external service that New Relic does not monitor (for example, a third-party API), New Relic watches the service for a week in order to baseline its response time. If New Relic can collect a statistically significant number of data points (more than 100), New Relic compares the current response time to this baseline and uses this to set the health status indicator:

  • square Green: Response time from the service is less than 1.75 times the baseline.
  • square Yellow: Response time from the service is longer than 1.75 times the baseline.
  • square Red: Response time from the service is longer than 2.5 times the baseline.
  • square Gray: Alerts concluded it does not have enough data to determine the health status.
  • square Purple: Alerts cannot yet conclude if it has enough data to determine the health status.

Visualize and monitor complex architectures

Use service maps to visualize and monitor complex architectures. For a tutorial introducing the latest features, select the service map's question question-circle icon.

Nodes

Nodes are the basic building blocks for your map. You can add a variety of node types including:

Node type Description
New Relic APM-monitored app Add your app to the map to view their connections to databases, Browser apps, out-of-process services, and other instrumented apps. (In the New Relic UI, your out-of-process services are also referred to as web external or background external data.)
New Relic Browser apps

Automatically detected for each app and added via the incoming connections widget. Only displays Browser apps linked to an APM app (standalone browser apps are not supported).

New Relic Mobile apps

Automatically detected and added via the app/service list panel.

Plugins, including Databases

Automatically detected for each app and added via the connections widget. Databases in service maps require the same agent versions as the new Database page features.

External services

Service maps automatically detects external services (visible in the connections widget), to track your app's external dependencies and monitor the health of those connections.

Custom nodes

Add custom nodes via the app/service list panel to include apps and services not automatically instrumented by New Relic (for example, load balancers, implementation planning, and so on).

Group nodes

A group node contains multiple other nodes. For apps, group nodes include a summarized health status indicator for all nodes in the group.

Node arrangement and grouping

Click and drag a node to move it around the map, for a customizable view of your architecture.

App nodes can also be grouped together into a single node to better organize related apps and services. Grouped nodes include summarized health status indicator for all nodes in the group. To remove items from a group, mouse over the group and select the pencil pencil icon, then select the minus minus-circle icon to remove the item from the group.

crop-service-map-app-group.png
Incoming and outgoing connections

Service maps automatically detects incoming and outgoing connections based on HTTP calls between entities. Mouse over a node to highlight the node's connections. Widgets at the end of each node display a count of that node's connections, and you can click on those widgets to add related entities to the map:

crop-incoming-outgoing-service-maps.png
View performance summary

Click on an app to view its performance over the last 30 minutes. The chart defaults to Response time, but you can view other metrics by selecting any of the available Apdex, Throughput, or Error rate links. While charts use the last 30 minutes of performance data, the service map as a whole is based on the last five minutes.

View the app in APM or Browser and view its labels by selecting the overflow ellipsis-v icon. Click the app name again to hide the summary charts, and select the overflow ellipsis-h icon again to hide other details.

crop-app-details-service-maps.png
Map list and app/service list panels

Select the Map list panel to:

  • Search for and view your maps, and access other users' shared maps.
  • Create a new map.

Select the App/Service List panel to:

Health status and performance metrics

You can see health status indicators for most nodes. Except for out-of-process services (external services or background services), entities use the health status indicators used by New Relic Alerts.

For out-of-process (external) services, the health status indicator measures the health of the connection to the external service.

View all connected apps and services

The Discover your environment feature allows you to view all of your apps, services, and dependencies together with a single click. This feature detects all connected applications and services (including externals and databases) to give you a comprehensive view of your overall software architecture environment.

To view all connected apps and services:

  1. In APM, select Service maps.
  2. From your Map list, select Discover your environment to display all of your nodes.
  3. Hover over any node to view its dependencies and how it connects to other parts of your service map. Click on individual nodes to zoom in and view their details.

The Discover your environment feature may not be available if you are using an older New Relic agent version. See Troubleshooting cross application tracing for version information. This feature may also not be available for highly complex service maps with many elements.

APM - Service maps - Show all

Service maps > Map list > Discover your environment: Select Discover your environment to view all of your nodes and their dependencies in one place.

Traffic light mode

Traffic light mode lets you view the health status of your entire architecture at a glance. This feature helps you quickly find service and app problems, even within a complex environment with many nodes. To toggle this mode, select the Views tab, then select Traffic light mode.

When traffic lights mode is On, zooming out far enough on a service map eventually causes the nodes to switch from displaying textual information, to only health status colors. Click on individual nodes to zoom in and view more details. Traffic light mode is on by default.

When traffic lights mode is Off, service map nodes retain their textual information and do not switch to health status colors, No matter how far you zoom out.

Zoom out of your service map to view in traffic lights mode

rpm.newrelic.com/apm > Service maps > Views > Traffic light mode: When traffic light mode is enabled, zooming out of your service map displays nodes in health status colors.

Midnight mode

Midnight mode inverts the screen's colors, going from a white background to a dark background. Midnight mode reduces eye strain, especially in low light environments.

To toggle this mode, select the Views tab, then select Midnight mode.

For more help

Recommendations for learning more: