Описание
Метрический мод для Hytale
The Метрический мод Это мощная, легкая утилита, предназначенная для администраторов серверов Hytale, которые хотят получить глубокое представление о производительности и статусе своего сервера. Независимо от того, используете ли вы небольшой сервер сообщества или большую сеть, этот мод предоставляет инструменты, необходимые для мониторинга здоровья в режиме реального времени.
Команды и разрешения
Мод предоставляет несколько команд для внутриигрового мониторинга. Каждая команда требует определенного узла разрешения:
| Командование | Описание | Разрешение |
|---|---|---|
/ps |
Посмотрите статистику производительности в реальном времени, использование памяти и мировые резюме. | Метрика.command.tps |
/статус |
Краткое описание состояния сервера и количества игроков. | Метрика.command.status |
Время работы |
Отслеживайте, как долго работает ваш сервер. | Метрика.command.uptime |
Список |
Подробный список игроков с именами. | Метрика.command.list |
/metricsdebug |
Диагностика для проверки здоровья API и устранения ошибок. | Метрика.command.debug |
Ключевые особенности
- Скользящие средние: Автоматически отслеживает производительность с течением времени, обеспечивая скользящие средние для последнего 1, 5, 10 и 15 минут.
- Deep Performance Insights: Высокая точность Расчет TPS с использованием дельта-подхода, обеспечивающего точность, аналогичную внутренним инструментам.
- Память и ресурс ОтслеживаниеМониторинг в реальном времени использования памяти JVM (Used, Total, Max) и мировых показателей (сущностей и загруженных кусков).
- Сеть и Лаг МониторингОтслеживайте среднее время клещей, «длинные клещи» (спики задержки), количество подключений к сети и ошибки трафика.
- Встроенный безопасный HTTP API:
- Живой статус: Доступ к чистой конечной точке JSON
/api/статус) для интеграции вашего статуса сервера с веб-сайтами, ботами Discord или панелями мониторинга. - Корпоративная безопасность: Включает конфигурируемый Ограничение ставок, IP Blacklisting/Whitelistingи Проверка размера пакета Чтобы защитить API от злоупотреблений.
- Конфигурируемая видимость: Выберите, какая именно информация будет раскрыта (Performance, Players, Worlds, Uptime или Server Info) с помощью простых переключателей конфигурации.
- Живой статус: Доступ к чистой конечной точке JSON
- Бесшовная интеграция: Автоматически синхронизируется с базовой конфигурацией Hytale, чтобы сообщить о вашей работе. MOTD, имя сервера, Gamemode и статус Whitelist.
- Обновление CheckerИнтегрированная проверка обновлений CurseForge, поэтому у вас всегда есть последние улучшения.
️ Конфигурация
Мод полностью настраивается через Моды/MetricsMod/config.json. Вы можете легко переключать API, изменять порты, устанавливать пороги безопасности и управлять видимостью данных.
{
"apiPort": 8080,
"ApiEnabled": правда,
"RateLimitEnabled": правда,
"maxRequestsPerSecond": 50,
"WhitelistEnabled": ложный,
"Белые листы": [],
"Показать исполнение": правда,
"ShowPlayers": правда,
"ShowWorlds": правда,
"ShowUptime": правда,
"ShowNetwork": правда,
"updateCheckerEnabled": правда
?
Быстрый старт
- Бросить
MetricsMod.jarна ваш сервермодДиректория. - Запустите сервер для создания конфигурации по умолчанию.
- (необязательно) Редактировать
Моды/MetricsMod/config.jsonНастройка параметров API или правил безопасности. - Наслаждайтесь идеями в реальном времени в вашей вселенной Hytale!
Пример API
Запрос GET на /api/статус Предоставляет полный обзор:
{
"server_name": "My Hytale Server",
"Мотд": "Приключение ждет!",
"gamemode": "ADVENTURE",
"hytale_port": 30000,
"whitelist_enabled": правда,
"Игроки": {
"онлайн": 5,
"макс": 100,
"список": [{"имя": "Dralle", "uuid": "...")
?
"выступление": {
"tps": 30.0,
"tps_1m": 29,95,
"tps_5m": 29,98,
«Память»: {
"используется": 450,
Всего: 1024,
"макс": 4096,
"процент": 11,0
?
?
"Миры":
{
Название: Game_world
"сущности": 150,
"куски": 400
?
]
Время работы: 3600000
?
Показать оригинальное описание (English)
Metrics Mod for Hytale
The Metrics Mod is a powerful, lightweight utility designed for Hytale server administrators who want deep insights into their server's performance and status. Whether you're running a small community server or a large network, this mod provides the tools you need to monitor health in real-time.
🎮 Commands & Permissions
The mod provides several commands for in-game monitoring. Each command requires a specific permission node:
| Command | Description | Permission |
|---|---|---|
/tps |
View live performance stats, memory usage, and world summaries. | metrics.command.tps |
/status |
Quick summary of server health and player counts. | metrics.command.status |
/uptime |
Track exactly how long your server has been running. | metrics.command.uptime |
/list |
Detailed player list with names. | metrics.command.list |
/metricsdebug |
Diagnostics to verify API health and troubleshoot errors. | metrics.command.debug |
🚀 Key Features
- Rolling Averages: Automatically tracks performance over time, providing rolling averages for the last 1, 5, 10, and 15 minutes.
- Deep Performance Insights: High-precision TPS calculation using a delta-based approach, ensuring accuracy similar to internal tools.
- Memory & Resource Tracking: Real-time monitoring of JVM memory usage (Used, Total, Max) and world metrics (entities and loaded chunks).
- Network & Lag Monitoring: Track average tick times, "long ticks" (lag spikes), network connection counts, and traffic errors.
- Built-in Secure HTTP API:
- Live Status: Access a clean JSON endpoint (
/api/status) to integrate your server status with websites, Discord bots, or monitoring dashboards. - Enterprise-Grade Security: Includes configurable Rate Limiting, IP Blacklisting/Whitelisting, and Packet Size Validation to protect your API from abuse.
- Configurable Visibility: Choose exactly what info is exposed (Performance, Players, Worlds, Uptime, or Server Info) via simple config toggles.
- Live Status: Access a clean JSON endpoint (
- Seamless Integration: Automatically syncs with Hytale’s core configuration to report your MOTD, Server Name, Gamemode, and Whitelist status.
- Update Checker: Integrated CurseForge update checking so you always have the latest improvements.
🛠️ Configuration
The mod is fully customizable via mods/MetricsMod/config.json. You can easily toggle the API, change ports, set security thresholds, and manage data visibility.
{
"apiPort": 8080,
"apiEnabled": true,
"rateLimitEnabled": true,
"maxRequestsPerSecond": 50,
"whitelistEnabled": false,
"whitelistedIps": [],
"showPerformance": true,
"showPlayers": true,
"showWorlds": true,
"showUptime": true,
"showNetwork": true,
"updateCheckerEnabled": true
}
📦 Quick Start
- Drop
MetricsMod.jarinto your server'smodsdirectory. - Start the server to generate the default configuration.
- (Optional) Edit
mods/MetricsMod/config.jsonto customize your API settings or security rules. - Enjoy real-time insights into your Hytale universe!
📡 API Example
A GET request to /api/status provides a comprehensive overview:
{
"server_name": "My Hytale Server",
"motd": "Adventure Awaits!",
"gamemode": "ADVENTURE",
"hytale_port": 30000,
"whitelist_enabled": true,
"players": {
"online": 5,
"max": 100,
"list": [{"name": "Dralle", "uuid": "..."}]
},
"performance": {
"tps": 30.0,
"tps_1m": 29.95,
"tps_5m": 29.98,
"memory": {
"used": 450,
"total": 1024,
"max": 4096,
"percentage": 11.0
},
},
"worlds": [
{
"name": "game_world",
"entities": 150,
"chunks": 400
}
],
"uptime": 3600000
}