RimWorks.RimObs.Library 2.3.2

RimWorld Observability Collector

<img src="https://raw.githubusercontent.com/RimWorks/rimworld-observability-collector/main/About/ModIcon.png" alt="RimObs icon" width="96" align="right">

A telemetry framework for RimWorld mods. Mod authors register named sections and metrics; an out-of-process collector aggregates the data, serves a dashboard, and can export diagnostic bundles.

Full documentation -->

For mod authors

Add the library:

dotnet add package RimWorks.RimObs.Library

Instrument a tick:

using RimWorks.RimObs.Api;

private static readonly SectionHandle Tick =
    Obs.Profile.RegisterSection("tick");

public void Tick() {
    using (Obs.Profile.Measure(Tick)) {
        // ... your work ...
    }
}

Section names are auto-prefixed with your mod's packageId. See the Quickstart for the full path from zero to dashboard.

For players

Subscribe to the Workshop item your other mods declare as a dependency. The collector launches automatically with the game and opens the dashboard in your browser. See Installation.

Documentation

• Mod-author quickstart
• Profile API and Metrics API
• Declarative profiling.xml
• Hot-path discipline
• Wire protocol and Local HTTP API
• Architecture

For contributors

The repo deliberately spans three .NET targets because each piece runs in a different host.

Test projects (RimObs.Library.Tests/, RimObs.Collector.Tests/) are net8.0 xUnit hosts; they exercise the library logic that is RimWorld-independent.

Root layout

The non-obvious neighbors at the repo root exist because this is both a RimWorld mod and a multi-project .NET solution:

• About/ -- RimWorld mod metadata (About.xml, Preview.png, loadFolders.xml).
• Assemblies/ -- RimWorld's deploy directory. RimObs.Library builds straight here.
• RimObs.sln -- single solution so Rider/VS resolve RimObs.Wire from both net48 and net10.0 consumers.
• Makefile + make.ps1 -- see make build, make test, make publish-collector.
• docs/wiki/ -- source for the wiki. Edit here, not on the wiki site; CI mirrors on push to main.

Quick start

make build              # SPA + full solution
make test               # xUnit suites
make watch              # collector hot-reload at :17654
make publish-collector  # self-contained binaries for win/linux/osx

Conventions

• Hot-path discipline for RimObs.Library is mandatory: zero allocation, exception-safe, no locks, no Task/async on the steady path. See Hot-path discipline for the full rules.
• Wire protocol is MessagePack with per-batch schema_version. Default port 17654 for HTTP and UDP in standalone mode; ephemeral when launched from the game. See Wire protocol.

License

MIT. See LICENSE.