FabricExporter

FabricExporter

一款为你的服务器添加通用指标 Prometheus 导出器的 Fabric 模组。

这是一个服务端模组，以 Prometheus 格式暴露你的 Fabric 服务器指标。

因此，它要求你至少安装 Prometheus 来收集提供的指标。

建议同时使用 Grafana 来可视化数据。

如果你想获取 TPS 和 MSPT 指标，你还需要为你的 Fabric 服务器安装 Spark 模组。

暴露的指标

以下是 FabricExporter 收集的指标列表。

• 由 Minecraft 收集的指标无需额外依赖，但在旧版 Minecraft 上运行时可能导致错误
• 由 Spark 收集的指标需要安装 Spark

你可以在[配置文件](src/main/resources/config/exporter.properties)中禁用其中任何指标。

快速开始

要使用此模组，你至少需要安装 Fabric 服务器和 Prometheus。

安装模组

• 从发布页面下载模组。
• 将下载的模组 jar 文件放入 mods 文件夹。
• 启动服务器以生成配置文件。
• 打开 config/exporter.properties，确保 server-port 值是一个可被你的 Prometheus 访问的开放端口，并根据需要修改。
• 如果你修改了配置，请重启服务器。

配置 Prometheus

• 打开你的 Prometheus 配置文件（默认位于 /etc/prometheus/prometheus.yml）。

sudo nano /etc/prometheus/prometheus.yml

• 将 FabricExporter 端点添加到 scrape_configs 部分。

别忘了将 127.0.0.1 替换为你的服务器地址，并将 25585 替换为 exporter.properties 文件中 server-port 属性指定的端口。

- job_name: 'fabric'
  static_configs:
    - targets: ['127.0.0.1:25585']

• 重启 Prometheus 服务。

sudo service prometheus restart

导入 Grafana 仪表板

如果你想使用 Grafana，可以使用我的仪表板作为模板。

假设你已经在 Grafana 中创建了 Prometheus 数据源。

现在，我们来导入 FabricExporter 的仪表板。

• 登录你的 Grafana，进入 创建 -> 导入 标签页。
• 在“通过 grafana.com 导入”字段中输入 14492，然后点击“加载”。
• 在下一页根据需要调整设置，然后点击“导入”。

配置

服务器启动后，FabricExporter 会在 config 文件夹中创建 exporter.properties 文件。

你应该使用此文件来配置模组。

在这个文件中，你可以看到一些通用设置和指标设置。

通用设置

指标设置

你可以使用 exporter.properties 文件禁用通过 MetricRegistry 注册的任何指标（默认所有指标）。

属性名称由 enable 加上去掉前缀并将 _ 替换为 - 的指标名组成。

例如，如果你想禁用 minecraftplayersonline，应将 enable-players-online 设为 false。

你也可以在“暴露的指标”部分查看可用属性列表。

如果找不到某些指标的属性，可以手动添加。

所有指标默认启用。

许可证

MIT 许可证。详情请见 [LICENSE](LICENSE)