com.alipay.sofa:sofa-dashboard-client

SOFADashboard Client

License	The Apache License, Version 2.0
Categories	CLI User Interface
GroupId	com.alipay.sofa
ArtifactId	sofa-dashboard-client
Last Version	1.0.0
Release Date	May 23, 2019
Type	jar
Description	com.alipay.sofa:sofa-dashboard-client SOFADashboard Client
Project URL	https://github.com/sofastack/sofa-dashboard-client
Source Code Management	http://github.com/alipay/sofa-dashboard-client/tree/master

Download sofa-dashboard-client

Filename	Size
sofa-dashboard-client-1.0.0.pom
sofa-dashboard-client-1.0.0.jar	21 KB
sofa-dashboard-client-1.0.0-sources.jar	19 KB
sofa-dashboard-client-1.0.0-javadoc.jar	119 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.alipay.sofa/sofa-dashboard-client/ -->
<dependency>
    <groupId>com.alipay.sofa</groupId>
    <artifactId>sofa-dashboard-client</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.alipay.sofa/sofa-dashboard-client/
implementation 'com.alipay.sofa:sofa-dashboard-client:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.alipay.sofa/sofa-dashboard-client/
implementation ("com.alipay.sofa:sofa-dashboard-client:1.0.0")

Apache Buildr

'com.alipay.sofa:sofa-dashboard-client:jar:1.0.0'

Apache Ivy

<dependency org="com.alipay.sofa" name="sofa-dashboard-client" rev="1.0.0">
  <artifact name="sofa-dashboard-client" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.alipay.sofa', module='sofa-dashboard-client', version='1.0.0')
)

Scala SBT

libraryDependencies += "com.alipay.sofa" % "sofa-dashboard-client" % "1.0.0"

Leiningen

[com.alipay.sofa/sofa-dashboard-client "1.0.0"]

Dependencies

compile (4)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter	jar	2.0.3.RELEASE
com.alipay.sofa : healthcheck-sofa-boot-starter	jar	3.0.0
com.alibaba : fastjson	jar	1.2.47
org.springframework.boot : spring-boot-autoconfigure-processor Optional	jar	2.0.3.RELEASE

provided (2)

Group / Artifact	Type	Version
org.apache.curator : curator-framework	jar	2.9.1
org.apache.curator : curator-recipes	jar	2.9.1

test (7)

Group / Artifact	Type	Version
org.jmockit : jmockit	jar	1.14
org.mockito : mockito-core	jar	2.15.0
org.jmockit : jmockit-coverage	jar	1.14
junit : junit	jar	4.12
org.springframework.boot : spring-boot-starter-web	jar	2.0.3.RELEASE
org.springframework.boot : spring-boot-starter-test	jar	2.0.3.RELEASE
org.apache.curator : curator-test	jar	2.9.1

Project Modules

There are no modules declared in this project.

SOFADashboard client

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

一. 功能简介

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

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

二. 快速开始

1. 实例状态

• 通过 SOFABoot 快速开始 新建一个 SOFABoot 工程， 然后引入 dashboard-sofa-boot-starter 依赖

<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 管控端查看应用注册信息

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

2. 运行状态监控

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

<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 官方文档

Alipay

Ant Group Open Source

Versions

Version
1.0.0 May 23, 2019