トポロジー図グラフデータ構造の説明¶
本ドキュメントでは、サービス関係図とリソース関係図のグラフ表示フィールドについて説明します。例は関連フィールドのみを示しています。特定のクエリAPIを接続する際は、そのAPIのリクエストおよびレスポンスのコントラクトに従ってください。
例えば、統合カタログトポロジークエリ は独立したトポロジー構造を使用するため、本ドキュメントの services / serviceResource の例をそのまま適用することはできません。
サービス関係図のデータ構造¶
{
"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"
}
]
}
フィールドの説明:
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| maps | array | トポロジー図の有向エッジのリスト |
| maps.source | string | ソースサービス名 |
| maps.target | string | ターゲットサービス名 |
| services | array | トポロジー図のサービスノードのリスト |
| services.name | string | サービス名 |
| services.type | string | サービスタイプ。現在対応しているサービスタイプは ["app", "framework", "cache", "message_queue", "custom", "db", "web", "aws_lambda"] です。カスタムタイプも指定できます |
| services.data | json | サービスノードのデータ |
| services.data.__size | double | 円のサイズフィールドの値。この値に範囲はなく 設定されたサイズに応じて自動的に調整されて表示されます |
| services.data.__fill | double | 塗りつぶしの色フィールドの値。この値の範囲は 設定されたグラデーションカラースケールの最大値と最小値です |
| services.data.fieldA | string | tooltip に表示されるフィールド |
| services.data.fieldB | string | tooltip に表示されるフィールド |
リソース関係図のデータ構造¶
{
"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"
}
]
}
フィールドの説明:
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| maps | array | トポロジー図の有向エッジのリスト |
| maps.source | string | ソースサービス名 |
| maps.source_resource | string | ソースリソース名 |
| maps.target | string | ターゲットサービス名 |
| maps.target_resource | string | ターゲットリソース名 |
| serviceResource | array | トポロジー図のリソースノードのリスト |
| serviceResource.service | string | サービス名 |
| serviceResource.resource | string | リソース名 |
| serviceResource.source_type | string | リソースタイプ。現在対応しているリソースタイプは ["app", "framework", "cache", "message_queue", "custom", "db", "web", "aws_lambda"] です。カスタムタイプも指定できます |
| serviceResource.data | json | リソースノードのデータ |
| serviceResource.data.__fill | double | 塗りつぶしの色フィールドの値。この値の範囲は 設定されたグラデーションカラースケールの最大値と最小値です |
| serviceResource.data.avg_per_second_title | string | 左側のフィールドのタイトル |
| serviceResource.data.avg_per_second | double | 左側のフィールドの値 |
| serviceResource.data.p99_title | string | 中央のフィールドのタイトル |
| serviceResource.data.p99 | double | 中央のフィールドの値 |
| serviceResource.data.error_rate_title | string | 右側のフィールドのタイトル |
| serviceResource.data.error_rate | double | 右側のフィールドの値 |