{"id":18621263,"url":"https://github.com/sofastack/sofa-dashboard-client","last_synced_at":"2025-04-11T02:31:39.195Z","repository":{"id":43866604,"uuid":"183042936","full_name":"sofastack/sofa-dashboard-client","owner":"sofastack","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-07T02:39:40.000Z","size":182,"stargazers_count":16,"open_issues_count":12,"forks_count":25,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-25T08:22:28.665Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sofastack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-23T15:21:28.000Z","updated_at":"2023-12-08T00:56:20.000Z","dependencies_parsed_at":"2024-06-20T00:15:14.300Z","dependency_job_id":"58eb1308-edb6-41a0-b341-49fe4e8cfa7a","html_url":"https://github.com/sofastack/sofa-dashboard-client","commit_stats":null,"previous_names":["alipay/sofa-dashboard-client"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-dashboard-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-dashboard-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-dashboard-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-dashboard-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sofastack","download_url":"https://codeload.github.com/sofastack/sofa-dashboard-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248329596,"owners_count":21085565,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T04:10:06.138Z","updated_at":"2025-04-11T02:31:34.180Z","avatar_url":"https://github.com/sofastack.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SOFADashboard client\n\n[![Build Status](https://travis-ci.com/sofastack/sofa-dashboard-client.svg?branch=master)](https://travis-ci.com/sofastack/sofa-dashboard-client)\n[![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)\n![license](https://img.shields.io/badge/license-Apache--2.0-green.svg)\n[![Maven](https://img.shields.io/github/release/sofastack/sofa-dashboard-client.svg)](https://github.com/sofastack/sofa-dashboard-client/releases)\n\nSOFADashboard client 用于向 SOFADashboard 服务端注册 IP、端口、健康检查状态等应用基本信息。\n\n## 一. 功能简介\n\nSOFADashboard client 并非是直接通过 API 调用的方式将自身应用信息直接注册到 SOFADashboard 服务端 ，而是借助于 Zookeeper 来完成。\n\n![image.png](https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*n7ntQ7-iWMkAAAAAAAAAAABjARQnAQ)\n\n客户端向 Zookeeper 中如上图所示的节点中写入数据，每一个 ip:port 节点代表一个应用实例，应用本身信息将写入当前节点的 data 中。\n\n## 二. 快速开始\n\n### 1. 实例状态\n\n* 通过 [SOFABoot 快速开始](https://www.sofastack.tech/sofa-boot/docs/QuickStart) 新建一个 SOFABoot 工程，\n然后引入 `dashboard-sofa-boot-starter` 依赖\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.alipay.sofa\u003c/groupId\u003e\n  \u003cartifactId\u003edashboard-client-sofa-boot-starter\u003c/artifactId\u003e\n  \u003cversion\u003e${latest.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n* 配置\n\n```properties\n# 配置应用名(required)\nspring.application.name=samples-app\n\n# http服务工作端口\nserver.port=8081\n# 指定zookeeper工作地址\ncom.alipay.sofa.dashboard.zookeeper.address=127.0.0.1:2181\n```\n\n* 在 SOFADashboard 管控端查看应用注册信息\n\n\u003e 参考 [SOFADashboard Server 快速开始](https://www.sofastack.tech/sofa-dashboard/docs/QuickStart) 部署 SOFADashboard 服务端\n\n![client-dashboard](https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*fEkBTJtcMzsAAAAAAAAAAABjARQnAQ)\n\n### 2. 运行状态监控\n\n* 在 `dashboard-sofa-boot-starter` 基础上，我们提供了应用的运行状态监控方案(需要引入一个额外的存储依赖)\n\n```xml\n\u003cdependencies\u003e\n  \u003cgroupId\u003ecom.alipay.sofa\u003c/groupId\u003e\n  \u003cartifactId\u003edashboard-ext-redis-store\u003c/artifactId\u003e\n  \u003cversion\u003e${latest.version}\u003c/version\u003e\n\u003c/dependencies\u003e\n```\n\n* 配置\n\n\u003e 配置方式详细文档可以参考[spring-data-redis](https://spring.io/projects/spring-data-redis)\n\n```properties\n# single mode\ncom.alipay.sofa.dashboard.redis.host=127.0.0.1\ncom.alipay.sofa.dashboard.redis.port=6379\n\n# cluster mode\ncom.alipay.sofa.dashboard.redis.cluster.nodes=127.0.0.1:9001,127.0.0.1:9002,127.0.0.1:9003\n```\n\n## 示例\n\nSOFADashboard client 的编译环境的要求为 JDK8，需要采用 Apache Maven 3.2.5 或者更高的版本进行编译。\n\n## 文档\n\n请参考 [SOFADashboard 官方文档](https://www.sofastack.tech/sofa-dashboard/docs/Home)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsofastack%2Fsofa-dashboard-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsofastack%2Fsofa-dashboard-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsofastack%2Fsofa-dashboard-client/lists"}