Skip to content

Topology Diagram Data Structure Explanation¶

Service Relationship Diagram¶

{
  "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 Name	Type	Description
maps	arrary	List of directed edges for the topology diagram
maps.source	string	Source service name
maps.target	string	Target service name
services	arrary	List of service nodes for the topology diagram
services.name	string	Service name
services.type	string	Service type. Current available service types are ["app", "framework", "cache", "message_queue", "custom", "db", "web", "aws_lambda"] Custom types can also be entered
services.data	json	Service node data
services.data.__size	double	Value for the circle size field. This value has no range and is displayed adaptively according to the set size
services.data.__fill	double	Value for the fill color field. The range of this value is the maximum and minimum of the set gradient color scheme
services.data.fieldA	string	Field displayed in the tooltip
services.data.fieldB	string	Field displayed in the tooltip

Resource Relationship Diagram¶

{
  "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 Name	Type	Description
maps	arrary	List of directed edges for the topology diagram
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	arrary	List of resource nodes for the topology diagram
serviceResource.service	string	Service name
serviceResource.resource	string	Resource name
serviceResource.source_type	string	Resource type. Current available resource types are ["app", "framework", "cache", "message_queue", "custom", "db", "web", "aws_lambda"] Custom types can also be entered
serviceResource.data	json	Resource node data
serviceResource.data.__fill	double	Value for the fill color field. The range of this value is the maximum and minimum of the set gradient color scheme
serviceResource.data.avg_per_second_title	string	Title for the left field
serviceResource.data.avg_per_second	double	Value for the left field
serviceResource.data.p99_title	string	Title for the middle field
serviceResource.data.p99	double	Value for the middle field
serviceResource.data.error_rate_title	string	Title for the right field
serviceResource.data.error_rate	double	Value for the right field