Home

RimWorld Observability Collector

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.

Pick your path

Players

You installed a mod that depends on RimObs and want to know what it does.

• Installation -- Workshop, manual, dependencies
• Using the collector -- opening the dashboard, mod settings

Mod authors

You want to instrument your mod.

• Quickstart -- five-minute hello world
• Profile API -- timed sections via Obs.Profile
• Metrics API -- counters, gauges, histograms via Obs.Metrics
• profiling.xml -- declarative, no-code instrumentation
• Hot-path discipline -- what you must not do inside instrumented code
• Troubleshooting -- common log lines and fixes

Tool authors

You want to read collector data from your own tool.

• Wire protocol -- MessagePack envelope, schema versioning
• Local HTTP API -- /api/v1/* endpoints, auth, CSRF
• Diagnostic bundle -- exportable archive format

Operating the collector

• CLI reference
• Configuration
• Prometheus export

Dashboard

• Tour -- what each page shows

Reference

• Architecture -- three runtimes, data flow, ports
• Releases and versioning
• Glossary

---

Editing these pages: the wiki is generated from docs/wiki/ in the main repo. Edit there and open a pull request; direct edits made on this wiki will be overwritten on the next sync.