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

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
2390
35 day(s) ago
3533
71 day(s) ago
1520
105 day(s) ago
590
140 day(s) ago
2234
147 day(s) ago
48
195 day(s) ago
4875
218 day(s) ago
8699
278 day(s) ago
358
281 day(s) ago
7190
336 day(s) ago
5966
362 day(s) ago
758
365 day(s) ago
3380
365 day(s) ago
44
370 day(s) ago
1828
419 day(s) ago
4
420 day(s) ago
1752
464 day(s) ago
257
552 day(s) ago
144
625 day(s) ago
56554
684 day(s) ago
77
688 day(s) ago
42
692 day(s) ago
55
699 day(s) ago
16
713 day(s) ago
4201
736 day(s) ago
148
742 day(s) ago
54
743 day(s) ago
13579
743 day(s) ago
7
743 day(s) ago
439
769 day(s) ago
4
769 day(s) ago
12293
778 day(s) ago
456
813 day(s) ago
15
813 day(s) ago
2010
813 day(s) ago
101
819 day(s) ago
57
826 day(s) ago
6955
842 day(s) ago
444
855 day(s) ago
499
867 day(s) ago
7133
888 day(s) ago
1173
924 day(s) ago
709
926 day(s) ago
3259
959 day(s) ago
2319
980 day(s) ago
683
988 day(s) ago
1794
1042 day(s) ago
1455
1058 day(s) ago
248
1064 day(s) ago
3407
1084 day(s) ago
5798
1128 day(s) ago
11056
1185 day(s) ago
99
1189 day(s) ago
88
1189 day(s) ago
88
1189 day(s) ago
88
1189 day(s) ago
561
1219 day(s) ago
212
1234 day(s) ago
1609
1255 day(s) ago
844
1290 day(s) ago
1252
1302 day(s) ago
80
1302 day(s) ago

Info

Statistics

  • 187531 total downloads
  • 439 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge