OpenTelemetry Instrumentation Extension

OpenTelemetry can be used to report various monitoring data (including metrics, logs and traces) and is a de-facto industry standard.

This mod provides additional instrumentation for the OpenTelemetry JavaAgent so that various game metrics can be reported. The overall functionality is similar to fabric-exporter.

Instrumented/Reported metrics

• MSPT/TPS
• Loaded chunks
• Server state
• Networking
  • connections
  • handshakes
  • packets sent/received
• Chunk generation
• Entities
  • grouped by type, spawn ground and world/dimension
• Players
  • by world
  • online
  • total xp (score)
  • xp level
• Runtime
  • game version
  • Fabric version
• Optional data from spark

Setup

1. Make sure you have an endpoint where OpenTelemetry data can be ingested.
   This could be a OpenTelemetry Collector hosted by you or by someone else (e.g. in the Grafana Cloud).
2. Setup the OpenTelemetry Java Agent so that it sends data to your ingestion service.
3. Add the OpenTelemetry Agent Helper Extension for Fabric.
   • This is required so that the OpenTelemetry Agent is correctly detecting and utilizing the mod.
4. Simply add and (optionally) configure this mod. It should work out of the box.
5. Import the provided dashboard into Grafana
   • From Grafana Dashboards
   • From the local demo in the repo

Diagram showcasing how the overall infrastructure can look

You may also have a look at the corresponding development setup as it contains an locally running deployment of the full infrastructure.

Dashboard look

Example integrations

• For itzg/minecraft-server see here

Configuration

The default configuration of the mod should usually work out of the box.

If you wish to customize it, open config/oie.json and tune the corresponding values.

Further documentation can be found directly inside the corresponding Java Code.