Topology Chart Data Structure Documentation¶

This document describes the chart fields displayed in the service relationship chart and the resource relationship chart. The examples only show the relevant fields. When integrating with a specific query API, refer to the request and response contract of that API.

For example, the Unified Catalog topology query uses an independent topology structure, so the services / serviceResource examples in this document cannot be directly applied.

Service Relationship Chart Data Structure¶

{
  "services": [
    {
      "data": {
        "__size": 10,
        "__fill": 10,
        "fieldA": "1.0",
        "fieldB": "test"
      },
      "name": "demo_web",
      "type": "web"
    },
    {
      "data": {
        "__size": 10,
        "__fill": 10,
        "fieldA": "1.0",
        "fieldB": "test"
      },
      "name": "demo_framework",
      "type": "framework"
    }
  ],
  "maps": [
    {
      "source": "demo_web",
      "target": "demo_framework"
    }
  ]
}

Field description:

Parameter	Type	Description
maps	array	List of directed edges in the topology chart
maps.source	string	Source service name
maps.target	string	Target service name
services	array	List of service nodes in the topology chart
services.name	string	Service name
services.type	string	Service type. The available service types are ["app", "framework", "cache", "message_queue", "custom", "db", "web", "aws_lambda"] Custom types can also be filled in
services.data	json	Service node data
services.data.__size	double	Value of the circle size field. This value has no range limit and is displayed adaptively based on the configured size
services.data.__fill	double	Value of the fill color field. The value range is the maximum and minimum of the configured gradient color scale
services.data.fieldA	string	Field displayed in the tooltip
services.data.fieldB	string	Field displayed in the tooltip

Resource Relationship Chart Data Structure¶

{
  "serviceResource": [
    {
      "data": {
        "__fill": 10,
        "avg_per_second_title": "AAA",
        "avg_per_second": 1,
        "p99_title": "AAA",
        "p99": 1,
        "error_rate_title": "AAA",
        "error_rate": 1
      },
      "service": "demo_web",
      "resource": "demo_web_resource",
      "source_type": "web"
    },
    {
      "data": {
        "__fill": 10,
        "avg_per_second_title": "AAA",
        "avg_per_second": 1,
        "p99_title": "AAA",
        "p99": 1,
        "error_rate_title": "AAA",
        "error_rate": 1
      },
      "service": "demo_framework",
      "resource": "demo_framework_resource",
      "source_type": "framework"
    }
  ],
  "maps": [
    {
      "source": "demo_web",
      "source_resource": "demo_web_resource",
      "target": "demo_framework",
      "target_resource": "demo_framework_resource"
    }
  ]
}

Field description:

Parameter	Type	Description
maps	array	List of directed edges in the topology chart
maps.source	string	Source service name
maps.source_resource	string	Source resource name
maps.target	string	Target service name
maps.target_resource	string	Target resource name
serviceResource	array	List of resource nodes in the topology chart
serviceResource.service	string	Service name
serviceResource.resource	string	Resource name
serviceResource.source_type	string	Resource type. The available resource types are ["app", "framework", "cache", "message_queue", "custom", "db", "web", "aws_lambda"] Custom types can also be filled in
serviceResource.data	json	Resource node data
serviceResource.data.__fill	double	Value of the fill color field. The value range is the maximum and minimum of the configured gradient color scale
serviceResource.data.avg_per_second_title	string	Title of the left field
serviceResource.data.avg_per_second	double	Value of the left field
serviceResource.data.p99_title	string	Title of the middle field
serviceResource.data.p99	double	Value of the middle field
serviceResource.data.error_rate_title	string	Title of the right field
serviceResource.data.error_rate	double	Value of the right field