fix: update dashboard api

Author: wwwzbwcom

__tests__/cls/dashboard.test.ts

@@ -36,7 +36,7 @@ describe('Cls dashboard', () => {
 
  const inputs: DeployDashboardInputs = {
  name: 'serverless-unit-test-dashboard',
- chartList: [chart1Config, chart2Config],
+ charts: [chart1Config, chart2Config],
  };
 
  let dashboardId = '';
@@ -46,7 +46,7 @@ describe('Cls dashboard', () => {
  expect(res).toEqual({
  id: expect.stringContaining('dashboard-'),
  name: inputs.name,
- chartList: expect.any(Array),
+ charts: expect.any(Array),
  });
 
  dashboardId = res.id;
@@ -60,7 +60,7 @@ describe('Cls dashboard', () => {
  createTime: expect.any(String),
  id: expect.stringContaining('dashboard-'),
  name: expect.any(String),
- chartList: expect.any(Array),
+ charts: expect.any(Array),
  });
  });
 
@@ -73,7 +73,7 @@ describe('Cls dashboard', () => {
  id: expect.stringContaining('dashboard-'),
  name: expect.any(String),
  createTime: expect.any(String),
- chartList: expect.any(Array),
+ charts: expect.any(Array),
  });
  });
 
@@ -85,7 +85,7 @@ describe('Cls dashboard', () => {
  createTime: expect.any(String),
  id: expect.stringContaining('dashboard-'),
  name: expect.any(String),
- chartList: expect.any(Array),
+ charts: expect.any(Array),
  });
  });
 

src/modules/cls/dashboard.ts

@@ -177,15 +177,15 @@ export type DeployDashChartInputs = Omit<DashboardChart, 'id'>;
 
 export interface DeployDashboardInputs {
  name: string;
- chartList: DeployDashChartInputs[];
+ charts: DeployDashChartInputs[];
 }
 
 // camelCase 的 dashboard 结构，并作了简化
 export interface Dashboard {
  createTime: string;
  id: string;
  name: string;
- chartList: DashboardChart[];
+ charts: DashboardChart[];
 }
 
 export class ClsDashboard {
@@ -213,7 +213,7 @@ export class ClsDashboard {
  createTime: CreateTime,
  name: DashboardName,
  id: DashboardId,
- chartList: parseData.panels,
+ charts: parseData.panels,
  };
 
  return dashboard;
@@ -244,7 +244,7 @@ export class ClsDashboard {
  id,
  createTime: res.CreateTime,
  name: res.DashboardName,
- chartList: rawPanels.map((v) => ({
+ charts: rawPanels.map((v) => ({
  id: v.id,
  title: v.title,
  description: v.description,
@@ -309,9 +309,9 @@ export class ClsDashboard {
 
  // 创建 dashboard
  async deploy(inputs: DeployDashboardInputs, logsetConfig: LogsetConfig) {
- const { name, chartList } = inputs;
+ const { name, charts } = inputs;
  const data = JSON.stringify({
- panels: chartList.map((v) => {
+ panels: charts.map((v) => {
  const panel: Raw.DashboardChart = {
  id: 'chart-' + uuid.v4(),
  title: v.title,
@@ -376,7 +376,7 @@ export class ClsDashboard {
  return {
  id: dashboardId,
  name,
- chartList: inputs.chartList,
+ charts: inputs.charts,
  };
  }
 }

src/modules/cls/index.ts

@@ -188,6 +188,19 @@ export default class Cls {
  }
  }
 
+ const { dashboards = [] } = inputs;
+ if (dashboards.length > 0) {
+ outputs.dashboards = [];
+ for (let i = 0; i < dashboards.length; i++) {
+ const res = await this.dashboard.deploy(dashboards[i], {
+ region: outputs.region,
+ logsetId: outputs.logsetId,
+ topicId: outputs.topicId,
+ });
+ outputs.dashboards.push(res);
+ }
+ }
+
  return outputs;
  }
 

src/modules/cls/interface.ts

@@ -1,5 +1,6 @@
 import { IndexRule } from '@tencent-sdk/cls/dist/typings';
 import { RegionType, CamelCasedProps } from './../interface';
+import { DeployDashboardInputs } from './dashboard';
 
 export interface CreateAlarmOptions {
  // 告警 ID
@@ -197,6 +198,7 @@ export interface DeployInputs extends DeployLogsetInputs, DeployTopicInputs, Dep
  name?: string;
  topic?: string;
  alarms?: AlarmInputs[];
+ dashboards?: DeployDashboardInputs[];
 }
 
 export interface DeployOutputs extends Partial<DeployInputs> {