OpenTelemetry Instrumentation Extension for FabricMC

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.

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.

Demo for development

• Make sure that you have Docker and IntelliJ installed
• Checkout the repository
• Download the OpenTelemetry JavaAgent and put it into the run folder
• Go into _monitoring_dev_infra and start it with docker compose up
• Log in to Grafana at localhost:3000 (username and password are admin)
• Open IntelliJ and run the Minecraft Server (OTEL-AGENT) launcher

Installation

Installation guide for the latest release

Usage in other mods

Add the following to build.gradle:

dependencies {
    modImplementation 'net.litetex.mcm:otel-instrumentation-extension:<version>'
    // Further documentation: https://wiki.fabricmc.net/documentation:fabric_loom
}

Note

The contents are hosted on Maven Central. You shouldn't have to change anything as this is the default maven repo.
If this somehow shouldn't work you can also try Modrinth Maven.

Contributing

See the contributing guide for detailed instructions on how to get started with our project.

Related documentation

• OTEL - Extending instrumentations with the API
• OTEL - SDK configuration
• OTEL - Disable default instrumentation