客户端快速开始

普通 Java 项目

在应用中加入 client 的 Maven 依赖

  1. <dependency>
  2. <groupId>com.alipay.sofa.lookout</groupId>
  3. <artifactId>lookout-client</artifactId>
  4. <version>${lookout.client.version}</version>
  5. </dependency>

lookout-client 默认依赖了 lookout-reg-server 模块(支持向 lookout server 上报 metrics 数据),如果希望使用其他类型注册表(比如 lookout-reg-prometheus),那么再加上对应依赖即可。

开始使用 SOFALookout 的 Client 之前,首先需要构建一个全局的客户端实例( com.alipay.lookout.client.DefaultLookoutClient

  1. LookoutConfig lookoutConfig = new LookoutConfig();
  2. DefaultLookoutClient client = new DefaultLookoutClient("appName");
  3. //选择构建需要使用的 Registry(如果多个注册表类型,建议使用同一 lookoutConfig 实例,便于集中管理)
  4. LookoutRegistry lookoutRegistry = new LookoutRegistry(lookoutConfig);
  5. //客户端可以后置添加 registry 实例(至少要加一个)
  6. client.addRegistry(lookoutRegistry);
  7. //(可选)对已加入或后续加入的客户端的 registry 实例,统一注册扩展模块的 metrics
  8. client.registerExtendedMetrics();

然后通过客户端拿取 Registry 实例,进行使用:

  1. //该注册表是个“组合”型的注册表
  2. Registry registry = client.getRegistry();
  3. //demo
  4. Id id = registry.createId("http_requests_total");
  5. Counter counter = registry.counter(id);
  6. counter.inc();

客户端的使用,可以详细参考样例工程