Use a NetworkOperationKind enum to avoid string allocations

jstedfast · May 12, 2024 · c69fa42 · c69fa42
1 parent 2dc2e16
commit c69fa42
Show file tree

Hide file tree

Showing 9 changed files with 61 additions and 46 deletions.
diff --git a/MailKit/Net/Imap/AsyncImapClient.cs b/MailKit/Net/Imap/AsyncImapClient.cs
@@ -312,7 +312,7 @@ public override async Task AuthenticateAsync (SaslMechanism mechanism, Cancellat
 				await imap.Stream.FlushAsync (cmd.CancellationToken).ConfigureAwait (false);
 			};
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				detector.IsAuthenticating = true;
@@ -393,7 +393,7 @@ public override async Task AuthenticateAsync (Encoding encoding, ICredentials cr
 		{
 			CheckCanAuthenticate (encoding, credentials);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				int capabilitiesVersion = engine.CapabilitiesVersion;
@@ -653,7 +653,7 @@ public override async Task ConnectAsync (string host, int port = 0, SecureSocket
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				var stream = await ConnectNetworkAsync (host, port, cancellationToken).ConfigureAwait (false);
@@ -827,7 +827,7 @@ public override async Task ConnectAsync (Stream stream, string host, int port =
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				Stream network;

diff --git a/MailKit/Net/Imap/ImapClient.cs b/MailKit/Net/Imap/ImapClient.cs
@@ -1137,7 +1137,7 @@ public override void Authenticate (SaslMechanism mechanism, CancellationToken ca
 				return Task.CompletedTask;
 			};
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				detector.IsAuthenticating = true;
@@ -1242,7 +1242,7 @@ public override void Authenticate (Encoding encoding, ICredentials credentials,
 		{
 			CheckCanAuthenticate (encoding, credentials);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				int capabilitiesVersion = engine.CapabilitiesVersion;
@@ -1561,7 +1561,7 @@ public override void Connect (string host, int port = 0, SecureSocketOptions opt
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				var stream = ConnectNetwork (host, port, cancellationToken);
@@ -1746,7 +1746,7 @@ public override void Connect (Stream stream, string host, int port = 0, SecureSo
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				Stream network;

diff --git a/MailKit/Net/Imap/ImapEngine.cs b/MailKit/Net/Imap/ImapEngine.cs
@@ -619,12 +619,12 @@ internal void SetStream (ImapStream stream)
 			Stream = stream;
 		}
 
-		public NetworkOperation StartNetworkOperation (string name)
+		public NetworkOperation StartNetworkOperation (NetworkOperationKind kind)
 		{
 #if NET6_0_OR_GREATER
-			return NetworkOperation.Start (name, Uri, Telemetry.ImapClient.ActivitySource, metrics);
+			return NetworkOperation.Start (kind, Uri, Telemetry.ImapClient.ActivitySource, metrics);
 #else
-			return NetworkOperation.Start (name, Uri);
+			return NetworkOperation.Start (kind, Uri);
 #endif
 		}
 

diff --git a/MailKit/Net/NetworkOperation.cs b/MailKit/Net/NetworkOperation.cs
@@ -28,22 +28,37 @@
 using System.Diagnostics;
 
 namespace MailKit.Net {
-	class NetworkOperation : IDisposable
+	enum NetworkOperationKind
 	{
-		public const string Authenticate = nameof (Authenticate);
-		public const string Connect = nameof (Connect);
+		Authenticate,
+		Connect,
+		Send
+	}
 
+	class NetworkOperation : IDisposable
+	{
 #if NET6_0_OR_GREATER
+		static readonly string[] ActivityNames = {
+			"Authenticate",
+			"Connect",
+			"Send"
+		};
+		static readonly string[] OperationValues = {
+			"authenticate",
+			"connect",
+			"send"
+		};
+
+		readonly NetworkOperationKind kind;
 		readonly ClientMetrics metrics;
 		readonly Activity activity;
 		readonly long startTimestamp;
-		readonly string name;
 		readonly Uri uri;
 		Exception ex;
 
-		NetworkOperation (string name, Uri uri, Activity activity, ClientMetrics metrics)
+		NetworkOperation (NetworkOperationKind kind, Uri uri, Activity activity, ClientMetrics metrics)
 		{
-			this.name = name;
+			this.kind = kind;
 			this.uri = uri;
 			this.activity = activity;
 			this.metrics = metrics;
@@ -75,7 +90,7 @@ TagList GetTags ()
 		{
 			var tags = ClientMetrics.GetTags (uri, ex);
 
-			tags.Add ("network.operation", name.ToLowerInvariant ());
+			tags.Add ("network.operation", OperationValues[(int) kind]);
 
 			return tags;
 		}
@@ -109,15 +124,15 @@ public void Dispose ()
 		}
 
 #if NET6_0_OR_GREATER
-		public static NetworkOperation Start (string name, Uri uri, ActivitySource source, ClientMetrics metrics)
+		public static NetworkOperation Start (NetworkOperationKind kind, Uri uri, ActivitySource source, ClientMetrics metrics)
 		{
 
-			var activity = source?.StartActivity (name, ActivityKind.Client);
+			var activity = source?.StartActivity (ActivityNames[(int) kind], ActivityKind.Client);
 
-			return new NetworkOperation (name, uri, activity, metrics);
+			return new NetworkOperation (kind, uri, activity, metrics);
 		}
 #else
-		public static NetworkOperation Start (string name, Uri uri)
+		public static NetworkOperation Start (NetworkOperationKind kind, Uri uri)
 		{
 			return new NetworkOperation ();
 		}

diff --git a/MailKit/Net/Pop3/AsyncPop3Client.cs b/MailKit/Net/Pop3/AsyncPop3Client.cs
@@ -141,7 +141,7 @@ public override async Task AuthenticateAsync (SaslMechanism mechanism, Cancellat
 		{
 			CheckCanAuthenticate (mechanism, cancellationToken);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				var saslUri = new Uri ("pop://" + engine.Uri.Host);
@@ -223,7 +223,7 @@ public override async Task AuthenticateAsync (Encoding encoding, ICredentials cr
 		{
 			CheckCanAuthenticate (encoding, credentials, cancellationToken);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				var saslUri = new Uri ("pop://" + engine.Uri.Host);
@@ -425,7 +425,7 @@ public override async Task ConnectAsync (string host, int port = 0, SecureSocket
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				var stream = await ConnectNetworkAsync (host, port, cancellationToken).ConfigureAwait (false);
@@ -601,7 +601,7 @@ public override async Task ConnectAsync (Stream stream, string host, int port =
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				engine.Uri = uri;

diff --git a/MailKit/Net/Pop3/Pop3Client.cs b/MailKit/Net/Pop3/Pop3Client.cs
@@ -822,7 +822,7 @@ public override void Authenticate (SaslMechanism mechanism, CancellationToken ca
 		{
 			CheckCanAuthenticate (mechanism, cancellationToken);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				var saslUri = new Uri ("pop://" + engine.Uri.Host);
@@ -938,7 +938,7 @@ public override void Authenticate (Encoding encoding, ICredentials credentials,
 		{
 			CheckCanAuthenticate (encoding, credentials, cancellationToken);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				var saslUri = new Uri ("pop://" + engine.Uri.Host);
@@ -1199,7 +1199,7 @@ public override void Connect (string host, int port = 0, SecureSocketOptions opt
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				var stream = ConnectNetwork (host, port, cancellationToken);
@@ -1392,7 +1392,7 @@ public override void Connect (Stream stream, string host, int port = 0, SecureSo
 
 			ComputeDefaultValues (host, ref port, ref options, out var uri, out var starttls);
 
-			using var operation = engine.StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = engine.StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				engine.Uri = uri;

diff --git a/MailKit/Net/Pop3/Pop3Engine.cs b/MailKit/Net/Pop3/Pop3Engine.cs
@@ -251,12 +251,12 @@ void ParseGreeting (string greeting)
 			State = Pop3EngineState.Connected;
 		}
 
-		public NetworkOperation StartNetworkOperation (string name)
+		public NetworkOperation StartNetworkOperation (NetworkOperationKind kind)
 		{
 #if NET6_0_OR_GREATER
-			return NetworkOperation.Start (name, Uri, Telemetry.Pop3Client.ActivitySource, metrics);
+			return NetworkOperation.Start (kind, Uri, Telemetry.Pop3Client.ActivitySource, metrics);
 #else
-			return NetworkOperation.Start (name, Uri);
+			return NetworkOperation.Start (kind, Uri);
 #endif
 		}
 

diff --git a/MailKit/Net/Smtp/AsyncSmtpClient.cs b/MailKit/Net/Smtp/AsyncSmtpClient.cs
@@ -209,7 +209,7 @@ public override async Task AuthenticateAsync (SaslMechanism mechanism, Cancellat
 
 			cancellationToken.ThrowIfCancellationRequested ();
 
-			using var operation = StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				SaslException saslException = null;
@@ -328,7 +328,7 @@ public override async Task AuthenticateAsync (Encoding encoding, ICredentials cr
 		{
 			ValidateArguments (encoding, credentials);
 
-			using var operation = StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				var saslUri = new Uri ($"smtp://{uri.Host}");
@@ -568,7 +568,7 @@ public override async Task ConnectAsync (string host, int port = 0, SecureSocket
 
 			ComputeDefaultValues (host, ref port, ref options, out uri, out var starttls);
 
-			using var operation = StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				var stream = await ConnectNetworkAsync (host, port, cancellationToken).ConfigureAwait (false);
@@ -742,7 +742,7 @@ public override async Task ConnectAsync (Stream stream, string host, int port =
 
 			ComputeDefaultValues (host, ref port, ref options, out uri, out var starttls);
 
-			using var operation = StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				Stream network;
@@ -984,7 +984,7 @@ async Task<string> SendAsync (FormatOptions options, MimeMessage message, Mailbo
 				size = -1;
 			}
 
-			using var operation = StartNetworkOperation ("Send");
+			using var operation = StartNetworkOperation (NetworkOperationKind.Send);
 
 			try {
 				// Note: if PIPELINING is supported, MailFrom() and RcptTo() will

diff --git a/MailKit/Net/Smtp/SmtpClient.cs b/MailKit/Net/Smtp/SmtpClient.cs
@@ -594,12 +594,12 @@ void CheckDisposed ()
 			get { return authenticated; }
 		}
 
-		NetworkOperation StartNetworkOperation (string name)
+		NetworkOperation StartNetworkOperation (NetworkOperationKind kind)
 		{
 #if NET6_0_OR_GREATER
-			return NetworkOperation.Start (name, uri, Telemetry.SmtpClient.ActivitySource, metrics);
+			return NetworkOperation.Start (kind, uri, Telemetry.SmtpClient.ActivitySource, metrics);
 #else
-			return NetworkOperation.Start (name, uri);
+			return NetworkOperation.Start (kind, uri);
 #endif
 		}
 
@@ -1032,7 +1032,7 @@ public override void Authenticate (SaslMechanism mechanism, CancellationToken ca
 
 			cancellationToken.ThrowIfCancellationRequested ();
 
-			using var operation = StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				SaslException saslException = null;
@@ -1170,7 +1170,7 @@ public override void Authenticate (Encoding encoding, ICredentials credentials,
 		{
 			ValidateArguments (encoding, credentials);
 
-			using var operation = StartNetworkOperation (NetworkOperation.Authenticate);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Authenticate);
 
 			try {
 				var saslUri = new Uri ($"smtp://{uri.Host}");
@@ -1477,7 +1477,7 @@ public override void Connect (string host, int port = 0, SecureSocketOptions opt
 
 			ComputeDefaultValues (host, ref port, ref options, out uri, out var starttls);
 
-			using var operation = StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				var stream = ConnectNetwork (host, port, cancellationToken);
@@ -1668,7 +1668,7 @@ public override void Connect (Stream stream, string host, int port = 0, SecureSo
 
 			ComputeDefaultValues (host, ref port, ref options, out uri, out var starttls);
 
-			using var operation = StartNetworkOperation (NetworkOperation.Connect);
+			using var operation = StartNetworkOperation (NetworkOperationKind.Connect);
 
 			try {
 				Stream network;
@@ -2441,7 +2441,7 @@ string Send (FormatOptions options, MimeMessage message, MailboxAddress sender,
 				size = -1;
 			}
 
-			using var operation = StartNetworkOperation ("Send");
+			using var operation = StartNetworkOperation (NetworkOperationKind.Send);
 
 			try {
 				// Note: if PIPELINING is supported, MailFrom() and RcptTo() will