# tomcat_scan

**Repository Path**: open_source_base/tomcat_scan

## Basic Information

- **Project Name**: tomcat_scan
- **Description**: Tomcat服务器监控
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-06-01
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# tomcat_scan

#### 项目介绍
Tomcat服务器监控

#### 软件架构
软件架构说明
Tomcat 服务器监控软件
帮您自动重启无响应的 Tomcat(实际情况哦, 并非每个公司的程序都是健壮的).
后记: 推荐使用开源的Tomcat监控工具 LambdaProbe 来全面了解 Tomcat Server 状况, 再配合本站的自动重启软件, 人工+自动+定时重启, 万无一失! 截屏: http://www.lambdaprobe.org/d/screenshots.shtml
系统需求
JDK 1.4 或更高
Tomcat 4 或更高(BAT方式安装)

##### 项目编码
采用gbk格式
###以后改为utf-8
#### 安装教程

假设你要在 Windows 下开始监控, 请按照下列说明进行, 只需要记事本即可.
                                     
    1. 修改 conf/monitor.properties

    
    ######################################################
    # 监控的通用选项配置文件
    #Server Monitor Configuration File
    ######################################################
    #
    # 报警邮件接收人地址, 多人以分号隔开, 发送邮件的账户请修改 MailSender.ini
    AlertEmails=username@test.com
    # 需要探测的网页的地址
    WebPageUrl=http\://localhost\:8080/
    # 网页连接请求超时时间(单位: 毫秒)
    DefaultTimeOut=100
    # 需要重启服务器的网页连接请求超时时间(单位: 毫秒), 也就是说读取页面超过了这
    # 个时间就认为是故障了, 然后就会重启服务器
    RestartTimeOut=2000
    # 监控探测时间间隔, 单位: 分钟
    QueryTimeInternal=1
    # 定时重启的第一次执行时间(格式: HH:mm:ss), 如果为0或者空, 则设置为 00:00:00
    # 改动这个值需要重启应用才能生效
    ScheduledRestartTime=01\:00\:00
    # 定时重启时间间隔, 单位:分钟, 如果 <= 0, 则不需要定时重启
    # 默认值是3600分钟(一天), 改动这个值需要重启应用才能生效
    ScheduledRestartPeriod=3600
    
    2. 修改 conf/tomcat_windows.properties 来指定 Tomcat 安装路径等信息
    
    
    ######################################################
    # servermon.launcher.plugin.TomcatWindowsLauncher 类所使用的
    # Windows 版本的 Tomcat 配置文件
    # Laucher property file for servermon.launcher.plugin.TomcatWindowsLauncher
    ######################################################
    #
    # 服务器名称(可以任意取)
    AppServerName=Tomcat
    #服务器根目录(不含bin等路径)
    AppServerHome=F:\\share\\tomcat\\8_2
    #服务器启动脚本名称
    StartupScript=startup.bat
    #服务器关闭脚本名称
    StopScript=shutdown.bat
    #默认等待关闭时间(秒为单位),即执行StopScript后等待的时间
    ShutDownWaitTime=30
    
    3. 修改 conf/MailSender.ini 来启用邮件发送功能, 这一步可选, 不想发邮件忽略即可;
    
    4. 配置好 Tomcat BAT 方式启动所需的 JAVA_HOME 等变量, 如果已经配置好了, 忽略即可;
    
    5. 运行 AutoMonitorWithGUI.bat 开始工作, 测试第一次监控.
    TODO
    Windows 下监控 Tomcat 服务, net start tomcat, net stop tomcat??
    UML 图
    更新历史
    2007.02.10
    在主界面里加入了更改配置文件的菜单, 然后启动可视化的属性文件编辑器, 这样所有工作都可以在本软件中完成; 参考[1];
    新增定时重启功能, 可以指定第一次重启的时间以及每次重启的时间间隔.
    2006.12.17
    1. Linux 版本, 测试过的是 RedHat 9 中文版.
    
    要启用 Linux 支持, 首先记得给3个.sh文件执行权限, 自行配置好 Tomcat 的启动时候需要的 CATALINA_HOME 变量. 配置文件请关注:
    
    conf/appserverplugin.properties, 修改文件内容为:
    
    
    ######################################################
    # Tomcat 5, Linux
    # 要使用的服务器启动类
    AppServerLauncherPlugIn=servermon.launcher.plugin.TomcatLinuxLauncher
    # 使用的启动参数文件
    AppServerLauncherPlugIn.ConfigFile=tomcat_linux.properties 
    
    然后修改 conf/tomcat_linux.properties 中的文件即可, 该文件中的参数说明:
    
    
    # 服务器名称(可以任意取)
    AppServerName=Tomcat
    #服务器根目录(不含bin等路径)
    AppServerHome=/opt/tomcat-5.0.30-test
    #服务器启动脚本名称
    StartupScript=startup.sh
    #服务器关闭脚本名称
    StopScript=shutdown.sh
    #默认等待关闭时间(秒为单位),即执行StopScript后等待的时间
    ShutDownWaitTime=30
    
    2. 引入插件机制, 只要您实现 servermon.launcher.IAppServerLauncher, 即可监控各个版本的服务器. 最简单的做法可以参考代码 servermon.launcher.plugin.TomcatWindowsLauncher, 基本上只需要实现
    
    public void startServer();
    public void stopServer();
    ``

#### 使用说明
本软件每隔固定时间就监测一次给定的 Web 站点的页面是否可以访问, 如果请求超时或者失败, 就发送彩E/邮件到给定的手机/信箱(手机的话必须自行申请了手机邮箱, 例如彩E, 和普通邮箱一样发送), 进行通知, 在系统托盘区显示气泡进行警告,
并尝试根据配置的 Tomcat 服务器路径重启本机的 Tomcat 进程, 首先尝试执行 "shutdown.bat", 然后等待 30 秒后执行 "startup.bat" 完成操作.
更有定时重启的功能, 可以指定第一次重启的时间以及每次重启的时间间隔.

首先请设置要监测的内容和参数, 然后再点击按钮"开始监测"即可.
可以点击 "浏览监测日志" 查看以往监控结果.
点击 "立即监测" 可以查看当前的网页访问情况.

软件启动后, 在工具栏上点击按钮"设置"就可以修改所有的监控和邮件等参数了.
    
1. 托盘图标功能, 最小化主窗口到托盘, 便于监控同一机器上的多个 Server(需要手工复制多份主程序)
2. 定位监控的 Tomcat 目录, 使用内置 IE 浏览监控页面功能(在托盘菜单中)
3. 自动监控(用 -autostart 参数即可), 使用启动文件 "自动后台运行监控程序.bat" 可以不带 DOS 窗口启动并自动开始监控
4. 在托盘气泡中显示报警和出错信息, 便于随时掌握 Server 状态, 并根据监控状态显示不同的状态图标



#### 参与贡献

1. Fork 本项目
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request


#### 码云特技

1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5. 码云官方提供的使用手册 [http://git.mydoc.io/](http://git.mydoc.io/)
6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)