modpacks.ch by CreeperHost No ads. Just mods.
Back to mods
OpenTelemetry Instrumentation Extension project artwork

Modrinth · Minecraft mod

OpenTelemetry Instrumentation Extension

Instrumentation for the Java OpenTelemetry Agent to include additional game telemetry

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which OpenTelemetry Instrumentation Extension release should I use?

Updated 4 days ago
Latest stable file 2.2.0
Game version 26.3
Loader Fabric

OpenTelemetry Instrumentation Extension 2.2.0 targets 26.3 with Fabric. Do not install it on the client. It must be installed on the dedicated server. No extra mods listed for this file.

Where it goes

Is OpenTelemetry Instrumentation Extension required on the client, server, or both?

Do not install it on the client. It must be installed on the dedicated server.

Client Not supported
Dedicated server Required
Loader for this release Fabric
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This file is marked server-only.

Understand client and server requirements Read the Minecraft installation guide

What else does OpenTelemetry Instrumentation Extension 2.2.0 need?

2.2.0. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

spark Optional for OpenTelemetry Instrumentation Extension 2.2.0
optional
Matching file found Matched file: 1.10.187-fabric

We only count dependency files that match this setup. A file for another loader does not fill the gap.

Before you install it

Add OpenTelemetry Instrumentation Extension without breaking your instance.

Built for OpenTelemetry Instrumentation Extension 2.2.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 2.2.0. It targets 26.3 with Fabric; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    Do not install it on the client. It must be installed on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 2.2.0. It opens that exact file at the source.

About this project

What does OpenTelemetry Instrumentation Extension add?

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
Diagram showcasing how the overall infrastructure can look

Infra Overview

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

Dashboard look

Overview
Network
Chunk Generation
Entities
Player

Example integrations

Configuration

The configuration is dynamically loaded from (sorted by highest priority)
  • Environment variables
    • prefixed with OIE_
    • all properties are in UPPERCASE and use _ instead of . or -
  • System properties
    • prefixed with oie.
  • A configuration file located in .config/oie.json
Full list of configuration options

Please note that the preconfigured values usually work out of the box.

You should know exactly what you're doing when doing modifications.

General
Property Type Default Notes
instrumentation-name String minecraft Used as instrumentationScopeName. A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.
strip-identifier-namespaces bool true Removes namespaces from Identifier. Disabling this causes identifiers to look like this minecraft:overworld instead of overworld.
Usually only required for heavily modded servers.
Metrics
Property Type Default Notes
metrics.freeze-when-server-paused bool true Stop fetching certain metrics when the server is paused and uses previously cached values. This optimization usually improves the sampling speed for affected metrics by >10x.
Outcomes vary and depend on the work required for fetching and how often the server enters idle mode.
If the server is not using pauseWhenEmptySeconds (set to <= 0) this optimization will be ignored.
metrics.prefix String minecraft_ Prefix for all metrics
metrics.counter-suffix String _total Suffix for counters
metrics.enabled-only List<String> - Only enables the specified metrics.
ALL OTHER METRICS WILL BE DISABLED!
metrics.enabled-additionally List<String> - Additionally enables the specified metrics.
This is only relevant for metrics that are not enabled out of the box.
metrics.disabled List<String> - Disables the specified metrics
metrics.enable-player-details-samplers bool true Determines if the PlayerDetailsSamplers (e.g. Online, TotalXP, XPLevel) are enabled

Project description from Modrinth.

Pick your setup

OpenTelemetry Instrumentation Extension by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

14 available setups

Showing the newest 12 of 14 game versions. Older files are in the list below.

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

OpenTelemetry Instrumentation Extension versions and loaders

16 of 16 releases match

Looking for an older file? The official Modrinth project page is in Resources.

Keep browsing

See more mods

Like this one? One of these might be worth a look.