@cloudcare/guance-front-tools 1.0.17 → 1.0.19

package/skills/grafana-to-guance-dashboard/schemas/charts/chart-schema.json

@@ -0,0 +1,84 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/chart-schema.json",
+    "type": "object",
+    "description": "图表完整结构",
+    "title": "ChartData",
+    "required": [
+        "extend",
+        "name",
+        "pos",
+        "type",
+        "queries"
+    ],
+    "properties": {
+        "extend": {
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+                "links": {
+                    "$ref": "common/chart-links-schema.json"
+                },
+                "settings": {
+                    "$ref": "settings/settings-schema.json"
+                }
+            }
+        },
+        "group": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "oneOf": [
+                        {
+                            "type": "string",
+                            "description": "分组名称"
+                        },
+                        {
+                            "type": "null",
+                            "description": "分组名称"
+                        }
+                    ]
+                }
+            }
+        },
+        "name": {
+            "type": "string",
+            "description": "图表名称"
+        },
+        "pos": {
+            "description": "图表位置信息",
+            "type": "object",
+            "required": [
+                "h",
+                "w",
+                "x",
+                "y"
+            ],
+            "properties": {
+                "h": {
+                    "description": "图表高度,每行的高度默认为10像素,比如 h 为12, 则实际高度为 12 * 10",
+                    "type": "number"
+                },
+                "w": {
+                    "type": "number",
+                    "description": "图表宽度,栅格系统的最大列数为 24, 比如 w为12，则显示宽度则为容器宽度的 1/2 倍 "
+                },
+                "x": {
+                    "type": "number",
+                    "description": "图表距离容器的水平距离,栅格系统的最大列数为 24, 比如 x为12，则图表距离容器左边的水平距离为容器宽度 1/2 倍 "
+                },
+                "y": {
+                    "type": "number",
+                    "description": "图表距离容器垂直距离,每行的高度默认为10像素,比如 y为12, 则实际高度为 12 * 10"
+                }
+            }
+        },
+        "type": {
+            "description": "图表类型",
+            "$ref": "common/common-chart-types-schema.json"
+        },
+        "queries": {
+            "$ref": "query/queries-schema.json"
+        }
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/common/chart-link-item-schema.json

@@ -0,0 +1,48 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/common/chart-link-item-schema.json",
+    "type": "object",
+    "description": "图表联动跳转项",
+    "required": [
+        "url",
+        "open",
+        "show",
+        "type",
+        "showChanged"
+    ],
+    "properties": {
+        "url": {
+            "type": "string",
+            "description": "跳转地址"
+        },
+        "open": {
+            "type": "string",
+            "description": "打开方式",
+            "enum": [
+                "newWin",
+                "curWin",
+                "drawerWin"
+            ]
+        },
+        "show": {
+            "type": "boolean",
+            "description": "是否展示"
+        },
+        "type": {
+            "type": "string",
+            "description": "跳转类型",
+            "enum": [
+                "logging",
+                "container",
+                "processes",
+                "tracing",
+                "host",
+                "custom"
+            ]
+        },
+        "showChanged": {
+            "type": "boolean",
+            "description": "是否修改过显示状态"
+        }
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/common/chart-links-schema.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/common/chart-links-schema.json",
+    "type": "array",
+    "description": "图表跳转链接列表",
+    "items": {
+        "$ref": "chart-link-item-schema.json"
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/common/common-chart-types-schema.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/common/common-chart-types-schema.json",
+    "type": "string",
+    "title": "ChartType",
+    "description": "支持图表类型枚举",
+    "enum": [
+        "group",
+        "sequence",
+        "singlestat",
+        "pie",
+        "bar",
+        "histogram",
+        "slo",
+        "toplist",
+        "gauge",
+        "scatter",
+        "bubble",
+        "table",
+        "treemap",
+        "funnel",
+        "chinamap",
+        "worldmap",
+        "hexgon",
+        "heatmap",
+        "topology",
+        "sankey",
+        "change",
+        "log",
+        "object",
+        "monitor",
+        "alarm",
+        "text",
+        "video",
+        "picture",
+        "command",
+        "iframe"
+    ]
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/common/common-vars-item-schema.json

@@ -0,0 +1,117 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/common/common-vars-item-schema.json",
+    "title": "chartVarsItem",
+    "description": "图表视图变量完整结构",
+    "type": "object",
+    "additionalProperties": true,
+    "properties": {
+        "definition": {
+            "type": "object",
+            "properties": {
+                "tag": {
+                    "type": "string",
+                    "description": "定义 type 为 metrc 类型对应的指标 tag"
+                },
+                "field": {
+                    "type": "string",
+                    "description": "定义 type 为 metrc,object,custom_object, logging, tracing,rum,securit 类型对应的 field"
+                },
+                "value": {
+                    "type": "string",
+                    "description": "定义 type 为 dql,promql,custom_object类型对应的 dql、promql,或者以‘,’号分割的自定义字符串数据"
+                },
+                "metric": {
+                    "type": "string",
+                    "description": "1.type 为 metric 对应指标集 2. type 为 logging,rum 对应 source。"
+                },
+                "object": {
+                    "type": "string",
+                    "description": "type 为 object, custom_object 对应对象 source"
+                },
+                "defaultVal": {
+                    "description": "视图变量默认填充值",
+                    "type": "object",
+                    "properties": {
+                        "label": {
+                            "type": "string",
+                            "description": "默认填充值 label，如果没有则和 value 保持一致"
+                        },
+                        "value": {
+                            "type": "string",
+                            "description": "默认填充值 value"
+                        }
+                    }
+                }
+            }
+        },
+        "type": {
+            "description": "视图变量查询类型，对应关系分别为 QUERY:【DQL】,PROMQL_QUERY:【PROMQL】,TAG:【指标】,FIELD:【基础对象】,FIELD:【自定义对象】,LOGGING:【日志】,TRACING:【应用性能】,RUM:【用户访问】,SECURITY:【安全巡检】,CUSTOM_LIST:【自定义】",
+            "type": "string",
+            "enum": [
+                "QUERY",
+                "PROMQL_QUERY",
+                "FIELD",
+                "TAG",
+                "LOGGING",
+                "TRACING",
+                "RUM",
+                "SECURITY",
+                "CUSTOM_LIST"
+            ]
+        },
+        "code": {
+            "type": "string",
+            "description": "需要被替换的变量名"
+        },
+        "datasource": {
+            "type": "string",
+            "enum": [
+                "dataflux",
+                "ftinfluxdb",
+                "custom",
+                "object",
+                "custom_object"
+            ],
+            "description": "对应关系分别为 dataflux:【DQL】,dataflux:【PROMQL】,ftinfluxdb:【指标】,object:【基础对象】,custom_object:【自定义对象】,dataflux:【日志】,dataflux:【应用性能】,dataflux:【用户访问】,dataflux:【安全巡检】,custom:【自定义】"
+        },
+        "name": {
+            "type": "string",
+            "description": "视图变量显示名称"
+        },
+        "seq": {
+            "type": "integer",
+            "description": "当前项视图变量在列表中的顺序",
+            "examples": [
+                0,
+                1,
+                2
+            ]
+        },
+        "hide": {
+            "type": "integer",
+            "description": "是否隐藏该项视图变量",
+            "enum": [
+                0,
+                1
+            ]
+        },
+        "multiple": {
+            "type": "boolean",
+            "description": "设置视图变量是否能多选",
+            "default": true
+        },
+        "includeStar": {
+            "type": "boolean",
+            "description": "设置视图变量列出值是否包含 * "
+        },
+        "valueSort": {
+            "type": "string",
+            "description": "列出值排序",
+            "enum": [
+                "asc",
+                "desc"
+            ]
+        }
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/common/common-vars-schema.json

@@ -0,0 +1,10 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/common/common-vars-schema.json",
+    "type": "array",
+    "title": "chartVarsSettings",
+    "description": "图表视图变量列表结构",
+    "items": {
+        "$ref": "common-vars-item-schema.json"
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/dashboard-schema.json

@@ -0,0 +1,80 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/dashboard-schema.json",
+    "type": "object",
+    "title": "DashboardData",
+    "description": "观测云仪表板完整结构",
+    "additionalProperties": true,
+    "properties": {
+        "title": {
+            "type": "string",
+            "description": "仪表板标题"
+        },
+        "main": {
+            "type": "object",
+            "description": "仪表板图表结构",
+            "properties": {
+                "vars": {
+                    "$ref": "common/common-vars-schema.json"
+                },
+                "charts": {
+                    "type": "array",
+                    "description": "图表合集配置",
+                    "items": {
+                        "$ref": "chart-schema.json"
+                    }
+                },
+                "groups": {
+                    "type": "array",
+                    "description": "分组配置",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "type": "string",
+                                "description": "图表分组名称"
+                            },
+                            "extend": {
+                                "type": "object",
+                                "description": "分组的额外配置，比如背景颜色",
+                                "properties": {
+                                    "bgColor": {
+                                        "type": "string",
+                                        "description": "分组块的背景颜色"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "type": {
+                    "description": "仪表板主体类型，现有数据中常缺省，存在时固定为 template",
+                    "anyOf": [
+                        {
+                            "type": "string",
+                            "const": "template"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                }
+            }
+        },
+        "dashboardExtend": {
+            "description": "仪表板额外配置信息",
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+                "groupUnfoldStatus": {
+                    "type": "object",
+                    "description": "分组是否收起打开配置信息,图表名称为 key， value 为 boolean。 false 为关闭，true 为打开",
+                    "additionalProperties": {
+                        "type": "boolean",
+                        "description": "图表名称"
+                    }
+                }
+            }
+        }
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/query/queries-schema.json

@@ -0,0 +1,10 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/query/queries-schema.json",
+    "type": "array",
+    "title": "ChartQueries",
+    "description": "图表查询语句列表结构",
+    "items": {
+        "$ref": "query-item-schema.json"
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/query/query-item-schema.json

@@ -0,0 +1,60 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/query/query-item-schema.json",
+    "type": "object",
+    "description": "图表查询语句结构",
+    "title": "ChartQueryItem",
+    "properties": {
+        "type": {
+            "description": "冗余字段，图表类型",
+            "$ref": "../common/common-chart-types-schema.json"
+        },
+        "datasource": {
+            "type": "string",
+            "description": "冗余字段,固定值",
+            "const": "dataflux"
+        },
+        "qtype": {
+            "type": "string",
+            "description": "查询语句类型，目前支持 dql 以及promql",
+            "enum": [
+                "dql",
+                "promql"
+            ]
+        },
+        "query": {
+            "type": "object",
+            "description": "查询语句的额外信息",
+            "additionalProperties": true,
+            "properties": {
+                "q": {
+                    "type": "string",
+                    "description": "图表查询语句，可以是 dql语句，也可以是 promql 语句"
+                },
+                "content": {
+                    "type": "string",
+                    "description": "文本图内容，支持 HTML 或 Markdown 文本"
+                },
+                "code": {
+                    "type": "string",
+                    "description": "查询语句的唯一标识，由单个大写英文字母构成"
+                },
+                "type": {
+                    "type": "string",
+                    "description": "查询语句类型冗余字段，实际数据中可能是 promql/dql，也可能是 default/simple 这类查询模式",
+                    "enum": [
+                        "default",
+                        "simple",
+                        "dql",
+                        "promql"
+                    ]
+                },
+                "promqlCode": {
+                    "type": "integer",
+                    "description": "PromQL 查询顺序编号"
+                }
+            }
+        }
+    },
+    "additionalProperties": true
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-connect-null-schema.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-connect-null-schema.json",
+    "title": "CommonChartConnectNullSettings",
+    "type": "boolean",
+    "default": true
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-gradual-color-schema.json

@@ -0,0 +1,72 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-gradual-color-schema.json",
+    "title": "CommonGradualColorSettings",
+    "description": "热力图配置信息",
+    "type": "object",
+    "properties": {
+        "gradualColor": {
+            "description": "颜色匹配设置",
+            "type": "object",
+            "required": [
+                "type",
+                "colorKey",
+                "levelCount"
+            ],
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "enum": [
+                        "auto",
+                        "custom"
+                    ],
+                    "description": "颜色匹配设置模式，可以根据颜色色系，自动匹配数值对应色块"
+                },
+                "colorKey": {
+                    "type": "string",
+                    "description": "提供选择的色系",
+                    "enum": [
+                        "interpolateYlOrBr",
+                        "interpolateBuPu",
+                        "interpolatePuBu",
+                        "interpolateBuGn"
+                    ]
+                },
+                "minVal": {
+                    "description": "在自动模式下，可以手动设置区间范围最小值",
+                    "type": "integer"
+                },
+                "maxVal": {
+                    "description": "在自动模式下，可以手动设置的区间范围最大值",
+                    "type": "integer"
+                },
+                "levelCount": {
+                    "type": "integer",
+                    "description": "在渐变区间发范围内，可以手动填写生成的色块数量"
+                },
+                "levels": {
+                    "type": "array",
+                    "description": "自定义模式下，设置的区间映射列表",
+                    "items": {
+                        "type": "object",
+                        "required": [
+                            "color"
+                        ],
+                        "properties": {
+                            "min": {
+                                "description": "自定义区间块最小值"
+                            },
+                            "max": {
+                                "description": "自定义区间块最大值"
+                            },
+                            "color": {
+                                "description": "自定义区间块颜色色值"
+                            }
+                        }
+                    }
+                }
+            },
+            "additionalProperties": false
+        }
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-groupby-schema.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-groupby-schema.json",
+    "title": "CommonChartGroupbySettings",
+    "type": "object",
+    "description": "图表分组排序相关配置",
+    "properties": {
+        "slimit": {
+            "type": "integer",
+            "description": "当分组存在时，最大显示分组数量"
+        },
+        "sorderByOrder": {
+            "type": "string",
+            "description": "当分组存在时，分组返回的排序",
+            "enum": [
+                "asc",
+                "desc"
+            ],
+            "default": "desc"
+        }
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-legend-position-schema.json

@@ -0,0 +1,14 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-legend-position-schema.json",
+    "title": "CommonChartLegendPositionSettings",
+    "type": "string",
+    "description": "图表图列位置显示配置信息",
+    "enum": [
+        "none",
+        "bottom",
+        "right",
+        "circle"
+    ],
+    "default": "none"
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-legend-values-schema.json

@@ -0,0 +1,19 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-legend-values-schema.json",
+    "title": "CommonChartLegendValuesSettings",
+    "type": "array",
+    "items": {
+        "type": "string",
+        "description": "图表图列需要显示的统计指标",
+        "enum": [
+            "first",
+            "last",
+            "avg",
+            "min",
+            "max",
+            "sum",
+            "count"
+        ]
+    }
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-open-stack-schema.json

@@ -0,0 +1,8 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-open-stack-schema.json",
+    "title": "CommonChartOpenStackSettings",
+    "type": "boolean",
+    "description": "柱状图是否开启堆叠模式",
+    "default": false
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-show-label-schema.json

@@ -0,0 +1,8 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-show-label-schema.json",
+    "title": "CommonChartShowLabelSettings",
+    "type": "boolean",
+    "description": "柱状图是否显示，每个柱对应的 value 值",
+    "default": false
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-show-line-schema.json

@@ -0,0 +1,8 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-show-line-schema.json",
+    "title": "CommonChartShowLineSettings",
+    "type": "boolean",
+    "description": "是否开启混合图模式，柱状图或者概览图可以开启该选项。",
+    "default": false
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-stack-content-schema.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-stack-content-schema.json",
+    "title": "CommonChartStackContentSettings",
+    "type": "string",
+    "description": "柱状图堆叠模式下，横坐标显示类型",
+    "enum": [
+        "group",
+        "index"
+    ],
+    "default": "group"
+}

package/skills/grafana-to-guance-dashboard/schemas/charts/settings/_common-settings-stack-type-schema.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "charts/settings/_common-settings-stack-type-schema.json",
+    "title": "CommonChartStackTypeSettings",
+    "type": "string",
+    "description": "柱状图堆叠模式",
+    "enum": [
+        "time",
+        "percent"
+    ]
+}