# Monitor-Dog

**Repository Path**: OrangeNull/serverManage

## Basic Information

- **Project Name**: Monitor-Dog
- **Description**: Java开源服务器监控框架，采用netty搭建，使用protobuf协议，起名监视狗
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 8
- **Created**: 2019-11-25
- **Last Updated**: 2025-08-19

## Categories & Tags

**Categories**: nms

**Tags**: None

## README

# Monitor-Dog

#### 介绍

Java开源服务器监控框架，采用netty搭建，使用protobuf协议,减少客户端通信开销，起名监视狗

#### 项目特性
- 支持自己加入客户端与服务端的业务逻辑
- 支持protobuf与json的转换
- 客户端与心跳服务端保持心跳连接
- 心跳服务端采用SpringBoot，方便加入业务
- 加入TCP请求的路由转发，采用注解即可轻松完成一个TCP请求的控制层

#### 功能列表

- [x] 1 在线查看客户端的JVM堆栈信息、服务器内存信息
- [x] 2 支持计算客户端与服务端的ping时间
- [x] 3 服务器加入了tcp路由请求框架，可自己加入业务逻辑,采用注解扫描方式

#### 注意事项
- 客户端和服务端的心跳连接有秘钥验证，秘钥验证在manage.properties下配置，如果不对则无法连接
- 先启动netty-manage-server下的ServerBootStrap类
- 再启动netty-manage-client下的ClientBootStrap类（client的Name在manage.properties下配置）
- 最后打开serverWeb下的index.html


#### 软件架构

 - 后端技术
 
    | 技术   |      名称      |   |
    |:----------|:-------------|:------|
    | Netty | 通信框架|  |
    | SpringBoot | 容器框架|  |
    | Log4j | 日志框架|  |
    | protobuf | 传输协议框架|  |
    | oshi | 服务器信息框架|  |



#### 运行环境

* JDK 1.8 + 
* Maven 3.3.9 +
* SpringBoot 2.0.8 +
* Netty 4.1.25

#### IDEA 开发环境
#### 模块说明

| 模块   |      描述      |  备注 |
|:----------|:-------------|:------|
| netty-manage-common|通用组件|包含protobuf协议和oshi采集服务器信息|
| netty-manage-client|客户端|进行心跳连接和推送服务器信息|
| netty-manage-server|心跳服务端||
| serverWeb|前端展示页面|  |

#### TCP路由控制器demo图

| | | 
|:----------|:-------------|
|![demo图](doc/image/demo.png)


#### 效果图

| | | 
|:----------|:-------------|
|![效果图](doc/image/xg.png)


#### 关于
  本项目完全开源，商用完全免费。