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

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
895
20 day(s) ago
1788
54 day(s) ago
586
55 day(s) ago
1142
62 day(s) ago
793
69 day(s) ago
1200
88 day(s) ago
141
95 day(s) ago
1180
103 day(s) ago
46162
264 day(s) ago
734
274 day(s) ago
582
280 day(s) ago
15423
363 day(s) ago
8516
399 day(s) ago
2507
433 day(s) ago
591
468 day(s) ago
5333
475 day(s) ago
96
523 day(s) ago
6522
546 day(s) ago
11495
606 day(s) ago
360
609 day(s) ago
8318
664 day(s) ago
8305
690 day(s) ago
758
693 day(s) ago
4169
693 day(s) ago
44
698 day(s) ago
1830
747 day(s) ago
4
748 day(s) ago
1778
792 day(s) ago
257
880 day(s) ago
144
953 day(s) ago
65317
1012 day(s) ago
77
1016 day(s) ago
42
1020 day(s) ago
55
1027 day(s) ago
16
1041 day(s) ago
4206
1064 day(s) ago
148
1070 day(s) ago
54
1071 day(s) ago
13590
1071 day(s) ago
7
1071 day(s) ago
439
1097 day(s) ago
4
1097 day(s) ago
12304
1106 day(s) ago
456
1140 day(s) ago
15
1141 day(s) ago
2011
1141 day(s) ago
101
1147 day(s) ago
57
1154 day(s) ago
6956
1170 day(s) ago
444
1183 day(s) ago
499
1195 day(s) ago
7133
1216 day(s) ago
1173
1252 day(s) ago
709
1254 day(s) ago
3259
1287 day(s) ago
2319
1308 day(s) ago
683
1316 day(s) ago
1970
1370 day(s) ago
1456
1386 day(s) ago
248
1392 day(s) ago
3407
1412 day(s) ago
5798
1456 day(s) ago
11056
1513 day(s) ago
108
1517 day(s) ago
88
1517 day(s) ago
88
1517 day(s) ago
88
1517 day(s) ago
561
1547 day(s) ago
212
1562 day(s) ago
1609
1583 day(s) ago
844
1618 day(s) ago
1252
1630 day(s) ago
80
1630 day(s) ago

Info

Statistics

  • 282592 total downloads
  • 4 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge