Service Map Widget

Service Map Widget

This widget displays a map of a service to all of the services that call it, and all of the services that it calls. The node in the center of the widget represents the mapped service. Services that call the mapped service are shown to the left with arrows from the caller to the service. Services that the service calls are displayed to the right, with arrows in the direction of calls.

The service map widget does not respond to time scoping and always shows services that made calls in the preceding two weeks. Metrics are calculated for each services in real time for the previous hour.

Setup

Configuration

  1. Choose your environment scope, primary tag (or *) if it is set up for your account, and service name.
  2. Enter a title for your graph.

Results

Nodes are sized relative to one another based on the request rate. The circumference of a node is colored based on monitor status - green for OK, yellow for warn, red for alert, and grey if there’s no data.

Services connected to the mapped service are sorted outwards from the middle by request rate. The five services with the highest requests are shown with labels by default. Additionally, any service with a monitor in alert state always has a label.

API

This widget can be used with the Dashboards API. See the Dashboards API documentation for additional reference.

The dedicated widget JSON schema definition for the service map widget is:

Expand All

Field

Type

Description

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

filters [required]

[string]

Your environment and primary tag (or * if enabled for your account).

service [required]

string

The ID of the service you want to map.

title

string

The title of your widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the service map widget. Allowed enum values: servicemap

{
  "custom_links": [
    {
      "is_hidden": false,
      "label": "Search logs for {{host}}",
      "link": "https://app.datadoghq.com/logs?query={{host}}",
      "override_label": "logs"
    }
  ],
  "filters": [
    "*"
  ],
  "service": "",
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "servicemap"
}

Further Reading

Additional helpful documentation, links, and articles: