Phobos
Phobos
Enterprise Application Monitoring and Management for Akka.NET OSS
Published by Petabridge
  • last updated 8 day(s) ago
  • 3292 daily downloads
  • 1088356 total downloads
  • Latest version: 2.5.0

Phobos.Monitoring 2.0.0-beta4

High-performance monitoring and instrumentation library for .NET and .NET Core applications.

Install-Package Phobos.Monitoring -Version 2.0.0-beta4
dotnet add package Phobos.Monitoring --version 2.0.0-beta4
<PackageReference Include="Phobos.Monitoring" Version="2.0.0-beta4"/>
paket add Phobos.Monitoring --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
184
8 day(s) ago
977
42 day(s) ago
510
77 day(s) ago
1126
84 day(s) ago
31
133 day(s) ago
4358
155 day(s) ago
7895
216 day(s) ago
380
218 day(s) ago
5679
274 day(s) ago
5631
300 day(s) ago
745
303 day(s) ago
2965
303 day(s) ago
36
308 day(s) ago
1476
356 day(s) ago
2
357 day(s) ago
1727
401 day(s) ago
256
490 day(s) ago
142
563 day(s) ago
53900
622 day(s) ago
72
625 day(s) ago
39
630 day(s) ago
53
637 day(s) ago
14
650 day(s) ago
4194
674 day(s) ago
144
680 day(s) ago
20
681 day(s) ago
13575
681 day(s) ago
4
681 day(s) ago
437
706 day(s) ago
2
706 day(s) ago
12199
715 day(s) ago
454
750 day(s) ago
13
750 day(s) ago
2007
751 day(s) ago
99
757 day(s) ago
53
764 day(s) ago
6956
779 day(s) ago
440
793 day(s) ago
493
804 day(s) ago
7133
825 day(s) ago
1166
862 day(s) ago
705
864 day(s) ago
3242
896 day(s) ago
2315
918 day(s) ago
679
926 day(s) ago
1784
980 day(s) ago
1452
996 day(s) ago
243
1001 day(s) ago
3401
1022 day(s) ago
5787
1065 day(s) ago
11050
1122 day(s) ago
94
1126 day(s) ago
87
1126 day(s) ago
36401
1126 day(s) ago
556
1157 day(s) ago
209
1172 day(s) ago
1608
1192 day(s) ago
852
1227 day(s) ago
1235
1239 day(s) ago
89
1239 day(s) ago

Info

Statistics

  • 209376 total downloads
  • 437 downloads of current version

Owners and Products

Petabridge Petabridge

Authors

Petabridge

Copyright

Copyright © 2017-2021 Petabridge

Petabridge