Topology Map Widget

The Topology Map widget displays a visualization of data sources and their relationships to help understand how data flows through your architecture.

Setup

Configuration

  1. Choose the data to graph:

    • Service Map: The node in the center of the widget represents the mapped service. Services that call the mapped service are shown with arrows from the caller to the service. To learn more about the Service Map, reference the Service Map feature of APM.

  2. Enter a title for your graph.

API

This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:

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.

requests [required]

[object]

One or more Topology requests.

query

object

Query to service-based topology data sources like the service map or data streams.

data_source

enum

Name of the data source Allowed enum values: data_streams,service_map

filters

[string]

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

service

string

Name of the service

request_type

enum

Widget request type. Allowed enum values: topology

title

string

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 topology map widget. Allowed enum values: topology_map

default: topology_map

{
  "custom_links": [
    {
      "is_hidden": false,
      "label": "Search logs for {{host}}",
      "link": "https://app.datadoghq.com/logs?query={{host}}",
      "override_label": "logs"
    }
  ],
  "requests": [
    {
      "query": {
        "data_source": "string",
        "filters": [
          "env:prod",
          "az:us-east"
        ],
        "service": "myService"
      },
      "request_type": "string"
    }
  ],
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "topology_map"
}

Further Reading

Additional helpful documentation, links, and articles:

Building Dashboards using JSONDOCUMENTATION more more Service MapDOCUMENTATION more more
PREVIEWING: peoplenarthax/test-health-page