Phobos
Enterprise Application Monitoring and Management for Akka.NET OSS
Published by Petabridge
  • last updated 2 day(s) ago
  • 3992 daily downloads
  • 1640424 total downloads
  • Latest version: 2.8.0

Phobos.TestKit 1.5.0-beta1

Framework used for testing applications that have been instrumented using Phobos. Makes it feasible to test using data collected from actor traces, monitoring, and so forth.

Install-Package Phobos.TestKit -Version 1.5.0-beta1
dotnet add package Phobos.TestKit --version 1.5.0-beta1
<PackageReference Include="Phobos.TestKit" Version="1.5.0-beta1"/>
paket add Phobos.TestKit --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
1
2 day(s) ago
2
9 day(s) ago
4
28 day(s) ago
2
35 day(s) ago
3
43 day(s) ago
27
204 day(s) ago
3
214 day(s) ago
2
220 day(s) ago
15
303 day(s) ago
7
339 day(s) ago
7
373 day(s) ago
7
408 day(s) ago
3
415 day(s) ago
2
463 day(s) ago
14
486 day(s) ago
106
546 day(s) ago
4
549 day(s) ago
127
604 day(s) ago
169
630 day(s) ago
5
633 day(s) ago
7
633 day(s) ago
16
638 day(s) ago
11
687 day(s) ago
1
688 day(s) ago
9
732 day(s) ago
1
820 day(s) ago
1
893 day(s) ago
51
952 day(s) ago
4
956 day(s) ago
3
960 day(s) ago
5
967 day(s) ago
2
981 day(s) ago
19
1004 day(s) ago
2
1010 day(s) ago
2
1011 day(s) ago
43
1011 day(s) ago
2
1011 day(s) ago
1
1037 day(s) ago
1
1037 day(s) ago
126
1046 day(s) ago
2
1080 day(s) ago
1
1081 day(s) ago
61
1081 day(s) ago
1
1087 day(s) ago
3
1094 day(s) ago
49
1110 day(s) ago
2
1123 day(s) ago
2
1135 day(s) ago
197
1156 day(s) ago
23
1192 day(s) ago
120
1194 day(s) ago
278
1227 day(s) ago
61
1248 day(s) ago
3
1256 day(s) ago
565
1310 day(s) ago
127
1326 day(s) ago
10
1332 day(s) ago
250
1352 day(s) ago
457
1396 day(s) ago
671
1453 day(s) ago
83
1457 day(s) ago
84
1457 day(s) ago
84
1457 day(s) ago
84
1457 day(s) ago
87
1487 day(s) ago
84
1502 day(s) ago
372
1523 day(s) ago
84
1558 day(s) ago
169
1570 day(s) ago
84
1570 day(s) ago

Info

Statistics

  • 4915 total downloads
  • 1 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge