feat(cls): support alarm and notice

Author: yugasun

.env.example

@@ -22,4 +22,7 @@ CFS_VPC_ID=vpc-xxx
 CFS_SUBNET_ID=subnet-xxx
 
 # apigw OAUTH PUBLIC_KEY
-API_PUBLIC_KEY=
+API_PUBLIC_KEY=
+
+# CLS 通知用户 ID
+NOTICE_UIN=

__tests__/cls/alarm.test.ts

@@ -0,0 +1,62 @@
+import { CreateAlarmOptions, CreateAlarmResult } from '../../src/modules/cls/interface';
+import { ClsAlarm } from '../../src';
+
+describe('Cls Alarm', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const client = new ClsAlarm(credentials, process.env.REGION);
+
+  let detail: CreateAlarmResult;
+
+  const options: CreateAlarmOptions = {
+    name: 'serverless-unit-test',
+    logsetId: '5e822560-4cae-4037-9ec0-a02f8774446f',
+    topicId: '6e60b6c7-a98e-4fc8-8ba8-bdfe4ab9c245',
+    targets: [
+      {
+        period: 15,
+        query: 'level:error | select count(*) as errCount',
+      },
+      {
+        period: 10,
+        query: 'level:error | select count(*) as errCount',
+      },
+    ],
+    monitor: {
+      type: 'Period',
+      time: 1,
+    },
+    trigger: {
+      condition: '$1.count > 1',
+      count: 2,
+      period: 15,
+    },
+    noticeId: 'notice-4271ef11-1b09-459f-8dd1-b0a411757663',
+  };
+
+  test('create', async () => {
+    const res = await client.create(options);
+    expect(res).toEqual({
+      ...options,
+      id: expect.stringContaining('alarm-'),
+    });
+
+    detail = res;
+  });
+
+  test('update', async () => {
+    const res = await client.create(detail);
+    expect(res).toEqual({
+      ...options,
+      id: expect.stringContaining('alarm-'),
+    });
+  });
+
+  test('delete', async () => {
+    await client.delete({ id: detail.id! });
+    const res = await client.get({ id: detail.id });
+    expect(res).toBeNull();
+  });
+});

__tests__/cls/cls.test.ts

@@ -1,4 +1,4 @@
-import { ClsDeployInputs, ClsDeployOutputs } from '../../src/modules/cls/interface';
+import { DeployInputs, DeployOutputs } from '../../src/modules/cls/interface';
 import { Scf } from '../../src';
 import { Cls } from '../../src';
 import { sleep } from '@ygkit/request';
@@ -11,9 +11,9 @@ describe('Cls', () => {
   const scf = new Scf(credentials, process.env.REGION);
   const client = new Cls(credentials, process.env.REGION);
 
-  let outputs: ClsDeployOutputs;
+  let outputs: DeployOutputs;
 
-  const inputs: ClsDeployInputs = {
+  const inputs: DeployInputs = {
     region: 'ap-guangzhou',
     name: 'cls-test',
     topic: 'cls-topic-test',

__tests__/cls/notice.test.ts

@@ -0,0 +1,64 @@
+import { CreateNoticeOptions, CreateNoticeResult } from '../../src/modules/cls/interface';
+import { ClsNotice } from '../../src';
+
+describe('Cls Alarm', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const client = new ClsNotice(credentials, process.env.REGION);
+
+  let detail: CreateNoticeResult;
+
+  const options: CreateNoticeOptions = {
+    name: 'serverless-unit-test',
+    type: 'All',
+    receivers: [
+      {
+        start: '00:00:00',
+        end: '23:59:59',
+        type: 'Uin',
+        ids: [Number(process.env.NOTICE_UIN)],
+        channels: ['Email', 'Sms', 'WeChat', 'Phone'],
+      },
+    ],
+    webCallbacks: [
+      {
+        type: 'WeCom',
+        url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx',
+        body: '【腾讯云】日志服务CLS监控告警\n您好，您账号（账号UIN：{{.UIN}}，昵称：{{.User}}）下的日志服务告警策略（策略ID：{{.AlarmId}}，策略名：{{.AlarmName}}）触发告警：\n监控对象：{{.TopicName}}\n触发条件：持续满足条件{{.Condition}}达{{.ConsecutiveAlertNums}}次\n触发时间：最近于{{.TriggerTime}}发现异常\n您可以登录腾讯云日志服务控制台查看。',
+      },
+      {
+        type: 'Http',
+        headers: ['Content-Type: application/json'],
+        method: 'POST',
+        url: 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx',
+        body: '{\n  "UIN":"{{.UIN}}",\n  "User":"{{.User}}}",\n  "AlarmID":"{{.AlarmID}}",\n  "AlarmName":"{{.AlarmName}}",\n  "TopicName":"{{.TopicName}}",\n  "Condition":"{{.Condition}}",\n  "TriggerTime":"{{.TriggerTime}}"\n}',
+      },
+    ],
+  };
+
+  test('create', async () => {
+    const res = await client.create(options);
+    expect(res).toEqual({
+      ...options,
+      id: expect.stringContaining('notice-'),
+    });
+
+    detail = res;
+  });
+
+  test('update', async () => {
+    const res = await client.create(detail);
+    expect(res).toEqual({
+      ...options,
+      id: expect.stringContaining('notice-'),
+    });
+  });
+
+  test('delete', async () => {
+    await client.delete({ id: detail.id! });
+    const res = await client.get({ id: detail.id });
+    expect(res).toBeNull();
+  });
+});

package.json

@@ -87,6 +87,7 @@
     "@types/jest": "^26.0.20",
     "@types/node": "^14.14.31",
     "@ygkit/request": "^0.1.8",
+    "camelcase": "^6.2.0",
     "cos-nodejs-sdk-v5": "^2.9.20",
     "dayjs": "^1.10.4",
     "moment": "^2.29.1",

src/index.ts

@@ -13,6 +13,8 @@ export { default as Layer } from './modules/layer';
 export { default as Cfs } from './modules/cfs';
 export { default as Cynosdb } from './modules/cynosdb';
 export { default as Cls } from './modules/cls';
+export { default as ClsAlarm } from './modules/cls/alarm';
+export { default as ClsNotice } from './modules/cls/notice';
 export { default as Clb } from './modules/clb';
 export { default as Monitor } from './modules/monitor';
 export { default as Account } from './modules/account';

src/modules/cls/alarm.ts

@@ -0,0 +1,123 @@
+import { Capi } from '@tencent-sdk/capi';
+import { CreateAlarmOptions, AlarmInfo, AlarmDetail } from './interface';
+import APIS, { ActionType } from './apis';
+import { pascalCaseProps, camelCaseProps } from '../../utils';
+import { ApiError } from '../../utils/error';
+import { ApiServiceType, CapiCredentials, RegionType } from '../interface';
+import { formatAlarmOptions } from './utils';
+
+export default class Alarm {
+  credentials: CapiCredentials;
+  capi: Capi;
+  region: RegionType;
+
+  constructor(credentials: CapiCredentials, region: RegionType = 'ap-guangzhou') {
+    this.credentials = credentials;
+    this.region = region;
+
+    this.capi = new Capi({
+      Region: region,
+      ServiceType: ApiServiceType.cls,
+      SecretId: this.credentials.SecretId!,
+      SecretKey: this.credentials.SecretKey!,
+      Token: this.credentials.Token,
+    });
+  }
+
+  /**
+   * 获取告警详情
+   * @param options 告警 id 或者 name
+   * @returns 告警详情
+   */
+  async get({ id, name }: { id?: string; name?: string }): Promise<AlarmDetail | null> {
+    if (!id && !name) {
+      throw new ApiError({
+        type: 'PARAMETER_ERROR',
+        message: `Alarm id or name is required`,
+      });
+    }
+    let filter = {
+      Key: 'name',
+      Values: [name],
+    };
+    if (id) {
+      filter = {
+        Key: 'alarmId',
+        Values: [id],
+      };
+    }
+    const { Alarms = [] }: { Alarms: AlarmInfo[] } = await this.request({
+      Action: 'DescribeAlarms',
+      Filters: [filter],
+      Offset: 0,
+      Limit: 100,
+    });
+    const detail = Alarms.find((alarm) => alarm.Name === name || alarm.AlarmId === id);
+    if (detail) {
+      return camelCaseProps(detail as AlarmInfo);
+    }
+    return null;
+  }
+
+  async create(options: CreateAlarmOptions): Promise<CreateAlarmOptions & { id: string }> {
+    const detail = await this.get({ name: options.name });
+    const alarmOptions = formatAlarmOptions(options);
+    let id = '';
+    if (detail) {
+      id = detail.alarmId;
+      await this.request({
+        Action: 'ModifyAlarm',
+        AlarmId: id,
+        ...alarmOptions,
+      });
+    } else {
+      const { AlarmId } = await this.request({
+        Action: 'CreateAlarm',
+        ...alarmOptions,
+      });
+      id = AlarmId;
+    }
+
+    return {
+      ...options,
+      id,
+    };
+  }
+
+  async delete({ id, name }: { id?: string; name?: string }) {
+    if (!id && !name) {
+      throw new ApiError({
+        type: 'PARAMETER_ERROR',
+        message: `Alarm id or name is required`,
+      });
+    }
+    if (id) {
+      const detail = await this.get({ id });
+      if (detail) {
+        await this.request({
+          Action: 'DeleteAlarm',
+          AlarmId: id,
+        });
+      } else {
+        console.log(`Alarm ${id} not exist`);
+      }
+    }
+    if (name) {
+      const detail = await this.get({ name });
+      if (detail) {
+        await this.request({
+          Action: 'DeleteAlarm',
+          AlarmId: detail.alarmId,
+        });
+      } else {
+        console.log(`Alarm ${name} not exist`);
+      }
+    }
+    return true;
+  }
+
+  async request({ Action, ...data }: { Action: ActionType; [key: string]: any }) {
+    const result = await APIS[Action](this.capi, pascalCaseProps(data));
+    return result;
+  }
+}

src/modules/cls/apis.ts

@@ -0,0 +1,25 @@
+import { ApiFactory } from '../../utils/api';
+import { ApiServiceType } from '../interface';
+
+const ACTIONS = [
+  'CreateAlarm',
+  'ModifyAlarm',
+  'DescribeAlarms',
+  'DeleteAlarm',
+  'CreateAlarmNotice',
+  'ModifyAlarmNotice',
+  'DeleteAlarmNotice',
+  'DescribeAlarmNotices',
+] as const;
+
+export type ActionType = typeof ACTIONS[number];
+
+const APIS = ApiFactory({
+  debug: false,
+  isV3: true,
+  serviceType: ApiServiceType.cls,
+  version: '2020-10-16',
+  actions: ACTIONS,
+});
+
+export default APIS;