Sauco

Description

Visual tools to help reading Pharo profiler

Details

Source

GitHub

Dialect

pharo (65% confidence)

License

MIT

Stars

4

Created

Nov. 3, 2021

Updated

Dec. 4, 2025

Topics

pharo profiler

README excerpt

# Sauco

[![Test](https://github.com/tinchodias/pharo-sauco-profiler/actions/workflows/test.yml/badge.svg)](https://github.com/tinchodias/pharo-sauco-profiler/actions/workflows/test.yml)

Visual tools to help reading Pharo profiler tally output (`MessageTally` and `AndreasSystemProfiler`).

This project provides:
- A [flame graph](https://github.com/brendangregg/FlameGraph) visual inspector (a kind of non-radial [Sunburst](https://www.data-to-viz.com/graph/sunburst.html)).
- A model to colorize and aggregate the tally output (See `SaMethodNode`, `SaBehaviorNode` and `SaCategoryNode`).
- Spec2 inspectors provide means to explore the model.

## Screenshots

| Tally Tree | Behaviors (Classes, Metaclasses, Traits |
:-----------:|:---------------------------------------:|
<img width="478" alt="TallyTree" src="https://user-images.githubusercontent.com/3044265/140250604-582909e6-0b0a-49bf-9808-e7c4958bf608.png"> | <img width="539" alt="Classes" src="https://user-images.githubusercontent.com/3044265/140250800-1d169be5-463c-4564-af9d-871533324180.png">



| Flame Graph (macro view) | Flame Graph (zoomed view) | Color Mapping by category |
:-------------------------:|:-------------------------:|:--------------------------:
| <img width="361" alt="SkiaMacro" src="https://user-images.githubusercontent.com/3044265/140248163-caf41ef3-80e2-434b-8dfd-823ec3dd17b5.png"> | <img width="749" alt="CairoDetail" src="https://user-images.githubusercontent.com/3044265/140248169-e4146666-d052-4617-a2e5-8af14929fc47.png"> | <img width="108" alt="Legend" src="https://user-images.githubusercontent.com/3044265/140248298-24c7dba1-92c7-4e84-b192-f1f84faefdec.png">  |


## Install

Evaluate the following script in a Pharo image (>=v13):
~~~smalltalk
Metacello new
    baseline: 'Sauco';
    repository: 'github://tinchodias/Sauco:master/src';
    load.
~~~

🚨 Note 1: The baseline of this project was initially called `BaselineOfSaucoPerfMeter`, then simplified to `BaselineOfSauco`, but we keep backwards compatibility.

🚨 Note 2: This repository was renamed from `pharo-sauco-profiler` to `Sauco`.

## How to Use

You can find several examples oof use in class-side of `SaReport`, such as:
```Smalltalk
SaReport exampleUUID
```

But you can just place code to profile in a block closure and inspect the `SaReport` like:
```Smalltalk
SaReport newWithASPOn: [ 
	| array |
	array := FLSerializer serializeToByteArray: Smalltalk ui icons. 
	FLMaterializer materializeFromByteArray: array ]
```

## What does *sauco* mean?

It has no relation with software profilers. Sauco is the name of [a tree](https://es.wikipedia.org/wiki/Sambucus_australis) that can look like in this picture:

![Fruits](https://upload.wikimedia.org/wikipedia/commons/thumb/e/e1/Sambucus_nigra2.jpg/320px-Sambucus_nigra2.jpg)

## License

The code is licensed under [MIT](LICENSE).