https://github.com/aliceo2group/o2dissociator
a custom XCode Instruments plugin for AliceO2
https://github.com/aliceo2group/o2dissociator
Last synced: 5 months ago
JSON representation
a custom XCode Instruments plugin for AliceO2
- Host: GitHub
- URL: https://github.com/aliceo2group/o2dissociator
- Owner: AliceO2Group
- Created: 2019-03-28T13:14:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-01T13:53:07.000Z (about 7 years ago)
- Last Synced: 2025-09-09T03:59:10.771Z (9 months ago)
- Size: 888 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# O2 Dissociator : an Instruments plugin for AliceO2
This is a custom plugin for [Apple
Instruments](https://help.apple.com/instruments/mac/10.0/) (the profiler
Framework / GUI part of Apple's XCode developer suite). It allows for custom
views on the state of an Alice O2 processes, in particular (but not limited to)
those which use the Data Processing Layer.
It adds the following Instruments:
* O2 DPL State: which shows details about the current state of all the data
processing devices, in particular:
* It shows the intevals where a given device is DPL / FairMQ overhead.
* It shows the intervals where a given device is in user processing callback.
* It shows the intervals where a given device is in the error processing callback.
* O2 Driver Stats: which shows details about the current state of the DPL driver processing,
in particular:
* Amount of input logs read for each child.
* Amount of input logs processed for each child.
* O2 Monitoring State: which shows details about the monitorning subsystem, as integrated in DPL.
In particular it shows:
* The intervals when relayed metrics are sent.
* The intervals when all metrics are flushed.
## How does it work?
The traces are gathered via the mechanism provided in `Framework/Signpost.h`, i.e. the macros:
```
O2_SIGNPOST(...)
O2_SIGNPOST_START(...)
O2_SIGNPOST_END(...)
```
which are loosely documented at
(https://aliceo2group.github.io/AliceO2/db/de5/Signpost_8h.html). The macros
themself are wrappers around the Apple `kdebug_signpost` mechanism (see for
example presentation at
).
The actual instrument is created following the instructions at:
https://help.apple.com/instruments/developer/mac/current/
in order to extend it you need to have a look at the XML file `O2/O2.instpkg`
feel free to ask for help if you have signposts / intervals for which you would
like to have a custom instrument.
## What about linux?
In case you are using a Linux box (suggestions for alternatives to Instruments on Linux welcome),
this plugin will not be of much use, however the instrumentation in O2 using `O2_SIGNPOST`
will still be available via SystemTap.
## Obligatory screenshot:
