SOFADashboard client

Build Status Coverage Status license Maven

SOFADashboard client 用于向 SOFADashboard 服务端注册 IP、端口、健康检查状态等应用基本信息。

一. 功能简介

SOFADashboard client 并非是直接通过 API 调用的方式将自身应用信息直接注册到 SOFADashboard 服务端 ,而是借助于 Zookeeper 来完成。

image.png

客户端向 Zookeeper 中如上图所示的节点中写入数据,每一个 ip:port 节点代表一个应用实例,应用本身信息将写入当前节点的 data 中。

二. 快速开始

1. 实例状态

<dependency>
  <groupId>com.alipay.sofa</groupId>
  <artifactId>dashboard-sofa-boot-starter</artifactId>
  <version>${latest.version}</version>
</dependency>
# 配置应用名(required)
spring.application.name=samples-app

# http服务工作端口
server.port=8081
# 指定zookeeper工作地址
com.alipay.sofa.dashboard.zookeeper.address=127.0.0.1:2181

参考 SOFADashboard Server 快速开始 部署 SOFADashboard 服务端

client-dashboard

2. 运行状态监控

<dependencies>
  <groupId>com.alipay.sofa</groupId>
  <artifactId>dashboard-ext-redis-store</artifactId>
  <version>${latest.version}</version>
</dependencies>

配置方式详细文档可以参考spring-data-redis

# single mode
com.alipay.sofa.dashboard.redis.host=127.0.0.1
com.alipay.sofa.dashboard.redis.port=6379

# cluster mode
com.alipay.sofa.dashboard.redis.cluster.nodes=127.0.0.1:9001,127.0.0.1:9002,127.0.0.1:9003

示例

SOFADashboard client 的编译环境的要求为 JDK8,需要采用 Apache Maven 3.2.5 或者更高的版本进行编译。

文档

请参考 SOFADashboard 官方文档