Removed OpenTracing code

nefarius · nefarius · commit fed09f1401ba · 2023-07-05T13:33:22.000+02:00
Resolves #1
diff --git a/Nefarius.DSharpPlus.CommandsNext.Extensions.Hosting/DiscordServiceCollectionExtensions.cs b/Nefarius.DSharpPlus.CommandsNext.Extensions.Hosting/DiscordServiceCollectionExtensions.cs
@@ -7,7 +7,6 @@
 using Nefarius.DSharpPlus.CommandsNext.Extensions.Hosting.Util;
 using Nefarius.DSharpPlus.Extensions.Hosting;
 using Nefarius.DSharpPlus.Extensions.Hosting.Util;
-using OpenTracing;
 
 namespace Nefarius.DSharpPlus.CommandsNext.Extensions.Hosting
 {
@@ -56,12 +55,6 @@ public static IServiceCollection AddDiscordCommandsNext(
 
 				ext.CommandExecuted += async delegate(CommandsNextExtension sender, CommandExecutionEventArgs args)
 				{
-					using var workScope = provider.GetRequiredService<ITracer>()
-						.BuildSpan(nameof(ext.CommandExecuted))
-						.IgnoreActiveSpan()
-						.StartActive(true);
-					workScope.Span.SetTag("Command.Name", args.Command.Name);
-
 					using var scope = provider.CreateScope();
 
 					foreach (var eventsSubscriber in scope.GetDiscordCommandsNextEventsSubscriber())
@@ -70,12 +63,6 @@ public static IServiceCollection AddDiscordCommandsNext(
 
 				ext.CommandErrored += async delegate(CommandsNextExtension sender, CommandErrorEventArgs args)
 				{
-					using var workScope = provider.GetRequiredService<ITracer>()
-						.BuildSpan(nameof(ext.CommandErrored))
-						.IgnoreActiveSpan()
-						.StartActive(true);
-					workScope.Span.SetTag("Command.Name", args.Command.Name);
-
 					using var scope = provider.CreateScope();
 
 					foreach (var eventsSubscriber in scope.GetDiscordCommandsNextEventsSubscriber())
diff --git a/Nefarius.DSharpPlus.Extensions.Hosting/DiscordHostedService.cs b/Nefarius.DSharpPlus.Extensions.Hosting/DiscordHostedService.cs
@@ -3,50 +3,42 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using OpenTracing;
 
 namespace Nefarius.DSharpPlus.Extensions.Hosting
 {
-    /// <summary>
-    ///     Brings a <see cref="IDiscordClientService" /> online.
-    /// </summary>
-    [SuppressMessage("ReSharper", "UnusedMember.Global")]
-    [SuppressMessage("ReSharper", "ClassNeverInstantiated.Global")]
-    public class DiscordHostedService : IHostedService
-    {
-        private readonly IDiscordClientService _discordClient;
+	/// <summary>
+	///     Brings a <see cref="IDiscordClientService" /> online.
+	/// </summary>
+	[SuppressMessage("ReSharper", "UnusedMember.Global")]
+	[SuppressMessage("ReSharper", "ClassNeverInstantiated.Global")]
+	public class DiscordHostedService : IHostedService
+	{
+		private readonly IDiscordClientService _discordClient;
 
-        private readonly ILogger<DiscordHostedService> _logger;
+		private readonly ILogger<DiscordHostedService> _logger;
 
-        private readonly ITracer _tracer;
+		public DiscordHostedService(
+			IDiscordClientService discordClient,
+			ILogger<DiscordHostedService> logger)
+		{
+			_discordClient = discordClient;
+			_logger = logger;
+		}
 
-        public DiscordHostedService(
-            IDiscordClientService discordClient,
-            ITracer tracer,
-            ILogger<DiscordHostedService> logger)
-        {
-            _discordClient = discordClient;
-            _tracer = tracer;
-            _logger = logger;
-        }
+		/// <inheritdoc />
+		public async Task StartAsync(CancellationToken cancellationToken)
+		{
+			((DiscordService)_discordClient).Initialize();
 
-        /// <inheritdoc />
-        public async Task StartAsync(CancellationToken cancellationToken)
-        {
-            ((DiscordService) _discordClient).Initialize();
+			_logger.LogInformation("Connecting to Discord API...");
+			await _discordClient.Client.ConnectAsync();
+			_logger.LogInformation("Connected");
+		}
 
-            using (_tracer.BuildSpan(nameof(_discordClient.Client.ConnectAsync)).StartActive(true))
-            {
-                _logger.LogInformation("Connecting to Discord API...");
-                await _discordClient.Client.ConnectAsync();
-                _logger.LogInformation("Connected");
-            }
-        }
-
-        /// <inheritdoc />
-        public async Task StopAsync(CancellationToken cancellationToken)
-        {
-            await _discordClient.Client.DisconnectAsync();
-        }
-    }
+		/// <inheritdoc />
+		public async Task StopAsync(CancellationToken cancellationToken)
+		{
+			await _discordClient.Client.DisconnectAsync();
+		}
+	}
 }
diff --git a/Nefarius.DSharpPlus.Extensions.Hosting/DiscordService.cs b/Nefarius.DSharpPlus.Extensions.Hosting/DiscordService.cs
@@ -5,7 +5,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
-using OpenTracing;
 
 namespace Nefarius.DSharpPlus.Extensions.Hosting
 {
@@ -35,19 +34,15 @@ public partial class DiscordService : IDiscordClientService
 
 	    private readonly IServiceProvider _serviceProvider;
 
-	    private readonly ITracer _tracer;
-        
         public DiscordService(
             IServiceProvider serviceProvider,
             ILoggerFactory logFactory,
             ILogger<DiscordService> logger,
-            ITracer tracer,
             IOptions<DiscordConfiguration> discordOptions
         )
         {
             _serviceProvider = serviceProvider;
             _logger = logger;
-            _tracer = tracer;
             _discordOptions = discordOptions;
             _logFactory = logFactory;
         }
diff --git a/Nefarius.DSharpPlus.Extensions.Hosting/DiscordServiceCollectionExtensions.cs b/Nefarius.DSharpPlus.Extensions.Hosting/DiscordServiceCollectionExtensions.cs
@@ -3,8 +3,6 @@
 using DSharpPlus;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
-using OpenTracing;
-using OpenTracing.Mock;
 
 namespace Nefarius.DSharpPlus.Extensions.Hosting
 {
@@ -34,8 +32,6 @@ public static IServiceCollection AddDiscord(
         {
             services.Configure(configure);
 
-            services.TryAddSingleton<ITracer>(provider => new MockTracer());
-
             services.TryAddSingleton<IDiscordClientService, DiscordService>();
 
             if (!autoRegisterSubscribers)
diff --git a/Nefarius.DSharpPlus.Extensions.Hosting/Generators/DiscordServiceEventsHookGenerator.cs b/Nefarius.DSharpPlus.Extensions.Hosting/Generators/DiscordServiceEventsHookGenerator.cs
@@ -30,7 +30,6 @@ public void Execute(GeneratorExecutionContext context)
 using Microsoft.Extensions.Options;
 using Nefarius.DSharpPlus.Extensions.Hosting.Util;
 using Nefarius.DSharpPlus.Extensions.Hosting.Events;
-using OpenTracing;
 
 namespace Nefarius.DSharpPlus.Extensions.Hosting
 {
@@ -55,11 +54,6 @@ internal void HookEvents()
                 sourceBuilder.Append($@"
             Client.{name} += async delegate ({senderType} sender, {argsType} args)
             {{
-                using var workScope = _tracer
-                    .BuildSpan(nameof(Client.{name}))
-                    .IgnoreActiveSpan()
-                    .StartActive(true);
-
                 using var scope = _serviceProvider.CreateScope();
                 
                 var subscribers = scope.ServiceProvider
diff --git a/Nefarius.DSharpPlus.Extensions.Hosting/Generators/DiscordServiceIntentsBuilderGenerator.cs b/Nefarius.DSharpPlus.Extensions.Hosting/Generators/DiscordServiceIntentsBuilderGenerator.cs
@@ -70,7 +70,6 @@ public void Execute(GeneratorExecutionContext context)
 using Microsoft.Extensions.Options;
 using Nefarius.DSharpPlus.Extensions.Hosting.Util;
 using Nefarius.DSharpPlus.Extensions.Hosting.Events;
-using OpenTracing;
 
 namespace Nefarius.DSharpPlus.Extensions.Hosting
 {
diff --git a/Nefarius.DSharpPlus.Extensions.Hosting/Nefarius.DSharpPlus.Extensions.Hosting.csproj b/Nefarius.DSharpPlus.Extensions.Hosting/Nefarius.DSharpPlus.Extensions.Hosting.csproj
@@ -30,7 +30,6 @@
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="7.0.1" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
-    <PackageReference Include="OpenTracing" Version="0.12.1" />
     <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
diff --git a/Nefarius.DSharpPlus.SlashCommands.Extensions.Hosting/DiscordServiceCollectionExtensions.cs b/Nefarius.DSharpPlus.SlashCommands.Extensions.Hosting/DiscordServiceCollectionExtensions.cs
@@ -8,7 +8,6 @@
 using Nefarius.DSharpPlus.SlashCommands.Extensions.Hosting.Attributes;
 using Nefarius.DSharpPlus.SlashCommands.Extensions.Hosting.Events;
 using Nefarius.DSharpPlus.SlashCommands.Extensions.Hosting.Util;
-using OpenTracing;
 
 namespace Nefarius.DSharpPlus.SlashCommands.Extensions.Hosting
 {
@@ -57,12 +56,6 @@ public static IServiceCollection AddDiscordSlashCommands(
 
                 ext.ContextMenuErrored += async delegate(SlashCommandsExtension sender, ContextMenuErrorEventArgs args)
                 {
-                    using var workScope = provider.GetRequiredService<ITracer>()
-                        .BuildSpan(nameof(ext.ContextMenuErrored))
-                        .IgnoreActiveSpan()
-                        .StartActive(true);
-                    workScope.Span.SetTag("Context.CommandName", args.Context.CommandName);
-
                     using var scope = provider.CreateScope();
 
                     foreach (var eventsSubscriber in scope.GetDiscordSlashCommandsEventsSubscriber())
@@ -72,12 +65,6 @@ public static IServiceCollection AddDiscordSlashCommands(
                 ext.ContextMenuExecuted +=
                     async delegate(SlashCommandsExtension sender, ContextMenuExecutedEventArgs args)
                     {
-                        using var workScope = provider.GetRequiredService<ITracer>()
-                            .BuildSpan(nameof(ext.ContextMenuExecuted))
-                            .IgnoreActiveSpan()
-                            .StartActive(true);
-                        workScope.Span.SetTag("Context.CommandName", args.Context.CommandName);
-
                         using var scope = provider.CreateScope();
 
                         foreach (var eventsSubscriber in scope.GetDiscordSlashCommandsEventsSubscriber())
@@ -87,12 +74,6 @@ async delegate(SlashCommandsExtension sender, ContextMenuExecutedEventArgs args)
                 ext.SlashCommandErrored +=
                     async delegate(SlashCommandsExtension sender, SlashCommandErrorEventArgs args)
                     {
-                        using var workScope = provider.GetRequiredService<ITracer>()
-                            .BuildSpan(nameof(ext.SlashCommandErrored))
-                            .IgnoreActiveSpan()
-                            .StartActive(true);
-                        workScope.Span.SetTag("Context.CommandName", args.Context.CommandName);
-
                         using var scope = provider.CreateScope();
 
                         foreach (var eventsSubscriber in scope.GetDiscordSlashCommandsEventsSubscriber())
@@ -102,12 +83,6 @@ async delegate(SlashCommandsExtension sender, SlashCommandErrorEventArgs args)
                 ext.SlashCommandExecuted +=
                     async delegate(SlashCommandsExtension sender, SlashCommandExecutedEventArgs args)
                     {
-                        using var workScope = provider.GetRequiredService<ITracer>()
-                            .BuildSpan(nameof(ext.SlashCommandExecuted))
-                            .IgnoreActiveSpan()
-                            .StartActive(true);
-                        workScope.Span.SetTag("Context.CommandName", args.Context.CommandName);
-
                         using var scope = provider.CreateScope();
 
                         foreach (var eventsSubscriber in scope.GetDiscordSlashCommandsEventsSubscriber())
diff --git a/README.md b/README.md
@@ -95,36 +95,6 @@ services.AddDiscordHostedService();
 
 That's pretty much it! When you launch your worker with a valid bot token you should see your bot come online in an instant, congratulations! ✨
 
-### OpenTracing (Optional)
-
-You probably wonder what's the deal with the tracing dependency. I've taken liberty to implement [OpenTracing](https://github.com/opentracing/opentracing-csharp) within all event subscribers, so if your bot struggles with performance, you can easily analyse it with the addition of e.g. [Jaeger Tracing](https://github.com/jaegertracing/jaeger-client-csharp). If you don't know what that means or don't care about tracing at all, just skip this section. To utilise tracing, you can use this snippet to get you up and running (although I highly recommend you check out the Jaeger docs beforehand anyway):
-
-```csharp
-// Adds the Jaeger Tracer.
-services.AddSingleton<ITracer>(serviceProvider =>
-{
- var serviceName = "MyBot";
- var loggerFactory = serviceProvider.GetRequiredService<ILoggerFactory>();
-
- // This is necessary to pick the correct sender, otherwise a NoopSender is used!
- Configuration.SenderConfiguration.DefaultSenderResolver = new SenderResolver(loggerFactory)
-  .RegisterSenderFactory<ThriftSenderFactory>();
-
- // This will log to a default localhost installation of Jaeger.
- var tracer = new Tracer.Builder(serviceName)
-  .WithLoggerFactory(loggerFactory)
-  .WithSampler(new ConstSampler(true))
-  .Build();
-
- // Allows code that can't use DI to also access the tracer.
- GlobalTracer.Register(tracer);
-
- return tracer;
-});
-```
-
-Make sure you call this **before** `AddDiscord` or the Mock Tracer will be used by default which will not collect or publish any metrics.
-
 ### Handling Discord Events
 
 Now to the actual convenience feature of this library! Creating one (or more) class(es) that handle events, like when a guild came online or a message got created. Let's wire one up that gets general guild and member change events:
@@ -144,17 +114,14 @@ internal class BotModuleForGuildAndMemberEvents :
 {
     private readonly ILogger<BotModuleForGuildAndMemberEvents> _logger;
 
-    private readonly ITracer _tracer;
-
     /// <summary>
     ///     Optional constructor for Dependency Injection.
     ///     Parameters get populated automatically with your services.
     /// </summary>
     /// <param name="logger">The logger service instance.</param>
     /// <param name="tracer">The tracer service instance.</param>
     public BotModuleForGuildAndMemberEvents(
-        ILogger<BotModuleForGuildAndMemberEvents> logger,
-        ITracer tracer
+        ILogger<BotModuleForGuildAndMemberEvents> logger
     )
     {
         //
@@ -164,7 +131,6 @@ internal class BotModuleForGuildAndMemberEvents :
         // You can inject scoped services like database contexts as well!
         // 
         _logger = logger;
-        _tracer = tracer;
     }
 
     public Task DiscordOnGuildAvailable(DiscordClient sender, GuildCreateEventArgs args)
diff --git a/WorkerExample/SubscriberExample.cs b/WorkerExample/SubscriberExample.cs
@@ -4,7 +4,6 @@
 using DSharpPlus.EventArgs;
 using Microsoft.Extensions.Logging;
 using Nefarius.DSharpPlus.Extensions.Hosting.Events;
-using OpenTracing;
 
 namespace WorkerExample
 {
@@ -19,16 +18,13 @@ internal class BotModuleForGuildAndMemberEvents :
     {
         private readonly ILogger<BotModuleForGuildAndMemberEvents> _logger;
 
-        private readonly ITracer _tracer;
-
         /// <summary>
         ///     Optional constructor for Dependency Injection. parameters get populated automatically with you services.
         /// </summary>
         /// <param name="logger">The logger service instance.</param>
         /// <param name="tracer">The tracer service instance.</param>
         public BotModuleForGuildAndMemberEvents(
-            ILogger<BotModuleForGuildAndMemberEvents> logger,
-            ITracer tracer
+            ILogger<BotModuleForGuildAndMemberEvents> logger
         )
         {
             //
@@ -38,7 +34,6 @@ ITracer tracer
             // You can inject scoped services like database contexts as well!
             // 
             _logger = logger;
-            _tracer = tracer;
         }
 
         public Task DiscordOnGuildAvailable(DiscordClient sender, GuildCreateEventArgs args)

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`using Microsoft.Extensions.DependencyInjection;`
`6`	`6`	`using Microsoft.Extensions.Logging;`
`7`	`7`	`using Microsoft.Extensions.Options;`
`8`		`-using OpenTracing;`
`9`	`8`
`10`	`9`	`namespace Nefarius.DSharpPlus.Extensions.Hosting`
`11`	`10`	`{`
`@@ -35,19 +34,15 @@ public partial class DiscordService : IDiscordClientService`
`35`	`34`
`36`	`35`	`private readonly IServiceProvider _serviceProvider;`
`37`	`36`
`38`		`- private readonly ITracer _tracer;`
`39`		`-`
`40`	`37`	`public DiscordService(`
`41`	`38`	`IServiceProvider serviceProvider,`
`42`	`39`	`ILoggerFactory logFactory,`
`43`	`40`	`ILogger<DiscordService> logger,`
`44`		`- ITracer tracer,`
`45`	`41`	`IOptions<DiscordConfiguration> discordOptions`
`46`	`42`	`)`
`47`	`43`	`{`
`48`	`44`	`_serviceProvider = serviceProvider;`
`49`	`45`	`_logger = logger;`
`50`		`- _tracer = tracer;`
`51`	`46`	`_discordOptions = discordOptions;`
`52`	`47`	`_logFactory = logFactory;`
`53`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,6 @@`
`3`	`3`	`using DSharpPlus;`
`4`	`4`	`using Microsoft.Extensions.DependencyInjection;`
`5`	`5`	`using Microsoft.Extensions.DependencyInjection.Extensions;`
`6`		`-using OpenTracing;`
`7`		`-using OpenTracing.Mock;`
`8`	`6`
`9`	`7`	`namespace Nefarius.DSharpPlus.Extensions.Hosting`
`10`	`8`	`{`
`@@ -34,8 +32,6 @@ public static IServiceCollection AddDiscord(`
`34`	`32`	`{`
`35`	`33`	`services.Configure(configure);`
`36`	`34`
`37`		`- services.TryAddSingleton<ITracer>(provider => new MockTracer());`
`38`		`-`
`39`	`35`	`services.TryAddSingleton<IDiscordClientService, DiscordService>();`
`40`	`36`
`41`	`37`	`if (!autoRegisterSubscribers)`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,6 @@ public void Execute(GeneratorExecutionContext context)`
`70`	`70`	`using Microsoft.Extensions.Options;`
`71`	`71`	`using Nefarius.DSharpPlus.Extensions.Hosting.Util;`
`72`	`72`	`using Nefarius.DSharpPlus.Extensions.Hosting.Events;`
`73`		`-using OpenTracing;`
`74`	`73`
`75`	`74`	`namespace Nefarius.DSharpPlus.Extensions.Hosting`
`76`	`75`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`	`using DSharpPlus.EventArgs;`
`5`	`5`	`using Microsoft.Extensions.Logging;`
`6`	`6`	`using Nefarius.DSharpPlus.Extensions.Hosting.Events;`
`7`		`-using OpenTracing;`
`8`	`7`
`9`	`8`	`namespace WorkerExample`
`10`	`9`	`{`
`@@ -19,16 +18,13 @@ internal class BotModuleForGuildAndMemberEvents :`
`19`	`18`	`{`
`20`	`19`	`private readonly ILogger<BotModuleForGuildAndMemberEvents> _logger;`
`21`	`20`
`22`		`- private readonly ITracer _tracer;`
`23`		`-`
`24`	`21`	`/// <summary>`
`25`	`22`	`/// Optional constructor for Dependency Injection. parameters get populated automatically with you services.`
`26`	`23`	`/// </summary>`
`27`	`24`	`/// <param name="logger">The logger service instance.</param>`
`28`	`25`	`/// <param name="tracer">The tracer service instance.</param>`
`29`	`26`	`public BotModuleForGuildAndMemberEvents(`
`30`		`- ILogger<BotModuleForGuildAndMemberEvents> logger,`
`31`		`- ITracer tracer`
	`27`	`+ ILogger<BotModuleForGuildAndMemberEvents> logger`
`32`	`28`	`)`
`33`	`29`	`{`
`34`	`30`	`//`
`@@ -38,7 +34,6 @@ ITracer tracer`
`38`	`34`	`// You can inject scoped services like database contexts as well!`
`39`	`35`	`//`
`40`	`36`	`_logger = logger;`
`41`		`- _tracer = tracer;`
`42`	`37`	`}`
`43`	`38`
`44`	`39`	`public Task DiscordOnGuildAvailable(DiscordClient sender, GuildCreateEventArgs args)`