使用和扩展 EndPoint

EndPoint 是预埋在 Daemon 端的一组接收器，用于接收每个进程的 Indicator 数据，这些数据按照应用来分组。

在默认的场景下，我们会预埋一些 EndPoint，用户可以对这些东西全部自定义。

定义 EndPoint

每个 EndPoint 都包含一个 name 用于标识该 EndPoint 的唯一性，同时，由于 EndPoint 的初始化都在 Daemon 中，所以每个 EndPoint 实例都只存在唯一的一个。

一般来说，EndPoint 用户自定义概率不高，主要是 Indicator 需要埋入到业务脚本中。

每个 EndPoint 是一个 IPC 服务器，用于接收 Indicator 调用的结果，并进行汇总，最为常用的两个方法就是 invoke 和 processQueryResults，定义如下：

  1. export interface IEndPoint {
  2.   indicators: Array<IIndicator>;
  3.   group: string;
  4.   /**
  5.    * 调用名下指标
  6.    * @param appName
  7.    * @param args
  8.    */
  9.   invoke(appName: string, args?: any);
  11.   /**
  12.    * 处理查询返回结果
  13.    */
  14.   processQueryResults(results?: Array<IIndicatorResult>): any;
  15. }

在代码内部我们使用了接口来进行定义，我们对 EndPoint 增加了一个 group 字段，这样 Indicator 只要配置里这个 group，就可以上报到同一个 EndPoint 上。

定义 Indicator

每个 Indicator 是一个 IPC 客户端，可以在不同的进程中初始化，我们使用 pid 作为区分，所以一般来说，一个进程只允许一个同名的 Indicator 存在，在 cluster 模式下，Indicator 就可以以多个的形式通过同一个 group 上报给 EndPoint。

Indicator 有几个重要的字段，和 EndPoint 类似，group 表示对应连接到哪个 EndPoint，而 invoke 方法则是真正的调用执行的地方。

  1. /**
  2.  * 单个指标
  3.  */
  4. export interface IIndicator {
  5.   group: string;
  6.   invoke(data?: any, builder?: IBuilder);
  7. }

一些配置约定

不同版本的配置可能会有些增减，但是大致的配置如下：

  1. export default {
  2.   actuator: {
  3.     endPoint: {
  4.       error: {
  5.         enabled: true,
  6.         target: ErrorEndPoint,
  7.         resource: ErrorResource,
  8.         initConfig: {
  9.           maxErrorCount: 100
  10.         }
  11.       },
  12.       health: {
  13.         enabled: true,
  14.         target: HealthEndPoint,
  15.         resource: HealthResource,
  16.         initConfig: {
  17.           port: {
  18.             enabled: true,
  19.             checkUrl: `http://127.1:6001`
  20.           },
  21.           disk_space: {
  22.             enabled: true,
  23.             rate: 80,
  24.           }
  25.         }
  26.       },
  27.       process: {
  28.         enabled: true,
  29.         target: ProcessEndPoint,
  30.       },
  31.       metrics: {
  32.         enabled: true,
  33.         target: MetricsEndPoint,
  34.         resource: MetricsResource
  35.       }
  36.     },
  37.   },
  38.   ...
  39. };

每个 EndPoint 都有几个通用的配置

  • name {String} 名字，全局唯一就行
  • enabled {Boolean} 是否启用
  • target {IEndPoint} 对应的 EndPoint 类
  • resource {ActuatorResource} 对应的 Resource 类
  • initConfig {Object} 初始化配置
  1. metrics: {
  2.   enabled: true,
  3.   target: MetricsEndPoint,
  4.   resource: MetricsResource
  5. }

以上就是 EndPoint 的配置方法。