OpenTelemetry can be used to [report various monitoring data (including metrics, logs and traces)](https://opentelemetry.io/docs/what-is-opentelemetry/) and is a de-facto industry standard. This mod provides additional instrumentation for the [OpenTelemetry JavaAgent](https://opentelemetry.io/docs/zero-code/java/agent/) so that various game metrics can be reported. The overall functionality is similar to [``fabric-exporter``](https://github.com/ruscalworld/fabric-exporter). ## Setup 1. Make sure you have an endpoint where OpenTelemetry data can be ingested.
This could be a [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) hosted by you or by someone else (e.g. in the [Grafana Cloud](https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/collector/)). 2. [Setup the OpenTelemetry Java Agent](https://opentelemetry.io/docs/zero-code/java/agent/getting-started/) so that it sends data to your ingestion service. 3. Add the [OpenTelemetry Agent Helper Extension for Fabric](https://github.com/litetex-oss/otel-fabric-helper-extension). * 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](https://grafana.com/grafana/dashboards/23234) * From the [local demo in the repo](https://github.com/litetex-oss/mcm-otel-instrumentation-extension/tree/dev/_monitoring_dev_infra/docker-compose.yml)

Diagram showcasing how the overall infrastructure can look

![Infra Overview](https://raw.githubusercontent.com/litetex-oss/mcm-otel-instrumentation-extension/refs/heads/dev/assets/InfraOverview.svg)

You may also have a look at the corresponding [development setup](https://github.com/litetex-oss/mcm-otel-instrumentation-extension?tab=readme-ov-file#demo-for-development) as it contains an locally running deployment of the full infrastructure.

Dashboard look

![Overview](https://raw.githubusercontent.com/litetex-oss/mcm-otel-instrumentation-extension/refs/heads/dev/assets/dashboard-overview.jpg) ![Network](https://raw.githubusercontent.com/litetex-oss/mcm-otel-instrumentation-extension/refs/heads/dev/assets/dashboard-network.jpg) ![Chunk Generation](https://raw.githubusercontent.com/litetex-oss/mcm-otel-instrumentation-extension/refs/heads/dev/assets/dashboard-chunk-generation.jpg) ![Entities](https://raw.githubusercontent.com/litetex-oss/mcm-otel-instrumentation-extension/refs/heads/dev/assets/dashboard-entities.jpg) ![Player](https://raw.githubusercontent.com/litetex-oss/mcm-otel-instrumentation-extension/refs/heads/dev/assets/dashboard-players.jpg)

### Example [integrations](https://github.com/litetex-oss/mcm-otel-instrumentation-extension/tree/dev/_integrations) * For [``itzg/minecraft-server``](https://github.com/itzg/docker-minecraft-server) see [here](https://github.com/litetex-oss/mcm-otel-instrumentation-extension/tree/dev/_integrations/itzg-minecraft-server) ## 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](https://github.com/litetex-oss/mcm-otel-instrumentation-extension/tree/dev/src/main/java/net/litetex/oie/config/).

OpenTelemetry Instrumentation Extension

Compatibility

Minecraft: Java Edition

Platforms

Supported environments

Links

Creators

Details