https://github.com/sofastack/sofa-dashboard-client

https://github.com/sofastack/sofa-dashboard-client

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sofastack/sofa-dashboard-client
• Owner: sofastack
• License: apache-2.0
• Created: 2019-04-23T15:21:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-07T02:39:40.000Z (about 2 years ago)
• Last Synced: 2025-03-25T08:22:28.665Z (10 months ago)
• Language: Java
• Size: 178 KB
• Stars: 16
• Watchers: 9
• Forks: 25
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SOFADashboard client

[![Build Status](https://travis-ci.com/sofastack/sofa-dashboard-client.svg?branch=master)](https://travis-ci.com/sofastack/sofa-dashboard-client)

[![Coverage Status](https://coveralls.io/repos/github/sofastack/sofa-dashboard-client/badge.svg?branch=master)](https://coveralls.io/github/sofastack/sofa-dashboard-client?branch=master)

![license](https://img.shields.io/badge/license-Apache--2.0-green.svg)

[![Maven](https://img.shields.io/github/release/sofastack/sofa-dashboard-client.svg)](https://github.com/sofastack/sofa-dashboard-client/releases)

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

## 一. 功能简介

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

![image.png](https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*n7ntQ7-iWMkAAAAAAAAAAABjARQnAQ)

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

## 二. 快速开始

### 1. 实例状态

* 通过 [SOFABoot 快速开始](https://www.sofastack.tech/sofa-boot/docs/QuickStart) 新建一个 SOFABoot 工程，

然后引入 `dashboard-sofa-boot-starter` 依赖

```xml

  com.alipay.sofa

  dashboard-client-sofa-boot-starter

  ${latest.version}

```

* 配置

```properties

# 配置应用名(required)

spring.application.name=samples-app

# http服务工作端口

server.port=8081

# 指定zookeeper工作地址

com.alipay.sofa.dashboard.zookeeper.address=127.0.0.1:2181

```

* 在 SOFADashboard 管控端查看应用注册信息

> 参考 [SOFADashboard Server 快速开始](https://www.sofastack.tech/sofa-dashboard/docs/QuickStart) 部署 SOFADashboard 服务端

![client-dashboard](https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*fEkBTJtcMzsAAAAAAAAAAABjARQnAQ)

### 2. 运行状态监控

* 在 `dashboard-sofa-boot-starter` 基础上，我们提供了应用的运行状态监控方案(需要引入一个额外的存储依赖)

```xml

  com.alipay.sofa

  dashboard-ext-redis-store

  ${latest.version}

```

* 配置

> 配置方式详细文档可以参考[spring-data-redis](https://spring.io/projects/spring-data-redis)

```properties

# 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 官方文档](https://www.sofastack.tech/sofa-dashboard/docs/Home)