Service Map

edit

A service map is a real-time visual representation of the instrumented services in your application’s architecture. It shows you how these services are connected, along with high-level metrics like average transaction duration, requests per minute, and errors per minute. If enabled, service maps also integrate with machine learning—​for real time health indicators based on anomaly detection scores. All of these features can help you quickly and visually assess your services' status and health.

Example view of service maps in the APM app in Kibana

We currently surface two types of service maps:

  • Global: All services instrumented with APM agents and the connections between them are shown.
  • Service-specific: Highlight connections for a selected service.

How do service maps work?

edit

Service Maps rely on distributed traces to draw connections between services. As distributed tracing is enabled out-of-the-box for supported technologies, so are service maps. However, if a service isn’t instrumented, or a traceparent header isn’t being propagated to it, distributed tracing will not work, and the connection will not be drawn on the map.

Visualize your architecture

edit

Select the Service Map tab to get started. By default, all instrumented services and connections are shown. Whether you’re onboarding a new engineer, or just trying to grasp the big picture, drag things around, zoom in and out, and begin to visualize how your services are connected.

Customize what the service map displays using either the query bar or the environment selector. The query bar enables you to use advanced queries to customize the service map based on your needs. The environment selector allows you to narrow displayed results to a specific environment. This can be useful if you have two or more services, in separate environments, but with the same name. Use the environment drop-down to only see the data you’re interested in, like dev or production.

If there’s a specific service that interests you, select that service to highlight its connections. Clicking Focus map will refocus the map on that specific service and lock the connection highlighting. From here, select Service Details, or click on the Transaction tab to jump to the Transaction overview for the selected service. You can also use the tabs at the top of the page to easily jump to the Errors or Metrics overview.

Example view of service maps in the APM app in Kibana

Anomaly detection with machine learning

edit

Machine learning jobs can be created to calculate anomaly scores on APM transaction durations within the selected service. When these jobs are active, service maps will display a color-coded anomaly indicator based on the detected anomaly score:

APM green service

Max anomaly score ≤25. Service is healthy.

APM yellow service

Max anomaly score 26-74. Anomalous activity detected. Service may be degraded.

APM red service

Max anomaly score ≥75. Anomalous activity detected. Service is unhealthy.

Example view of anomaly scores on service maps in the APM app

If an anomaly has been detected, click view anomalies to view the anomaly detection metric viewer in the Machine learning app. This time series analysis will display additional details on the severity and time of the detected anomalies.

To learn how to create a machine learning job, see machine learning integration.

Legend

edit

Nodes appear on the map in one of two shapes:

  • Circle: Instrumented services. Interior icons are based on the language of the APM agent used.
  • Diamond: Databases, external, and messaging. Interior icons represent the generic type, with specific icons for known entities, like Elasticsearch. Type and subtype are based on span.type, and span.subtype.

Supported APM agents

edit

Service Maps are supported for the following APM agent versions:

Go agent

≥ v1.7.0

iOS agent

Not yet supported

Java agent

≥ v1.13.0

.NET agent

≥ v1.3.0

Node.js agent

≥ v3.6.0

PHP agent

≥ v1.2.0

Python agent

≥ v5.5.0

Ruby agent

≥ v3.6.0

Real User Monitoring (RUM) agent

≥ v4.7.0