Phobos
Enterprise Application Monitoring and Management for Akka.NET OSS
Published by Petabridge
  • last updated 33 day(s) ago
  • 3658 daily downloads
  • 1788601 total downloads
  • Latest version: 2.8.3

Phobos.Actor 2.0.0-beta4

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

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

Release Notes

Major Update to Phobos 2.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 / 2.0.0-beta3 and newer. 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
1652
33 day(s) ago
1863
67 day(s) ago
633
68 day(s) ago
1210
74 day(s) ago
793
81 day(s) ago
1200
101 day(s) ago
142
107 day(s) ago
1180
115 day(s) ago
47781
277 day(s) ago
734
287 day(s) ago
601
293 day(s) ago
15527
376 day(s) ago
8658
411 day(s) ago
2507
445 day(s) ago
591
480 day(s) ago
5458
487 day(s) ago
96
536 day(s) ago
6570
559 day(s) ago
11501
619 day(s) ago
360
622 day(s) ago
8318
677 day(s) ago
8355
703 day(s) ago
758
706 day(s) ago
4169
706 day(s) ago
44
711 day(s) ago
1830
759 day(s) ago
4
761 day(s) ago
1778
804 day(s) ago
257
893 day(s) ago
144
966 day(s) ago
65327
1025 day(s) ago
77
1028 day(s) ago
42
1033 day(s) ago
55
1040 day(s) ago
16
1053 day(s) ago
4206
1077 day(s) ago
148
1083 day(s) ago
54
1084 day(s) ago
13590
1084 day(s) ago
7
1084 day(s) ago
439
1109 day(s) ago
4
1109 day(s) ago
12348
1118 day(s) ago
456
1153 day(s) ago
15
1154 day(s) ago
2011
1154 day(s) ago
101
1160 day(s) ago
57
1167 day(s) ago
6956
1183 day(s) ago
444
1196 day(s) ago
499
1207 day(s) ago
7133
1228 day(s) ago
1173
1265 day(s) ago
709
1267 day(s) ago
3259
1300 day(s) ago
2319
1321 day(s) ago
683
1329 day(s) ago
1970
1383 day(s) ago
1456
1399 day(s) ago
248
1404 day(s) ago
3407
1425 day(s) ago
5798
1468 day(s) ago
11056
1525 day(s) ago
111
1529 day(s) ago
88
1529 day(s) ago
88
1529 day(s) ago
88
1529 day(s) ago
561
1560 day(s) ago
212
1575 day(s) ago
1609
1595 day(s) ago
844
1630 day(s) ago
1252
1642 day(s) ago
80
1642 day(s) ago

Info

Statistics

  • 285710 total downloads
  • 439 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge