mprof-report(1)

💖 mprof-report — the report generator for Mono's log profiler 💖

okay bestie, so this is mprof-report(1), from the General Commands Manual — it's a command-line tool, and it's literally the moment your profiler data stops being a mystery blob and starts being a whole report. 🎀

✨ SYNOPSIS ✨

mprof-report [option]... file.mlpd

🌸 DESCRIPTION 🌸

mprof-report is the report generator for Mono's log profiler. It reads the MLPD log files that the log profiler produces and generates a report based on whatever options you passed it. The output is built out of individual reports, and you can turn each one on or off like little light switches. By default, all reports are generated in summary form — aka non-verbose output, aka the chill version, not the unhinged detail version. 🦋

ngl, one of the cutest things about it: mprof-report can read both normal and gzip(1)-compressed log files transparently. You don't have to decompress anything, it just handles it. periodt. 💅

Wanna know how to actually use the log profiler with a program? Go read the mono-profilers(1) page, under the LOG PROFILER</> section. iykyk. 👑

✨ OPTIONS ✨

The following options are available, bestie — collect them all:

• --help — Displays usage instructions. the classic "help me pls" move 🫶
• *--out=file* — Write the report output to file instead of standard output. yes, you can yeet it into a file instead of letting it scroll forever in your terminal 😭
• --traces — Show backtraces in reports when available. the receipts!! 💀
• *--maxframes=num* — Limit backtraces to num frames. because sometimes 4000 frames is not the vibe 🍓
• --reports=reports — Generate *only the specified reports. *reports is a comma-separated list of reports. See the REPORTS</> section below, boo. ✨
• *--method-sort=mode* — Sort methods according to mode, which can be one of:
  • total (default) — Sort by the total amount of time spent in a method and its callees. the whole squad counts 💜
  • self — Sort by the amount of time spent only within a method itself. main character energy, no entourage 👑
  • calls — Sort by the total amount of calls made to a method. how many times did we text them fr fr 📱
• *--alloc-sort=mode* — Sort allocations according to mode, which can be one of:
  • bytes (default) — Sort by the amount of heap bytes occupied by all allocated objects of a type. chunky = important 🌈
  • count — Sort by the total amount of allocations of a type. quantity over quality, lowkey
• *--counters-sort=mode* — Sort counters according to mode. This alters how the counters</> report is presented. It can be one of:
  • time (default) — Present a list of samples, each containing a list of counter name-value pairs. sample first, then the deets 🧚
  • category — Present a list of counter names, each containing a list of sampled values. name first, then the receipts ⭐
  • > heads up: this option has no effect unless --verbose is passed. so don't come crying to me when nothing changes, bestie 🙈
• *--track=objects* — Track what happens to the specified objects. objects is a comma-separated list of object addresses. it's giving surveillance but make it debugging 🕵️
• *--find=spec* — Find and track what happens to objects matching spec, which can have one of these forms:
  • S:minimum_size — Look for objects that are at least minimum_size bytes in size.
  • T:name_fragment — Look for objects whose type name contain name_fragment.
  • > cute detail: both an S and a T spec can be given by passing the option twice. two options, one icon 💅
• *--thread=tid* — Consider only events from the thread with ID tid. one thread only, we're being exclusive today 💖
• *--time=span* — Consider only events occurring in the specified time span. span must be of the form from-to where from and to are seconds since the program started. time travel but legally 🦋
• --verbose — Print verbose output. the unhinged version, as promised 😌
• --debug — Print extremely detailed debug output. Most users should not use this option. I'm serious bestie, this one is a lot. it's giving firehose 💀

🌟 REPORTS 🌟

The following reports are available — mix and match with --reports, mwah 💋:

• header — Program startup and profiler version and operational information.
• jit — JIT compiler statistics.
• gc — Garbage collection and handle statistics.
• sample — Flat statistical sampling profile.
• alloc — Per-class GC allocation statistics and backtraces.
• call — Method call statistics and backtraces.
• metadata — Loaded images and assemblies.
• exception — Exception statistics and backtraces.
• monitor — Monitor lock statistics and backtraces.
• thread — Managed thread names.
• domain — Loaded application domains.
• context — Loaded remoting contexts.
• heapshot — Heap snapshot information.
• counters — Performance counter samples.

👀 SEE ALSO 👀

• mono(1)
• mono-profilers(1)

okay that's the whole thing, you ate that 🫶 go profile something and come back with a slay report. this was mprof-report, section 1 of the General Commands Manual — sending you love, stay hydrated, and remember: verbose output is a lifestyle 💖✨🎀