New Relic Logging sample for NServiceBus 10 #7325

Author: hsvotwa

samples/logging/new-relic/Metrics_6/Endpoint/Endpoint.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <OutputType>Exe</OutputType>
+    <LangVersion>preview</LangVersion>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="NewRelic.Agent.Api" Version="10.*" />
+    <PackageReference Include="NServiceBus" Version="10.0.0-alpha.1" />
+    <PackageReference Include="NServiceBus.Metrics" Version="6.0.0-alpha.1" />
+    <PackageReference Include="NServiceBus.Extensions.Hosting" Version="4.0.0-alpha.1" />
+  </ItemGroup>
+</Project>

samples/logging/new-relic/Metrics_6/Endpoint/LoadSimulator.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using NServiceBus;
+
+// Simulates busy (almost no delay) / quiet time in a sine wave
+class LoadSimulator(IEndpointInstance endpointInstance, TimeSpan minimumDelay, TimeSpan idleDuration)
+{
+    CancellationTokenSource tokenSource = new CancellationTokenSource();
+    TimeSpan idleDuration = TimeSpan.FromTicks(idleDuration.Ticks / 2);
+    Task fork;
+
+    public void Start()
+    {
+        fork = Task.Run(Loop, CancellationToken.None);
+    }
+
+    async Task Loop()
+    {
+        try
+        {
+            while (!tokenSource.IsCancellationRequested)
+            {
+                await Work();
+                var delay = NextDelay();
+                await Task.Delay(delay, tokenSource.Token);
+            }
+        }
+        catch (OperationCanceledException)
+        {
+        }
+    }
+
+    int index;
+
+    TimeSpan NextDelay()
+    {
+        var angleInRadians = Math.PI / 180.0 * ++index;
+        var delay = TimeSpan.FromMilliseconds(idleDuration.TotalMilliseconds * Math.Sin(angleInRadians));
+        delay += idleDuration;
+        delay += minimumDelay;
+        return delay;
+    }
+
+    Task Work()
+    {
+        return endpointInstance.SendLocal(new SomeCommand());
+    }
+
+    public Task Stop()
+    {
+        tokenSource.Cancel();
+        return fork;
+    }
+}

samples/logging/new-relic/Metrics_6/Endpoint/NewRelicMetrics.cs

@@ -0,0 +1,89 @@
+namespace Endpoint
+{
+    using System;
+    using System.Collections.Generic;
+    using NewRelic.Api.Agent;
+    using NServiceBus;
+    using NServiceBus.Configuration.AdvancedExtensibility;
+
+    public class NewRelicMetrics
+    {
+        public static void Setup(EndpointConfiguration endpointConfiguration)
+        {
+            #region newrelic-name-mapping
+
+            var endpointName = endpointConfiguration.GetSettings().EndpointName();
+
+            var nameMapping = new Dictionary<string, string>
+            {
+                // https://docs.newrelic.com/docs/agents/manage-apm-agents/agent-data/collect-custom-metrics
+                {"# of msgs successfully processed / sec", FormatMetric("Success_Total", endpointName)},
+                {"# of msgs pulled from the input queue /sec", FormatMetric("Fetched_Total", endpointName)},
+                {"# of msgs failures / sec", FormatMetric("Failure_Total", endpointName)},
+                {"Critical Time", FormatMetric("CriticalTime_Seconds", endpointName)},
+                {"Processing Time", FormatMetric("ProcessingTime_Seconds", endpointName)},
+            };
+            #endregion
+
+            #region newrelic-enable-nsb-metrics
+
+            var metricsOptions = endpointConfiguration.EnableMetrics();
+
+            #endregion
+
+            #region newrelic-register-probe
+
+            metricsOptions.RegisterObservers(
+                register: probeContext =>
+                {
+                    RegisterProbes(probeContext, endpointName, nameMapping);
+                });
+
+            #endregion
+        }
+
+        static void RegisterProbes(ProbeContext context, string endpointName, Dictionary<string, string> nameMapping)
+        {
+            #region newrelic-observers-registration
+
+            foreach (var duration in context.Durations)
+            {
+                duration.Register((ref DurationEvent @event) =>
+                {
+                    nameMapping.TryGetValue(duration.Name, out var mappedName);
+                    var newRelicName = string.Format(mappedName ?? FormatMetric(duration.Name, endpointName), Normalize(@event.MessageType));
+                    NewRelic.RecordResponseTimeMetric(newRelicName, Convert.ToInt64(@event.Duration.TotalMilliseconds));
+                });
+            }
+
+            foreach (var signal in context.Signals)
+            {
+                signal.Register((ref SignalEvent @event) =>
+                {
+                    nameMapping.TryGetValue(signal.Name, out var mappedName);
+                    var newRelicName = string.Format(mappedName ?? FormatMetric(signal.Name, endpointName), Normalize(@event.MessageType));
+                    NewRelic.RecordMetric(newRelicName, 1);
+                });
+            }
+
+            #endregion
+        }
+
+        static string FormatMetric(string name, string prefix)
+        {
+            return Normalize($"Custom/NServiceBus/{prefix}/{{0}}/{name}");
+        }
+
+        static string Normalize(string name)
+        {
+            var result = name.Split(SplitComma, StringSplitOptions.RemoveEmptyEntries);
+            if (result.Length > 0)
+            {
+                name = result[0];
+            }
+            return name.Replace(" ", "_").Replace(".", "_").Replace("-", "_");
+        }
+
+        static string[] SplitComma = new[] { "," };
+    }
+}

samples/logging/new-relic/Metrics_6/Endpoint/Program.cs

@@ -0,0 +1,43 @@
+using System;
+using Endpoint;
+using NServiceBus;
+
+var endpointConfiguration = new EndpointConfiguration(Console.Title = "TracingEndpoint");
+
+endpointConfiguration.UseSerialization<SystemJsonSerializer>();
+endpointConfiguration.UseTransport<LearningTransport>();
+
+NewRelicMetrics.Setup(endpointConfiguration);
+
+var endpointInstance = await NServiceBus.Endpoint.Start(endpointConfiguration);
+
+#region newrelic-load-simulator
+
+var simulator = new LoadSimulator(endpointInstance, TimeSpan.Zero, TimeSpan.FromSeconds(10));
+simulator.Start();
+
+#endregion
+
+try
+{
+    Console.WriteLine("Endpoint started.");
+    Console.WriteLine("Press [ENTER] to send additional messages.");
+    Console.WriteLine("Press [ESC] to quit.");
+
+    while (true)
+    {
+        switch (Console.ReadKey(true).Key)
+        {
+            case ConsoleKey.Escape:
+                return;
+            case ConsoleKey.Enter:
+                await endpointInstance.SendLocal(new SomeCommand());
+                break;
+        }
+    }
+}
+finally
+{
+    await simulator.Stop();
+    await endpointInstance.Stop();
+}

samples/logging/new-relic/Metrics_6/Endpoint/SomeCommand.cs

@@ -0,0 +1,6 @@
+using NServiceBus;
+
+class SomeCommand :
+    ICommand
+{
+}

samples/logging/new-relic/Metrics_6/Endpoint/SomeCommandHandler.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Threading.Tasks;
+using NServiceBus;
+using NServiceBus.Logging;
+
+class SomeCommandHandler :
+    IHandleMessages<SomeCommand>
+{
+    static ILog log = LogManager.GetLogger<SomeCommandHandler>();
+    static Random random = new Random();
+
+    public async Task Handle(SomeCommand message, IMessageHandlerContext context)
+    {
+        await Task.Delay(random.Next(50, 250), context.CancellationToken);
+
+        if (random.Next(10) <= 1)
+        {
+            throw new Exception("Random 10% chaos!");
+        }
+
+        log.Info("Hello from SomeCommandHandler");
+    }
+}

samples/logging/new-relic/Metrics_6/Endpoint/app.config

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+  <!-- startcode newrelic-appname -->
+  <appSettings>
+    <add key="NewRelic.AgentEnabled" value="true" />
+    <add key="NewRelic.AppName" value="NewRelic_Metrics4" />
+  </appSettings>
+  <!-- endcode -->
+</configuration>

samples/logging/new-relic/Metrics_6/NewRelic.sln

@@ -0,0 +1,19 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29728.190
+MinimumVisualStudioVersion = 15.0.26730.12
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Endpoint", "Endpoint\Endpoint.csproj", "{FF5BEF96-88BA-470D-975A-4EF710EE2B7A}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{FF5BEF96-88BA-470D-975A-4EF710EE2B7A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FF5BEF96-88BA-470D-975A-4EF710EE2B7A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+EndGlobal