五管理记录器

五管理记录器

Hytale的通用日志记录器。支持Grafana Loki、磁盘和Fivemanage。

图书馆

Fivemanage Logger - Hytale 服务器日志记录与分析

Hytale 专用服务器的终极日志记录解决方案。跟踪玩家活动,监控服务器事件,并将日志发送到 Fivemanage、Grafana Loki 或本地文件。

为什么要使用 Fivemanage Logger?

  • 跟踪一切 — 玩家加入、断开连接、破坏方块和自定义事件
  • 多后端支持 — 将日志发送到 Fivemanage、Grafana Loki 或本地文件
  • 为性能而生 — 异步批量日志记录,对服务器 TPS 零影响
  • 易于设置 — 即用型 JAR 文件,简单的 JSON 配置,开箱即用

功能

功能 描述
多提供商支持 Fivemanage、Grafana Loki、基于文件的日志记录
批量日志记录 可配置的缓冲区大小和刷新间隔
玩家事件跟踪 自动记录连接、断开连接、就绪事件
方块事件跟踪 跟踪玩家何时破坏方块
双重日志记录 同时写入磁盘和发送到远程提供商
丰富的元数据 将自定义元数据附加到所有日志条目

安装

  1. 从 Releases 下载最新版本
  2. 将 .jar 文件放入 Hytale 服务器的 mods 目录
  3. 在 mods/Fivemanage_Logger/config.json 创建配置文件

快速入门

Fivemanage Cloud

{
  "LogProvider": {
    "Provider": "fivemanage",
    "ApiKey": "your-fivemanage-api-key",
    "WriteToDisk": false,
    "EnableBatching": true,
    "BufferSize": 10,
    "FlushIntervalMs": 5000
  },
  "PlayerEvents": {
    "Dataset": "player-events",
    "Enabled": true
  }
}

从 fivemanage.com 获取您的 API 密钥。

Grafana Loki / Grafana Cloud

{
  "LogProvider": {
    "Provider": "grafana-loki",
    "Endpoint": "https://logs-prod-us-central1.grafana.net",
    "Username": "your-grafana-username",
    "Password": "your-grafana-api-key",
    "WriteToDisk": false,
    "EnableBatching": true,
    "BufferSize": 10,
    "FlushIntervalMs": 5000
  },
  "PlayerEvents": {
    "Dataset": "player-events",
    "Enabled": true
  }
}

配置参考

日志提供商选项

选项 类型 描述
Provider string fivemanage、grafana-loki 或 file
ApiKey string Fivemanage 的 API 密钥
Endpoint string Loki 推送端点 URL
Username string 基础认证用户名 (Loki)
Password string 基础认证密码 (Loki)
WriteToDisk boolean 同时将日志写入本地文件
EnableBatching boolean 在发送前缓冲日志
BufferSize integer 刷新前缓冲的日志数(默认:10)
FlushIntervalMs integer 刷新前最大等待时间(毫秒)(默认:5000)

玩家事件选项

选项 类型 描述
Dataset string 玩家事件的数据集/标签名称
Enabled boolean 启用自动玩家事件日志记录

在您的 Hytale 模组中使用

使用 FivemanageLogger API 从您自己的 Hytale 模组发送自定义日志:

import org.fivemanage.FivemanageLogger;
import java.util.Map;

// 带元数据记录日志
Map<String, Object> metadata = Map.of(
    "player", "Steve",
    "location", "x:100, y:64, z:200"
);

FivemanageLogger.info("my-dataset", "Player spawned", metadata);
FivemanageLogger.warn("my-dataset", "Low health warning", metadata);
FivemanageLogger.error("my-dataset", "Something went wrong", metadata);
FivemanageLogger.debug("my-dataset", "Debug info", metadata);

自动事件跟踪

当 PlayerEvents.Enabled 为 true 时,以下事件会被自动记录:

事件 描述
玩家连接 当玩家连接到服务器时
玩家就绪 当玩家完全加载并准备好时
玩家断开连接 当玩家离开服务器时

用例

  • 服务器管理 — 监控玩家活动和服务器健康状况
  • 反作弊日志记录 — 跟踪可疑的玩家行为
  • 分析仪表盘 — 使用 Grafana 构建仪表盘
  • 审计追踪 — 保留所有服务器事件的记录
  • 调试 — 追踪您的 Hytale 模组中的问题

相关资源

致谢

支持

许可证

MIT