OpenTelemetry Instrumentation Extension

Quick rating

OpenTelemetry Instrumentation Extension

No reviews yet

Instrumentation for the Java OpenTelemetry Agent to include additional game telemetry

Mod Loaders
Fabric
Minecraft
26.2
Hosting Partner

Want to reach Minecraft players?

We're looking for a server hosting partner to feature here and other parts of the site. Interested? Send us a message!

Get in touch

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.
Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

Modrinth logo Modrinth

Compatibility

Supported Environments

Dev Environment
Client Unsupported
Server Required

About

Project Details

Type
Mod
License
GNU Lesser General Public License v3.0 or later
Latest Version
2.1.0
Authors

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

Modrinth ID

Resources

External Links

Source Issues Wiki Discord

About

Description

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.
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

Screenshots

Gallery

  • Overview
    Overview on the Dashboard
  • Network
    Network on the Dashboard
  • Chunk Generation
    Chunk Generation on the Dashboard
  • Entities
    Entities on the Dashboard
  • Players
    Players on the Dashboard

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

<1,000
Downloads
Last Updated
CurseForge
Modrinth
Created
Last synced
When ModDex last fetched this project from CurseForge or Modrinth. Every project is re-checked on a schedule, and any project that ships a new file is synced automatically within hours of the release.
New file updates sync automatically
How syncing works