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

Phobos.Actor.Cluster 1.5.0-beta1

Akka.Cluster support for Phobos Enterprise framework.

Install-Package Phobos.Actor.Cluster -Version 1.5.0-beta1
dotnet add package Phobos.Actor.Cluster --version 1.5.0-beta1
<PackageReference Include="Phobos.Actor.Cluster" Version="1.5.0-beta1"/>
paket add Phobos.Actor.Cluster --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
1753
34 day(s) ago
1877
68 day(s) ago
632
69 day(s) ago
1219
76 day(s) ago
770
83 day(s) ago
1200
102 day(s) ago
141
109 day(s) ago
1180
117 day(s) ago
48018
278 day(s) ago
732
288 day(s) ago
581
294 day(s) ago
15396
377 day(s) ago
8719
413 day(s) ago
2507
447 day(s) ago
591
482 day(s) ago
5503
489 day(s) ago
171
537 day(s) ago
3906
560 day(s) ago
11482
620 day(s) ago
355
623 day(s) ago
8307
678 day(s) ago
2777
704 day(s) ago
727
707 day(s) ago
4165
707 day(s) ago
40
712 day(s) ago
1793
761 day(s) ago
1
762 day(s) ago
951
806 day(s) ago
254
894 day(s) ago
141
967 day(s) ago
57393
1026 day(s) ago
68
1030 day(s) ago
38
1034 day(s) ago
51
1041 day(s) ago
12
1055 day(s) ago
4198
1078 day(s) ago
142
1084 day(s) ago
17
1085 day(s) ago
13493
1085 day(s) ago
2
1085 day(s) ago
436
1111 day(s) ago
1
1111 day(s) ago
12152
1120 day(s) ago
453
1154 day(s) ago
11
1155 day(s) ago
1904
1155 day(s) ago
98
1161 day(s) ago
41
1168 day(s) ago
6955
1184 day(s) ago
436
1197 day(s) ago
495
1208 day(s) ago
7121
1229 day(s) ago
1067
1266 day(s) ago
703
1268 day(s) ago
3236
1301 day(s) ago
2314
1322 day(s) ago
670
1330 day(s) ago
1959
1384 day(s) ago
1452
1400 day(s) ago
243
1406 day(s) ago
339
1426 day(s) ago
5792
1470 day(s) ago
9384
1527 day(s) ago
100
1531 day(s) ago
84
1531 day(s) ago
84
1531 day(s) ago
84
1531 day(s) ago
537
1561 day(s) ago
208
1576 day(s) ago
1604
1597 day(s) ago
850
1632 day(s) ago
855
1644 day(s) ago
87
1644 day(s) ago

Info

Statistics

  • 263058 total downloads
  • 1 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge