Phobos
Enterprise Application Monitoring and Management for Akka.NET OSS
Published by Petabridge
  • last updated 65 day(s) ago
  • 2902 daily downloads
  • 1216397 total downloads
  • Latest version: 2.5.1

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
5211
65 day(s) ago
4485
100 day(s) ago
1732
134 day(s) ago
590
169 day(s) ago
2495
176 day(s) ago
63
225 day(s) ago
5135
248 day(s) ago
10589
308 day(s) ago
360
311 day(s) ago
7406
366 day(s) ago
6307
392 day(s) ago
758
395 day(s) ago
3630
395 day(s) ago
44
400 day(s) ago
1829
448 day(s) ago
4
450 day(s) ago
1754
493 day(s) ago
257
582 day(s) ago
144
655 day(s) ago
57781
714 day(s) ago
77
717 day(s) ago
42
722 day(s) ago
55
729 day(s) ago
16
742 day(s) ago
4201
766 day(s) ago
148
772 day(s) ago
54
773 day(s) ago
13580
773 day(s) ago
7
773 day(s) ago
439
798 day(s) ago
4
798 day(s) ago
12296
807 day(s) ago
456
842 day(s) ago
15
843 day(s) ago
2010
843 day(s) ago
101
849 day(s) ago
57
856 day(s) ago
6955
872 day(s) ago
444
885 day(s) ago
499
896 day(s) ago
7133
917 day(s) ago
1173
954 day(s) ago
709
956 day(s) ago
3259
989 day(s) ago
2319
1010 day(s) ago
683
1018 day(s) ago
1810
1072 day(s) ago
1455
1088 day(s) ago
248
1093 day(s) ago
3407
1114 day(s) ago
5798
1157 day(s) ago
11056
1214 day(s) ago
99
1218 day(s) ago
88
1218 day(s) ago
88
1218 day(s) ago
88
1218 day(s) ago
561
1249 day(s) ago
212
1264 day(s) ago
1609
1284 day(s) ago
844
1319 day(s) ago
1252
1331 day(s) ago
80
1332 day(s) ago

Info

Statistics

  • 196001 total downloads
  • 4 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge