feat: support monitor

Author: yugasun

__tests__/monitor.test.ts

@@ -0,0 +1,85 @@
+import { Monitor } from '../src';
+
+describe('Monitor', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const monitor = new Monitor(credentials, process.env.REGION);
+
+  test('get monitor data', async () => {
+    const res = await monitor.get({
+      functionName: 'serverless-unit-test',
+      metric: 'Invocation',
+    });
+
+    expect(res).toEqual({
+      StartTime: expect.any(String),
+      EndTime: expect.any(String),
+      Period: 60,
+      MetricName: 'Invocation',
+      DataPoints: [
+        {
+          Dimensions: [
+            { Name: 'functionName', Value: 'serverless-unit-test' },
+            { Name: 'namespace', Value: 'default' },
+          ],
+          Timestamps: expect.any(Array),
+          Values: expect.any(Array),
+        },
+      ],
+      RequestId: expect.any(String),
+    });
+  });
+
+  test('[inverval] get monitor data', async () => {
+    const res = await monitor.get({
+      functionName: 'serverless-unit-test',
+      metric: 'Invocation',
+      interval: 3600,
+    });
+
+    expect(res).toEqual({
+      StartTime: expect.any(String),
+      EndTime: expect.any(String),
+      Period: 60,
+      MetricName: 'Invocation',
+      DataPoints: [
+        {
+          Dimensions: [
+            { Name: 'functionName', Value: 'serverless-unit-test' },
+            { Name: 'namespace', Value: 'default' },
+          ],
+          Timestamps: expect.any(Array),
+          Values: expect.any(Array),
+        },
+      ],
+      RequestId: expect.any(String),
+    });
+  });
+  test('[period] get monitor data', async () => {
+    const res = await monitor.get({
+      functionName: 'serverless-unit-test',
+      metric: 'Invocation',
+      period: 300,
+    });
+
+    expect(res).toEqual({
+      StartTime: expect.any(String),
+      EndTime: expect.any(String),
+      Period: 300,
+      MetricName: 'Invocation',
+      DataPoints: [
+        {
+          Dimensions: [
+            { Name: 'functionName', Value: 'serverless-unit-test' },
+            { Name: 'namespace', Value: 'default' },
+          ],
+          Timestamps: expect.any(Array),
+          Values: expect.any(Array),
+        },
+      ],
+      RequestId: expect.any(String),
+    });
+  });
+});

src/index.ts

@@ -14,3 +14,4 @@ export { default as Cfs } from './modules/cfs';
 export { default as Cynosdb } from './modules/cynosdb';
 export { default as Cls } from './modules/cls';
 export { default as Clb } from './modules/clb';
+export { default as Monitor } from './modules/monitor';

src/modules/interface.ts

@@ -19,12 +19,16 @@ export enum ApiServiceType {
   cynosdb = 'cynosdb',
   /** Postgres 数据库 (Postgres) */
   postgres = 'postgres',
-  /** (VPC) */
+  /** 私有网络 (VPC) */
   vpc = 'vpc',
-  /**  */
+  /* 访问管理 （CAM）  */
   cam = 'cam',
 
+  // 负载均衡 （CLB）*/
   clb = 'clb',
+
+  // 监控 */
+  monitor = 'monitor',
 }
 
 export type RegionType = string;

src/modules/monitor/apis.ts

@@ -0,0 +1,16 @@
+import { ApiFactory } from '../../utils/api';
+import { ApiServiceType } from '../interface';
+
+const ACTIONS = ['GetMonitorData'] as const;
+
+export type ActionType = typeof ACTIONS[number];
+
+const APIS = ApiFactory({
+  debug: false,
+  isV3: true,
+  serviceType: ApiServiceType.monitor,
+  version: '2018-07-24',
+  actions: ACTIONS,
+});
+
+export default APIS;

src/modules/monitor/constants.ts

@@ -0,0 +1,85 @@
+import { Capi } from '@tencent-sdk/capi';
+// import { waitResponse } from '@ygkit/request';
+// import { ApiError } from '../../utils/error';
+import { ApiServiceType } from '../interface';
+import { GetMonitorDataInputs } from './interface';
+import APIS, { ActionType } from './apis';
+import { pascalCaseProps } from '../../utils/index';
+import { dtz, formatDate } from '../../utils/dayjs';
+import { CapiCredentials, RegionType } from '../interface';
+
+export default class Monitor {
+  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.monitor,
+      SecretId: this.credentials.SecretId!,
+      SecretKey: this.credentials.SecretKey!,
+      Token: this.credentials.Token,
+    });
+  }
+
+  async get(inputs: GetMonitorDataInputs) {
+    const {
+      metric,
+      functionName,
+      namespace = 'default',
+      alias,
+      period = 60,
+      interval = 900,
+      startTime,
+      endTime = Date.now(),
+    } = inputs;
+
+    const endDate = dtz(endTime);
+    const startDate = startTime ? dtz(startTime) : endDate.add(0 - interval, 'second');
+    const formatedStartTime = formatDate(startDate, true);
+    const formatedEndTime = formatDate(endDate, true);
+
+    const dimensions = [
+      {
+        Name: 'namespace',
+        Value: namespace,
+      },
+      {
+        Name: 'functionName',
+        Value: functionName,
+      },
+    ];
+
+    if (alias) {
+      dimensions.push({
+        Name: 'alias',
+        Value: alias,
+      });
+    }
+
+    const res = await this.request({
+      MetricName: metric,
+      Action: 'GetMonitorData',
+      Namespace: 'QCE/SCF_V2',
+      Instances: [
+        {
+          Dimensions: dimensions,
+        },
+      ],
+      Period: period,
+      StartTime: formatedStartTime,
+      EndTime: formatedEndTime,
+    });
+
+    return res;
+  }
+
+  async request({ Action, ...data }: { Action: ActionType; [key: string]: any }) {
+    const result = await APIS[Action](this.capi, pascalCaseProps(data));
+    return result;
+  }
+}

src/modules/monitor/index.ts

@@ -0,0 +1,18 @@
+export interface GetMonitorDataInputs {
+  // 指标名称，参考云函数监控指标文档：https://cloud.tencent.com/document/product/248/45130
+  metric: string;
+  // 函数名称
+  functionName: string;
+  // 命名空间
+  namespace?: string;
+  // 别名，默认流量，$LATEST
+  alias?: string;
+  // 时间间隔，单位秒，默认为 900s
+  interval?: number;
+  // 统计周期，单位秒，默认为 60s
+  period?: number;
+  // 开始时间, 格式：2018-09-22T19:51:23+08:00
+  startTime?: string;
+  // 结束时间, 格式：2018-09-22T19:51:23+08:00
+  endTime?: string;
+}

src/modules/monitor/interface.ts

@@ -12,9 +12,10 @@ const dtz = (date: ConfigType = Date.now()) => {
 };
 
 const TIME_FORMAT = 'YYYY-MM-DD HH:mm:ss';
+const TIME_FORMAT_TIMEZONE = 'YYYY-MM-DDTHH:mm:ssZ';
 
-function formatDate(date: ConfigType): string {
-  return dtz(date).format(TIME_FORMAT);
+function formatDate(date: ConfigType, withTimeout = false): string {
+  return dtz(date).format(withTimeout ? TIME_FORMAT_TIMEZONE : TIME_FORMAT);
 }
 
 export { dayjs, dtz, Dayjs, TIME_FORMAT, formatDate };