全局配置

Pandora.js 设计了一套配置文件，希望能和应用的配置进行隔离，毕竟 Pandora.js 可能会在全局场景下应用，导致不一样的情况发生。

Pandora.js 设计了一套简单有效的配置覆盖机制，用户可以通过配置文件的形式，对默认的行为做一些修改。

我们通过 PANDORA_CONFIG 这个环境变量来注入配置包，这个配置包可以是一个文件，如果内容比较多，也可以是一个 npm 包，能直接 require 即可。

  1. PANDORA_CONFIG=pandora-ali pandora start .
  2. PANDORA_CONFIG=./index.js pandora start .

文件的内容只需要写覆盖的部分

通过命令行加载多配置

本质上，配置的覆盖就只是配置文件内容的覆盖，所以只需要做好分割就好。

注意：Pandora.js 使用 : 作为分隔符来分割多个路径。

  1. $ export PANDORA_CONFIG=pandora-ali:./index.js
  2. $ pandora start

默认的全局配置

该文件维护在 default.ts全局配置 - 图1.

Pandora.js 提供了一组默认的配置来保证基础脚本的运行，一般指定了几项标准的内容：

在这些key的基础上，进行覆盖，增加操作，默认配置如下，可能有变化，具体见代码详情。

下文中所有的自由变量（即没有声明来源的量，比如 DefaultEnvironment），全部可以通过 require('dorapan') 或 require('pandora') 获得。

  1. export default {
  3.   // 配置环境实现类
  4.   environment: DefaultEnvironment,
  6.   actuator: {
  8.     // RESTful 接口进行配置
  9.     http: {
  10.       enabled: true,
  11.       port: 7002, // 默认监听在 7002 端口
  12.     },
  14.     // 配置 EndPoints
  15.     endPoint: {
  17.       // 错误采集的 EndPoint
  18.       error: {
  19.         enabled: true,
  20.         target: ErrorEndPoint,
  21.         resource: ErrorResource,
  22.         initConfig: {
  23.           // 错误缓存大小，保留最近多少条错误
  24.           maxErrorCount: 100
  25.         }
  26.       },
  28.       // 健康检查的 EndPoint
  29.       health: {
  30.         enabled: true,
  31.         target: HealthEndPoint,
  32.         resource: HealthResource,
  33.         initConfig: {
  34.           // HTTP 检查
  35.           port: {
  36.             enabled: true,
  37.             checkUrl: `http://127.1:6001`
  38.           },
  39.           // 磁盘检查
  40.           disk_space: {
  41.             enabled: true,
  42.             rate: 80,
  43.           }
  44.         }
  45.       },
  47.       // 应用信息的 EndPoint
  48.       info: {
  49.         // 应用信息
  50.         enabled: true,
  51.         target: InfoEndPoint,
  52.         resource: InfoResource,
  53.       },
  55.       // 进程信息的 EndPoint
  56.       process: {
  57.         // 进程信息
  58.         enabled: true,
  59.         target: ProcessEndPoint,
  60.         resource: ProcessResource,
  61.       },
  63.       // 自定义 Metrics 的 EndPoint
  64.       metrics: {
  65.         enabled: true,
  66.         target: MetricsEndPoint,
  67.         resource: MetricsResource,
  68.         initConfig: {
  69.           collector: NormalMetricsCollector
  70.         }
  71.       },
  73.       // 链路追踪的 EndPoint
  74.       trace: {
  75.         enabled: true,
  76.         target: TraceEndPoint,
  77.         resource: TraceResource,
  78.         initConfig: {
  79.           // 缓存最近 1000 条链路
  80.           cacheSize: 1000,
  81.           // 采样率
  82.           rate: process.env.NODE_ENV !== 'production' ? 100 : 10,
  83.           // 优先级高的链路是否跳出采样率限制，比如错误的链路
  84.           priority: true 
  85.         }
  86.       }
  87.     },
  89.   },
  91.   // 数据上报 Reporter 的配置
  92.   reporter: {
  93.     file: {
  94.       enabled: true,
  95.       // 默认实现把 Metrics 日志写到 ~/logs/pandorajs/metrics
  96.       target: FileMetricsManagerReporter,
  97.       interval: 5
  98.     }
  99.   },
  101.   // 应用日志的配置
  102.   logger: {
  103.     // 日志目录
  104.     logsDir: join(homedir(), 'logs'), 
  105.     // 每个应用的日志配置，基本上就是 Stdout
  106.     appLogger: { 
  107.       // 默认不输出到 Daemon 的 Stdout，请务必不要改变这一配置
  108.       stdoutLevel: 'NONE', 
  109.       // 默认记录 Info 信息，比如应用启动停止，建议保持 INFO
  110.       level: 'INFO' 
  111.     },
  112.     // Service 的日志是否分散为单个日志文件，建议保持 false
  113.     isolatedServiceLogger: false 
  114.   }
  116. };