Compare commits

...

16 Commits

Author SHA1 Message Date
sa 4927bdf019 Update version code 2026-06-08 20:50:54 +08:00
sa 5d2e13db0c fix: updates.rb 处理 Gitee raw URL 302 重定向 2026-06-08 20:31:50 +08:00
sa d494093850 fix: 全面修复5个逻辑问题 2026-06-08 20:21:47 +08:00
sa 5668d6589f Oh my watchdog. 2026-06-08 20:10:58 +08:00
sa 41ef365e25 Adding a heartbeat, avoiding dying cause of one failure. 2026-06-08 19:43:17 +08:00
sa bb3374b5cc Fix ai's doc 2026-06-08 13:55:55 +08:00
sa 28581ea3fd Fix ai's doc 2026-06-08 13:50:07 +08:00
sa 8e46739550 update version serial code 2026-06-08 13:37:07 +08:00
sa 13c4c19add fixed try-times <!> = try-times+1 bug 2026-06-08 13:36:22 +08:00
sa c234b76e78 Fixed bugs. 2026-06-08 13:28:49 +08:00
sa bac58cf3d5 fix: 修复版本号获取 CORS 跨域报错,改用 Gitee API v5 2026-06-08 12:29:53 +08:00
sa 4e71ad293a refactor: 版本号不再硬编码,动态从 APP_VERSIONS_LIST 拉取;所有链接 master → dev 2026-06-08 12:26:45 +08:00
sa 5dabf26fe3 update version code 2026-06-08 12:19:48 +08:00
sa b2baee05ef update version code and update info 2026-06-08 12:19:05 +08:00
sa c22feaaf1d update version serial code 2026-06-08 12:13:37 +08:00
sa 83acd3049b tidy the file tree 2026-06-08 12:09:53 +08:00
13 changed files with 121 additions and 83 deletions
+7 -1
View File
@@ -1,2 +1,8 @@
b43527c
60176fa
60176fa
8cd942b
83acd30
b2baee0
13c4c19
5668d65
d494093
+6 -6
View File
@@ -9,23 +9,23 @@ Minecraft 服务器守护进程
[![License](https://img.shields.io/badge/License-MulanPubL--2.0-orange.svg)](http://license.coscl.org.cn/MulanPubL-2.0)
[![Ruby](https://img.shields.io/badge/Ruby-%3E%3D3.0-cc342d?logo=ruby)](https://www.ruby-lang.org)
[![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20Windows-blue)](#跨场景适配指南)
[![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20Windows-blue)](docs/DEPLOY.md#跨场景适配指南)
## 快速开始
```bash
# 复制文件
mkdir -p /opt/minecraft/sentinel
cp main.rb method_executor.rb server_status_detector.rb systemd_notifier.rb config.rb updates.rb /opt/minecraft/sentinel/
mkdir -p /opt/minecraft/sentinel/src
cp src/main.rb src/method_executor.rb src/server_status_detector.rb src/systemd_notifier.rb src/config.rb src/updates.rb /opt/minecraft/sentinel/src/
# 安装 systemd 服务
cp minesentinel.service /etc/systemd/system/
cp src/minesentinel.service /etc/systemd/system/
systemctl daemon-reload
systemctl enable minesentinel
systemctl start minesentinel
# 手动运行(调试用)
cd /opt/minecraft/sentinel
cd /opt/minecraft/sentinel/src
ruby main.rb
```
@@ -68,7 +68,7 @@ MineSentinel 通过 `Before=minecraft.service` 确保先于 MC 启动,避免 M
## 完整文档
参见 [DEPLOY.md](DEPLOY.md) 或 [官网](OfficialWebsite/index.html)。
参见 [DEPLOY.md](docs/DEPLOY.md) 或 [官网](static/index.html)。
## 许可证
+20 -19
View File
@@ -20,12 +20,13 @@ MineSentinel 是一个 Minecraft 服务器守护进程,每 1.5 秒检测服务
```
/opt/minecraft/sentinel/ # 推荐部署目录
── main.rb # 主程序入口 —— 检测循环 + 冷却期 + 初始宽限期
├── method_executor.rb # 日志系统 + 重启逻辑 + 重试计数器
├── server_status_detector.rb # TCP 端口检测模块
├── systemd_notifier.rb # systemd watchdog 心跳发送
├── config.rb # 可调参数配置
└── updates.rb # 更新检查模块
── src/ # 源码目录
├── main.rb # 主程序入口 —— 检测循环 + 冷却期 + 初始宽限期
├── method_executor.rb # 日志系统 + 重启逻辑 + 重试计数器
├── server_status_detector.rb # TCP 端口检测模块
├── systemd_notifier.rb # systemd watchdog 心跳发送
├── config.rb # 可调参数配置
└── updates.rb # 更新检查模块
minesentinel.service # systemd 单元文件(项目源码中)
```
@@ -37,8 +38,8 @@ minesentinel.service # systemd 单元文件(项目源码中)
### 1. 创建目录并复制文件
```bash
mkdir -p /opt/minecraft/sentinel
cp main.rb method_executor.rb server_status_detector.rb systemd_notifier.rb config.rb updates.rb /opt/minecraft/sentinel/
mkdir -p /opt/minecraft/sentinel/src
cp src/main.rb src/method_executor.rb src/server_status_detector.rb src/systemd_notifier.rb src/config.rb src/updates.rb /opt/minecraft/sentinel/src/
```
### 2. 确认 Minecraft systemd 服务存在
@@ -52,7 +53,7 @@ systemctl status minecraft
### 3. 手动测试
```bash
cd /opt/minecraft/sentinel
cd /opt/minecraft/sentinel/src
ruby main.rb
# 调试模式:LOG_LEVEL=debug ruby main.rb
```
@@ -62,7 +63,7 @@ ruby main.rb
项目源码中已提供 `minesentinel.service`,直接复制:
```bash
cp minesentinel.service /etc/systemd/system/
cp src/minesentinel.service /etc/systemd/system/
```
单元文件内容(`minesentinel.service`):
@@ -76,8 +77,8 @@ Wants=minecraft.service
[Service]
Type=simple
WorkingDirectory=/opt/minecraft/sentinel
ExecStart=/usr/bin/ruby /opt/minecraft/sentinel/main.rb
WorkingDirectory=/opt/minecraft/sentinel/src
ExecStart=/usr/bin/ruby /opt/minecraft/sentinel/src/main.rb
Restart=always
RestartSec=10
StandardOutput=journal
@@ -135,10 +136,10 @@ MineSentinel 启动:
| 参数 | 文件 | 行 | 默认值 |
|------|------|-----|--------|
| 初始宽限期 | `config.rb` | 1 | `300` s |
| 冷却期 | `config.rb` | 3 | `200` s |
| 尝试次数 | `config.rb` | 2 | `3` 次 |
| 检测间隔 | `config.rb` | 4 | `1.5` s |
| 初始宽限期 | `config.rb` | 18 | `300` s |
| 冷却期 | `config.rb` | 22 | `200` s |
| 尝试次数 | `config.rb` | 20 | `3` 次 |
| 检测间隔 | `config.rb` | 24 | `1.5` s |
| systemctl 超时 | `method_executor.rb` | 17 | `30` s |
| 最大重试 | `method_executor.rb` | 23 | `10` 次 |
| 检测端口 | `server_status_detector.rb` | 60 | `25565` |
@@ -203,8 +204,8 @@ pid = spawn "cmd /c start /B java -Xmx4G -jar C:\\mc\\server.jar nogui"
```ruby
# server_status_detector.rb 第 60 行
res = test_port('192.168.1.100', 3306) # MySQL
res = test_port('127.0.0.1', 80) # Nginx
res = ServerStatusDetector::TcpServer.test_port('192.168.1.100', 3306) # MySQL
res = ServerStatusDetector::TcpServer.test_port('127.0.0.1', 80) # Nginx
```
配合修改 `method_executor.rb` 中的重启命令即可适配。
@@ -221,4 +222,4 @@ res = test_port('127.0.0.1', 80) # Nginx
## 许可证
MineSentinel 源码采用 [木兰宽松许可证 v2](http://license.coscl.org.cn/MulanPubL-2.0)。品牌标识(Logo / 项目名称)保留所有权利,未经许可不得用于衍生项目。
MineSentinel 源码采用 [木兰公共许可证 v2](http://license.coscl.org.cn/MulanPubL-2.0)。品牌标识(Logo / 项目名称)保留所有权利,未经许可不得用于衍生项目。
View File
+18 -14
View File
@@ -44,7 +44,7 @@ def main
begin
upd_result = UpdateManager.check
if upd_result[:status] == :NewerAvailable
if upd_result[:type] == :NewerAvailable
MethodExecutor.record('info', 'updates',
"Update #{upd_result[:version]} available, please check the git repo for details.")
end
@@ -59,6 +59,7 @@ def main
grace_deadline = Time.now + INITIAL_GRACE
while Time.now < grace_deadline
sleep 5
SystemdNotifier.notify('WATCHDOG=1')
next unless ServerStatusDetector::MinecraftServer.self_diag[:type]
MethodExecutor.record('info', 'mainloop',
@@ -74,32 +75,35 @@ end
# rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
def main_once
chkrslts = []
(0..TRY_TIMES).each do
(0...TRY_TIMES).each do
chkrslt = ServerStatusDetector::MinecraftServer.self_diag
chkrslts.append(chkrslt)
sleep 0.5 unless chkrslt[:type] # 只在失败时等待后再重试
end
if chkrslts.all? { |chkrslt_in| chkrslt_in[:type] }
MethodExecutor.record('debug', 'mainloop', 'Server health check passed.')
MethodExecutor.reset_rst_counter
else
chkrslts.each do |result|
MethodExecutor.record('warn', 'mainloop', "Server health check FAILED: #{result[:message]}")
end
MethodExecutor.record('info', 'mainloop', "Checked #{TRY_TIMES} time.")
if chkrslts.any? { |chkrslt_in| chkrslt_in[:operation].include?('Record') }
if chkrslts.any? { |chkrslt_in| (chkrslt_in[:operation] || []).include?('Record') }
MethodExecutor.record('warn', 'mainloop', 'Action: Record -> Server died!')
if chkrslts.any? { |chkrslt_in| chkrslt_in[:message] == 'Server died for unknown reason, and will be restarted.' }
if chkrslts.any? { |chkrslt_in| (chkrslt_in[:operation] || []).include?('ForceResetServerProcess') }
MethodExecutor.record('info', 'mainloop', 'Action: ForceResetServerProcess triggered.')
MethodExecutor.reset_minecraft_server
# 重启后等待服务器启动(MC服务器启动通常需要30秒~2分钟)
cooldown_beg = Time.now
MethodExecutor.record('info', 'mainloop', "Cooling down #{RST_COOLDOWN_DURATION}s for server startup...")
# rubocop:disable Metrics/BlockNesting
while Time.now < cooldown_beg + RST_COOLDOWN_DURATION
sleep 1
SystemdNotifier.notify('WATCHDOG=1')
if MethodExecutor.reset_minecraft_server
# 重启后等待服务器启动(MC服务器启动通常需要30秒~2分钟)
cooldown_beg = Time.now
MethodExecutor.record('info', 'mainloop', "Cooling down #{RST_COOLDOWN_DURATION}s for server startup...")
# rubocop:disable Metrics/BlockNesting
while Time.now < cooldown_beg + RST_COOLDOWN_DURATION
sleep 1
SystemdNotifier.notify('WATCHDOG=1')
end
# rubocop:enable Metrics/BlockNesting
MethodExecutor.record('info', 'mainloop', 'Cooldown finished, resuming monitoring.')
end
# rubocop:enable Metrics/BlockNesting
MethodExecutor.record('info', 'mainloop', 'Cooldown finished, resuming monitoring.')
end
end
end
+10 -4
View File
@@ -66,13 +66,13 @@ class MethodExecutor
# rubocop:enable Metrics/MethodLength
# rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
# @return [void]
# @return [Boolean] true if a restart was attempted, false if recovered from idle
def self.reset_minecraft_server
record('info', 'reset', "Attempt ##{@@rst_counter + 1} to reset Minecraft server.")
if @@rst_counter >= RST_COUNTS_LIMIT
record('error', 'reset',
"Tried #{RST_COUNTS_LIMIT} times and failed, now I'll idle until server is manually restarted.")
"Tried #{RST_COUNTS_LIMIT} times and failed, now I'll idle until server is manually recovered.")
loop do
sleep 10
SystemdNotifier.notify('WATCHDOG=1') if defined?(SystemdNotifier)
@@ -80,7 +80,7 @@ class MethodExecutor
record('info', 'reset', 'Server recovered! Resuming normal monitoring.')
@@rst_counter = 0
return
return false
end
end
@@ -106,7 +106,6 @@ class MethodExecutor
elapsed = (Time.now - tick_beg).round(2)
if status.success?
record('info', 'reset', "'systemctl restart' succeeded in #{elapsed}s.")
@@rst_counter = 0 # 成功时重置计数器
else
record('error', 'reset',
"'systemctl restart' failed with exitcode #{status.exitstatus} after #{elapsed}s.")
@@ -128,6 +127,13 @@ class MethodExecutor
end
# rubocop:enable Metrics/BlockLength
end
true
end
# Resets the restart counter when server health check passes.
# @return [void]
def self.reset_rst_counter
@@rst_counter = 0
end
# rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
# rubocop:enable Style/ClassVars
@@ -13,8 +13,8 @@ Wants=minecraft.service
[Service]
Type=simple
WorkingDirectory=/opt/minecraft/sentinel
ExecStart=/usr/bin/ruby /opt/minecraft/sentinel/main.rb
WorkingDirectory=/opt/minecraft/sentinel/src
ExecStart=/usr/bin/ruby /opt/minecraft/sentinel/src/main.rb
Restart=always
RestartSec=10
StandardOutput=journal
@@ -24,7 +24,7 @@ module ServerStatusDetector
# @param port [Integer]
# @param timeout [Integer]
# @return [Hash{Symbol=>Integer, Symbol=>Symbol, Symbol=>Float,nil}]
def self.test_port(host = '127.0.0.1', port = 25_565, timeout = 10)
def self.test_port(host = '127.0.0.1', port = 25_565, timeout = 2)
result = {
port: port,
status: :unknown,
@@ -61,7 +61,7 @@ module ServerStatusDetector
class MinecraftServer < TcpServer
# rubocop:disable Metrics/MethodLength
# @return [Hash{Symbol=>Boolean, Symbol=>Array<String>, Symbol=>String}]
def self_diag
def self.self_diag
res = test_port('127.0.0.1', 25_565)
unless res[:error].nil?
@@ -17,6 +17,7 @@
# Sends keep-alive notifications (including WATCHDOG=1) to systemd
# via the NOTIFY_SOCKET datagram socket, enabling service supervision.
class SystemdNotifier
require 'socket'
require_relative 'method_executor'
@@ -38,7 +39,7 @@ class SystemdNotifier
end
# @return [Boolean]
def enabled?
def self.enabled?
@enable_heartbeat
end
@@ -52,7 +53,6 @@ class SystemdNotifier
MethodExecutor.record('debug', 'heartbeat', "Heartbeat sent: #{message}")
rescue StandardError => e
MethodExecutor.record('error', 'heartbeat', "Failed to send heartbeat: #{e}")
@enable_heartbeat = false
end
end
end
+20 -12
View File
@@ -18,28 +18,35 @@ require 'net/http'
require 'uri'
# @type const RELEASE_SERIAL_CODE: String
RELEASE_SERIAL_CODE = '60176fa'
RELEASE_SERIAL_CODE = 'd494093'
# @type const CHANNEL: String
CHANNEL = 'master'
CHANNEL = 'dev'
# @type const VERSION_LIST_URL: String
VERSION_LIST_URL = "https://raw.giteeusercontent.com/scu_team/minesentinel/#{CHANNEL}/APP_VERSIONS_LIST"
VERSION_LIST_URL = "https://gitee.com/SCU_team/mine-sentinel/raw/#{CHANNEL}/APP_VERSIONS_LIST"
# @type const RECURSIVE_RETRY_DEPTH: Integer
RECURSIVE_RETRY_DEPTH = 3
class UpdateManager
# rubocop:disable Metrics/MethodLength
# @return [String]
# @return [String, nil]
def self.fetch
MethodExecutor.record('debug', 'updates', "Fetching version list from #{VERSION_LIST_URL}")
uri = URI(VERSION_LIST_URL)
response = Net::HTTP.get_response(uri)
case response.code.to_i
when 200
MethodExecutor.record('debug', 'updates', 'Version list fetched successfully.')
response.body
else
raise "Unexpected HTTP response code: #{response.code}"
5.times do # 跟随重定向(Gitee raw URL → raw.giteeusercontent.com
response = Net::HTTP.get_response(uri)
case response.code.to_i
when 200
MethodExecutor.record('debug', 'updates', 'Version list fetched successfully.')
return response.body
when 301, 302, 307, 308
uri = URI(response['location'])
MethodExecutor.record('debug', 'updates', "Following redirect to #{uri}")
next
else
raise "Unexpected HTTP response code: #{response.code}"
end
end
raise 'Too many redirects'
rescue StandardError => e
MethodExecutor.record('error', 'updates', "Failed to fetch version list: #{e}")
nil
@@ -65,7 +72,8 @@ class UpdateManager
end
latest = lines.last
MethodExecutor.record('info', 'updates', "Newer version #{latest} available (current: #{RELEASE_SERIAL_CODE}).")
MethodExecutor.record('info', 'updates',
"Newer version #{latest} available (current: #{RELEASE_SERIAL_CODE}), use git to update.")
{ type: :NewerAvailable, version: latest }
end
# rubocop:enable Metrics/MethodLength
@@ -3,7 +3,7 @@ name = "MineSentinel"
description = "Minecraft 服务器智能守护进程,TCP 端口检测 + 崩溃自动重启 + 防循环冷却期"
repo_url = "https://gitee.com/snoware/minesentinel"
demo_url = "https://swe-iss.rth1.xyz/softwares/minesentinel"
doc_url = "https://gitee.com/snoware/minesentinel/blob/master/DEPLOY.md"
doc_url = "https://gitee.com/snoware/minesentinel/blob/dev/docs/DEPLOY.md"
tags = ["Ruby", "Minecraft", "Server", "Monitoring", "Daemon", "SNOWARE"]
[[projects]]
File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB