Phobos
Enterprise Application Monitoring and Management for Akka.NET OSS
Published by Petabridge
  • last updated 24 day(s) ago
  • 4801 daily downloads
  • 1865713 total downloads
  • Latest version: 2.8.4

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
857
24 day(s) ago
3332
71 day(s) ago
2113
105 day(s) ago
658
106 day(s) ago
1381
113 day(s) ago
819
120 day(s) ago
1226
139 day(s) ago
167
146 day(s) ago
1206
154 day(s) ago
53202
315 day(s) ago
759
325 day(s) ago
638
331 day(s) ago
16091
414 day(s) ago
9178
450 day(s) ago
2532
484 day(s) ago
616
519 day(s) ago
5828
526 day(s) ago
121
574 day(s) ago
6804
597 day(s) ago
11537
657 day(s) ago
385
660 day(s) ago
8343
715 day(s) ago
8587
741 day(s) ago
783
744 day(s) ago
4194
744 day(s) ago
69
749 day(s) ago
1855
798 day(s) ago
4
799 day(s) ago
1803
843 day(s) ago
257
931 day(s) ago
144
1004 day(s) ago
65429
1063 day(s) ago
102
1067 day(s) ago
67
1071 day(s) ago
80
1078 day(s) ago
16
1092 day(s) ago
4231
1115 day(s) ago
173
1121 day(s) ago
79
1122 day(s) ago
13618
1122 day(s) ago
32
1122 day(s) ago
439
1148 day(s) ago
4
1148 day(s) ago
12415
1157 day(s) ago
456
1191 day(s) ago
15
1192 day(s) ago
2036
1192 day(s) ago
101
1198 day(s) ago
82
1205 day(s) ago
6981
1221 day(s) ago
469
1234 day(s) ago
524
1245 day(s) ago
7158
1266 day(s) ago
1198
1303 day(s) ago
734
1305 day(s) ago
3284
1338 day(s) ago
2344
1359 day(s) ago
708
1367 day(s) ago
1995
1421 day(s) ago
1482
1437 day(s) ago
273
1443 day(s) ago
3433
1463 day(s) ago
5824
1507 day(s) ago
11082
1564 day(s) ago
139
1568 day(s) ago
114
1568 day(s) ago
114
1568 day(s) ago
114
1568 day(s) ago
587
1598 day(s) ago
238
1613 day(s) ago
1636
1634 day(s) ago
872
1669 day(s) ago
1281
1681 day(s) ago
109
1681 day(s) ago

Info

Statistics

  • 297557 total downloads
  • 4 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge