Phobos
Enterprise Application Monitoring and Management for Akka.NET OSS
Published by Petabridge
  • last updated 1 day(s) ago
  • 2144 daily downloads
  • 1916870 total downloads
  • Latest version: 2.8.5

Phobos.Actor 1.5.0-beta1

Automatic Akka.NET tracing and monitoring integration as part of the Phobos Enterprise Framework.

Install-Package Phobos.Actor -Version 1.5.0-beta1
dotnet add package Phobos.Actor --version 1.5.0-beta1
<PackageReference Include="Phobos.Actor" Version="1.5.0-beta1"/>
paket add Phobos.Actor --version 1.5.0-beta1

Release Notes

Minor Version Release of Phobos 1.x** This release contains some **breaking changes** which we've introduced intentionally in order to get users concerned about noise control from the Phobos tracing system to migrate over to a new set of APIs that perform the job in a much more coherent fashion that what we have currently in Phobos 1.4. You can see some examples of end-user negative experience reports with the current v1.x and 2.x trace filtering implementations here: https://github.com/petabridge/phobos-issues/issues/46 https://github.com/petabridge/phobos-issues/issues/49 There have been many more like these over the past couple of years - separating noise from useful signals has been a persistent challenge with Phobos tracing and the changes we're introducing in Phobos v1.5 and 2.0-beta4 address this with a small new API: ```csharp /// <summary> /// Each <see cref="ActorSystem"/> can implement exactly one of these to control /// the decision-making around which traces to include and which ones to exclude. /// /// When this type is configured, it will replace all of the <see cref="IFilterRule"/>s /// that have been previously defined. /// </summary> /// <seealso cref="FilterDecision"/> public interface ITraceFilter { /// <summary> /// Evaluates a message processed by an actor and determines whether or not to include it in the current /// or a new trace. /// </summary> /// <param name="message">The message currently being processed by an actor.</param> /// <param name="alreadyInTrace">Whether or not this message is already part of an active trace.</param> /// <returns><c>true</c> if we are going to trace the message, <c>false</c> otherwise.</returns> /// <remarks> /// Should return <c>true</c> unless you are explicitly trying to filter a given message out of your trace. /// </remarks> bool ShouldTraceMessage(object message, bool alreadyInTrace); } ``` This is the `ITraceFilter` - and there is _exactly one of these_ for your entire `ActorSystem`. It allows you to decide whether or not to trace an actor's message processing activity based on: Message type; Message content; and Whether or not we are inside an active trace or not. This API is astonishingly succinct, much clearer than the previous `TracingConfigBuilder` API from before, extremely performant, and very effective at limiting noise inside your Phobos-enabled Akka.NET applications. An example from one of our own stress testing applications: ```csharp public sealed class ScenarioTraceFilter : ITraceFilter { public bool ShouldTraceMessage(object message, bool alreadyInTrace) { switch (message) { /* Only start new traces for these commands / case IScenarioProtocolMessage _: case Petabridge.Cmd.Command _: case Petabridge.Cmd.CommandResponse _: return true; default: // otherwise, only allow messages already in trace to be included return alreadyInTrace; } } } ``` This class allows new traces to only be started handful of [Petabridge.Cmd](https://cmd.petabridge.com/) types and any messages and our custom `IScenarioProtocol` messages. Any additional messages _will not_ be included in a trace unless there is already an active trace present. You can add this `ITraceFilter` to your applications like so: ```csharp var phobosSetup = PhobosSetup.Create(new PhobosConfigBuilder() .WithMetrics(m => m.SetMetricsRoot(metrics)) // binds Phobos to same IMetricsRoot as ASP.NET Core .WithTracing(t => t.SetTracer(tracer) .SetTraceFilter(new ScenarioTraceFilter()) )) // binds Phobos to same tracer as ASP.NET Core .WithSetup(BootstrapSetup.Create() .WithActorRefProvider(PhobosProviderSelection .Local)); // last line activates Phobos inside Akka.NET ``` Phobos still supports the old `TracingConfigBuilder` pattern and the `WithIncludeMessage<T>` rules - however, all of those rules will be overidden and replaced when the `ITraceFilter` is used instead. We have broken the old `TracingConfigBuilder` method signatures in order to alert users to this important change - however, we are going to keep these changes in a beta state for a short period in order to gather feedback from affected users. If you are concerned about trace noise inside your application, _please try this beta_ and report on your experience on the [Phobos Issue Tracker](https://github.com/petabridge/phobos-issues).

Dependencies

.NETStandard

Versions

Version
Downloads
Last Updated
4
1 day(s) ago
1577
46 day(s) ago
4448
94 day(s) ago
2286
128 day(s) ago
682
129 day(s) ago
1433
135 day(s) ago
843
142 day(s) ago
1250
162 day(s) ago
192
169 day(s) ago
1230
177 day(s) ago
56700
338 day(s) ago
783
348 day(s) ago
662
354 day(s) ago
16636
437 day(s) ago
9371
473 day(s) ago
2556
507 day(s) ago
640
541 day(s) ago
5965
548 day(s) ago
145
597 day(s) ago
6904
620 day(s) ago
11595
680 day(s) ago
409
683 day(s) ago
8367
738 day(s) ago
8686
764 day(s) ago
807
767 day(s) ago
4218
767 day(s) ago
93
772 day(s) ago
1879
820 day(s) ago
4
822 day(s) ago
1827
865 day(s) ago
257
954 day(s) ago
144
1027 day(s) ago
65459
1086 day(s) ago
126
1090 day(s) ago
92
1094 day(s) ago
104
1101 day(s) ago
16
1114 day(s) ago
4255
1138 day(s) ago
198
1144 day(s) ago
103
1145 day(s) ago
13646
1145 day(s) ago
56
1145 day(s) ago
439
1170 day(s) ago
4
1170 day(s) ago
12451
1180 day(s) ago
456
1214 day(s) ago
15
1215 day(s) ago
2060
1215 day(s) ago
101
1221 day(s) ago
106
1228 day(s) ago
7005
1244 day(s) ago
493
1257 day(s) ago
548
1268 day(s) ago
7182
1289 day(s) ago
1222
1326 day(s) ago
758
1328 day(s) ago
3308
1361 day(s) ago
2369
1382 day(s) ago
732
1390 day(s) ago
2019
1444 day(s) ago
1507
1460 day(s) ago
297
1466 day(s) ago
3457
1486 day(s) ago
5848
1529 day(s) ago
11106
1587 day(s) ago
163
1591 day(s) ago
138
1591 day(s) ago
138
1591 day(s) ago
138
1591 day(s) ago
611
1621 day(s) ago
262
1636 day(s) ago
1660
1657 day(s) ago
896
1691 day(s) ago
1305
1704 day(s) ago
133
1704 day(s) ago

Info

Statistics

  • 305575 total downloads
  • 4 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge