服务器端 Metrics 存储扩展机制

编辑
更新时间: 2024-09-18

如果需要扩展支持适配一个新的数据存储，可能需要下面的步骤:

1.写入适配

  • 需要在 gateway/metrics/exporter/ 下面添加新的 exporter;

参考已有的 “gateway/metrics/exporter/elasticsearch” 模块；

  • 提供个新存储的 MetricExporter

功能是写入数据到存储中，参考”com.alipay.sofa.lookout.gateway.metrics.exporter.es.ESMetricExporter”，提供个新存储的 MetricExporter；

  • 提供个该模块的spring配置类

参考 “com.alipay.sofa.lookout.gateway.metrics.exporter.es.spring.bean.config.EsExporterConfiguration”，它包括 ESProperties 的配置描述映射。尤其重要的是带有注解 @ConditionalOnExporterComponent方便该功能开关；

  • 在 “com.alipay.sofa.lookout.gateway.metrics.starter.MetricPipelineConfiguration” 中 @import 上述存储spring配置类；

2.查询数据适配

  • 需要在 server/metrics 目录下，添加新 storage 扩展；

参考 “server/metrics/storage-ext-es” 模块，比如新增“storage-ext-**”

  • 提供个新的存储 Storage 实现；

参考已有 “com.alipay.sofa.lookout.server.storage.ext.es.ElasticSearchStorage”，实现Storage接口。这里也需要ES实现对应的 “QueryStmt”，”LabelValuesStmt“，”LabelNamesStmt“.

  • 提供个该模块的spring配置类

参考”com.alipay.sofa.lookout.server.storage.ext.es.spring.bean.config.ElasticSearchServerConfig”,提供 Storage的实例。 另外参考支持”@ConditionalOnProperty“的功能开关配置；

  • 在 “com.alipay.sofa.lookout.server.starter.ServerAutoConfiguration” 中 @import 上述存储spring配置类；

3.最后贡献建议

  • 提issue说明需求，并可以介绍下方案；
  • 保证测试覆盖；
  • fork 代码，编译通过后，提交 PR；