+Instrumentation points and PoC os_signpost (Instruments) instrument #475

ktoso · 2020-03-01T03:47:54Z

Motivation:

For tracing et al we'll want those cutpoints
Possibly metrics should use the same points btw

Related materials:

https://developer.apple.com/videos/play/wwdc2018/410 - Creating Custom Instruments
https://developer.apple.com/videos/play/wwdc2019/421 - Modeling in Custom Instruments

So we're actaually just on time with being able to do these things, it's a recent feature :-)

Modifications:

PoC cutpoints as an ActorInstrumentation
ActorInstruments for the Instruments.app that shows actor lifecycle, messages and other events
awesome for learning and exploring an actor system right now, in future also useful for debugging :)

The naming is a bit of a mess... need to figure it out.

Generally:

Instrumentation is the SPI,
then we plug in MetricsInstrument or TracingInstrument etc,
how do we call the Instruments integration?

Result:

Awesome "i can see what's going on, without even starting any external tracing/monitoring infra" while debugging and developing on my mac, user experience
prepares us for future Tracing integrationn

ktoso · 2020-03-01T03:48:36Z

Instruments/ActorInstruments/ActorInstruments/ActorInstruments.instrpkg

@@ -0,0 +1,195 @@
+<?xml version="1.0" encoding="UTF-8" ?>


This is the actual instrument definition; it relates to the os_signpost calls we do in the code

ktoso · 2020-03-01T03:49:17Z

Sources/DistributedActors/Instrumentation/Instrumentations+os_signpost.swift

+        self.address = shell.address
+        self.signpostID = OSSignpostID(
+            log: InstrumentsActorInstrumentation.logActors,
+            object: shell


Thanks to this the lifetime of this object is related to the specific shell <3 And all traces show up as related to it.
We cannot use the Address as this needs to be a pointer (i.e. a class value)

ktoso · 2020-03-01T03:51:15Z

Sources/DistributedActors/Instrumentation/Instrumentations+os_signpost.swift

+            log: InstrumentsActorInstrumentation.logActors,
+            name: "Actor Lifecycle",
+            signpostID: self.signpostID,
+            "actor-spawned,myself:%{public}@", "\(self.address)"


These get (efficiently) parsed and carried into the Instruments app.

TODO: protect with if myLoggingHandle.signpostsEnabled { to only serialize the address and other data when needed.

ktoso · 2020-03-01T03:51:26Z

Sources/DistributedActors/Instrumentation/Instrumentations+os_signpost.swift

+            log: InstrumentsActorInstrumentation.logActors,
+            name: "Actor Messages",
+            signpostID: self.signpostID,
+            "actor-message-received,myself:%{public}@,type:%{public}s", "\(self.address)", String(reflecting: type(of: message))


TODO: protect with if myLoggingHandle.signpostsEnabled { to only serialize the address and other data when needed.

TODO: carry actual message as well

ktoso · 2020-03-02T05:05:09Z

Sources/DistributedActors/ActorSystemSettings.swift

+            settings.configure(with: OSSignpostInstrumentationProvider())
+            #endif
+            return settings
+        }


By default on Apple platforms we enable the signpost instrumentation, it's pretty cheap and if someone does not want it they may disable

instrumentation always has a cost though? might be better to disable by default and enable as needed?

ktoso · 2020-03-02T05:35:32Z

More than happy to review this in depth (!).

I'll merge to ease development and using this to measure ongoing work.
Please review at will or we can talk it over some day in a tracing dedicated session

yim-lee · 2020-03-02T18:37:54Z

Instruments/ActorInstruments/ActorInstruments.xcodeproj/project.pbxproj

@@ -0,0 +1,171 @@
+// !$*UTF8*$!


Do we have to check in these .xcodeproj files?

I kind of fear we do with this project... :-(

I can't express this as swiftpm package as it's very xcode specific (the instruments "type"), to build it :-\

Or am I mistaking things, is this what people do with xcode projects? @tomerd @weissi ?

yim-lee · 2020-03-02T18:39:08Z

...s/ActorInstruments.xcodeproj/xcuserdata/ktoso.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>


Username in file path ^

yim-lee · 2020-03-02T18:39:53Z

Instruments/ActorInstruments/ActorInstruments/ActorInstruments.instrpkg

+<?xml version="1.0" encoding="UTF-8" ?>
+<package>
+    <id>com.apple.actors.ActorInstruments</id>
+    <version>0.4.0</version>


Does version have any special implications? As in, this has to match project version or something?

It has one extra meaning:

if you "install" instruments into your Instruments.app "newer version" overrides an old one I believe. So when we update this we could keep updating this like 0.4.0.1 perhaps? And then bump as well whenever we release a tag

Samples/Sources/SampleGenActorsDiningPhilosophers/main.swift

yim-lee · 2020-03-02T19:00:26Z

Sources/DistributedActors/ActorSystemSettings.swift

+            settings.configure(with: OSSignpostInstrumentationProvider())
+            #endif
+            return settings
+        }


instrumentation always has a cost though? might be better to disable by default and enable as needed?

ktoso commented Mar 1, 2020

View reviewed changes

+instrument Initial instrumentation protocols and OSSignpost impls

228d252

ktoso changed the title ~~[WIP/POC] Instrumentation points and PoC Instruments instrument~~ +Instrumentation points and PoC os_signpost (Instruments) instrument Mar 2, 2020

ktoso commented Mar 2, 2020

View reviewed changes

ktoso merged commit 030bb10 into apple:master Mar 2, 2020

ktoso deleted the wip-instruments branch March 2, 2020 05:35

ktoso added this to the 0.5.0 - Cluster Hardening milestone Mar 2, 2020

ktoso added 3 - in progress Ticket is being worked on t:observability Tracing, Metrics, Servicability... labels Mar 2, 2020

ktoso self-assigned this Mar 2, 2020

yim-lee reviewed Mar 2, 2020

View reviewed changes

ktoso removed the 3 - in progress Ticket is being worked on label Mar 3, 2020

+Instrumentation points and PoC os_signpost (Instruments) instrument #475

+Instrumentation points and PoC os_signpost (Instruments) instrument #475

Uh oh!

Conversation

ktoso commented Mar 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation:

Modifications:

Result:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ktoso commented Mar 2, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ktoso commented Mar 1, 2020 •

edited

Loading