feat(csharp): Add logs (generated)

algolia-bot · MarioAlexandruDan · algolia-bot · commit 2988c9cca5c2 · 2026-03-31T12:06:49.000Z
algolia/api-clients-automation#6090 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Mario-Alexandru Dan <marioalexandrudan@gmail.com>
diff --git a/algoliasearch/Clients/AbtestingClient.cs b/algoliasearch/Clients/AbtestingClient.cs
@@ -876,7 +876,17 @@ public AbtestingClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Abtesting client is initialized.");
+      _logger.LogInformation("Algolia Abtesting client initialized (appId: {AppId})", config.AppId);
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/AbtestingV3Client.cs b/algoliasearch/Clients/AbtestingV3Client.cs
@@ -984,7 +984,20 @@ public AbtestingV3Client(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia AbtestingV3 client is initialized.");
+      _logger.LogInformation(
+        "Algolia AbtestingV3 client initialized (appId: {AppId})",
+        config.AppId
+      );
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/AlgoliaConfig.cs b/algoliasearch/Clients/AlgoliaConfig.cs
@@ -1,10 +1,13 @@
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Runtime.CompilerServices;
 using Algolia.Search.Http;
 using Algolia.Search.Models.Common;
 using Algolia.Search.Serializer;
 using Algolia.Search.Transport;
 using Algolia.Search.Utils;
+using Microsoft.Extensions.Logging;
 
 namespace Algolia.Search.Clients
 {
@@ -108,5 +111,15 @@ public void SetClientApiKey(string apiKey)
       ApiKey = apiKey;
       DefaultHeaders[Defaults.AlgoliaApiKeyHeader.ToLowerInvariant()] = apiKey;
     }
+
+    private static readonly ConcurrentDictionary<int, byte> _warnedFactories = new();
+
+    /// <summary>
+    /// Returns true the first time a given loggerFactory triggers the debug warning, false on subsequent calls.
+    /// </summary>
+    internal static bool TryMarkDebugWarningLogged(ILoggerFactory loggerFactory)
+    {
+      return _warnedFactories.TryAdd(RuntimeHelpers.GetHashCode(loggerFactory), 0);
+    }
   }
 }
diff --git a/algoliasearch/Clients/AnalyticsClient.cs b/algoliasearch/Clients/AnalyticsClient.cs
@@ -2588,7 +2588,17 @@ public AnalyticsClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Analytics client is initialized.");
+      _logger.LogInformation("Algolia Analytics client initialized (appId: {AppId})", config.AppId);
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/CompositionClient.cs b/algoliasearch/Clients/CompositionClient.cs
@@ -1586,7 +1586,20 @@ public CompositionClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Composition client is initialized.");
+      _logger.LogInformation(
+        "Algolia Composition client initialized (appId: {AppId})",
+        config.AppId
+      );
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/IngestionClient.cs b/algoliasearch/Clients/IngestionClient.cs
@@ -5628,7 +5628,17 @@ public IngestionClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Ingestion client is initialized.");
+      _logger.LogInformation("Algolia Ingestion client initialized (appId: {AppId})", config.AppId);
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/InsightsClient.cs b/algoliasearch/Clients/InsightsClient.cs
@@ -548,7 +548,17 @@ public InsightsClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Insights client is initialized.");
+      _logger.LogInformation("Algolia Insights client initialized (appId: {AppId})", config.AppId);
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/MonitoringClient.cs b/algoliasearch/Clients/MonitoringClient.cs
@@ -950,7 +950,20 @@ public MonitoringClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Monitoring client is initialized.");
+      _logger.LogInformation(
+        "Algolia Monitoring client initialized (appId: {AppId})",
+        config.AppId
+      );
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/PersonalizationClient.cs b/algoliasearch/Clients/PersonalizationClient.cs
@@ -692,7 +692,20 @@ public PersonalizationClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Personalization client is initialized.");
+      _logger.LogInformation(
+        "Algolia Personalization client initialized (appId: {AppId})",
+        config.AppId
+      );
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/QuerySuggestionsClient.cs b/algoliasearch/Clients/QuerySuggestionsClient.cs
@@ -928,7 +928,20 @@ public QuerySuggestionsClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia QuerySuggestions client is initialized.");
+      _logger.LogInformation(
+        "Algolia QuerySuggestions client initialized (appId: {AppId})",
+        config.AppId
+      );
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/RecommendClient.cs b/algoliasearch/Clients/RecommendClient.cs
@@ -926,7 +926,17 @@ public RecommendClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Recommend client is initialized.");
+      _logger.LogInformation("Algolia Recommend client initialized (appId: {AppId})", config.AppId);
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Clients/SearchClient.cs b/algoliasearch/Clients/SearchClient.cs
@@ -5204,7 +5204,17 @@ public SearchClient(
 
     if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))
     {
-      _logger.LogInformation("Algolia Search client is initialized.");
+      _logger.LogInformation("Algolia Search client initialized (appId: {AppId})", config.AppId);
+    }
+
+    if (
+      _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)
+      && AlgoliaConfig.TryMarkDebugWarningLogged(factory)
+    )
+    {
+      _logger.LogDebug(
+        "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."
+      );
     }
   }
 
diff --git a/algoliasearch/Http/AlgoliaHttpRequester.cs b/algoliasearch/Http/AlgoliaHttpRequester.cs
@@ -1,5 +1,7 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Threading;
@@ -85,12 +87,18 @@ public async Task<AlgoliaHttpResponse> SendRequestAsync(
       {
         using (var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false))
         {
+          var responseHeaders = response.Headers.ToDictionary(
+            h => h.Key,
+            h => string.Join(", ", h.Value)
+          );
+
           if (!response.IsSuccessStatusCode)
           {
             return new AlgoliaHttpResponse
             {
               Error = await StreamToStringAsync(stream),
               HttpStatusCode = (int)response.StatusCode,
+              ResponseHeaders = responseHeaders,
             };
           }
 
@@ -102,6 +110,7 @@ public async Task<AlgoliaHttpResponse> SendRequestAsync(
           {
             Body = outputStream,
             HttpStatusCode = (int)response.StatusCode,
+            ResponseHeaders = responseHeaders,
           };
         }
       }
diff --git a/algoliasearch/Http/AlgoliaHttpResponse.cs b/algoliasearch/Http/AlgoliaHttpResponse.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using System.IO;
 
 namespace Algolia.Search.Http;
@@ -7,6 +8,11 @@ namespace Algolia.Search.Http;
 /// </summary>
 public class AlgoliaHttpResponse
 {
+  /// <summary>
+  /// Http response headers
+  /// </summary>
+  public IDictionary<string, string> ResponseHeaders { get; set; }
+
   /// <summary>
   /// Http response code
   /// </summary>
diff --git a/algoliasearch/Serializer/DefaultSerializer.cs b/algoliasearch/Serializer/DefaultSerializer.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Diagnostics;
 using System.IO;
 using System.Text.Json;
 using System.Threading.Tasks;
@@ -20,27 +21,39 @@ internal class DefaultJsonSerializer(ILoggerFactory logger) : ISerializer
   /// <returns>A JSON string.</returns>
   public string Serialize(object data)
   {
+    var sw = Stopwatch.StartNew();
     try
     {
+      string result;
       if (data is not AbstractSchema schema)
       {
-        return JsonSerializer.Serialize(data, JsonConfig.Options);
+        result = JsonSerializer.Serialize(data, JsonConfig.Options);
       }
+      else
+      {
+        // the object to be serialized is a oneOf/anyOf schema
+        result = schema.ToJson();
+      }
+
+      _logger.LogDebug("Request body serialized in {Duration}ms", sw.ElapsedMilliseconds);
 
-      // the object to be serialized is a oneOf/anyOf schema
-      return schema.ToJson();
+      return result;
     }
     catch (Exception ex)
     {
       var dataType = data?.GetType()?.ToString() ?? "unknown";
 
       if (_logger.IsEnabled(LogLevel.Error))
       {
-        _logger.LogError(ex, "Error while serializing object of type {Type}", dataType);
+        _logger.LogError(ex, "Serialization error for type {Type}", dataType);
       }
 
       throw new AlgoliaException($"Error while serializing object of type {dataType}", ex);
     }
+    finally
+    {
+      sw.Stop();
+    }
   }
 
   public async Task<T> Deserialize<T>(Stream response)
@@ -57,23 +70,32 @@ public async Task<T> Deserialize<T>(Stream response)
   /// <returns>Object representation of the JSON string.</returns>
   private async Task<object> Deserialize(Stream response, Type type)
   {
+    var sw = Stopwatch.StartNew();
     try
     {
       using var reader = new StreamReader(response);
       var readToEndAsync = await reader.ReadToEndAsync().ConfigureAwait(false);
 
-      return string.IsNullOrEmpty(readToEndAsync)
+      var result = string.IsNullOrEmpty(readToEndAsync)
         ? null
         : JsonSerializer.Deserialize(readToEndAsync, type, JsonConfig.Options);
+
+      _logger.LogDebug("Response body deserialized in {Duration}ms", sw.ElapsedMilliseconds);
+
+      return result;
     }
     catch (Exception ex)
     {
       if (_logger.IsEnabled(LogLevel.Error))
       {
-        _logger.LogError(ex, "Error while deserializing response of type {Type}", type);
+        _logger.LogError(ex, "Failed to deserialize response of type {Type}", type);
       }
 
       throw new AlgoliaException($"Error while deserializing response of type {type}", ex);
     }
+    finally
+    {
+      sw.Stop();
+    }
   }
 }
diff --git a/algoliasearch/Transport/HttpTransport.cs b/algoliasearch/Transport/HttpTransport.cs
diff --git a/algoliasearch/Utils/IngestionClientExtensions.cs b/algoliasearch/Utils/IngestionClientExtensions.cs
diff --git a/algoliasearch/Utils/SearchClientExtensions.cs b/algoliasearch/Utils/SearchClientExtensions.cs

Original file line number	Diff line number	Diff line change
`@@ -876,7 +876,17 @@ public AbtestingClient(`
`876`	`876`
`877`	`877`	`if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))`
`878`	`878`	`{`
`879`		`- _logger.LogInformation("Algolia Abtesting client is initialized.");`
	`879`	`+ _logger.LogInformation("Algolia Abtesting client initialized (appId: {AppId})", config.AppId);`
	`880`	`+ }`
	`881`	`+`
	`882`	`+ if (`
	`883`	`+ _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)`
	`884`	`+ && AlgoliaConfig.TryMarkDebugWarningLogged(factory)`
	`885`	`+ )`
	`886`	`+ {`
	`887`	`+ _logger.LogDebug(`
	`888`	`+ "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."`
	`889`	`+ );`
`880`	`890`	`}`
`881`	`891`	`}`
`882`	`892`
Original file line number	Diff line number	Diff line change
`@@ -2588,7 +2588,17 @@ public AnalyticsClient(`
`2588`	`2588`
`2589`	`2589`	`if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))`
`2590`	`2590`	`{`
`2591`		`- _logger.LogInformation("Algolia Analytics client is initialized.");`
	`2591`	`+ _logger.LogInformation("Algolia Analytics client initialized (appId: {AppId})", config.AppId);`
	`2592`	`+ }`
	`2593`	`+`
	`2594`	`+ if (`
	`2595`	`+ _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)`
	`2596`	`+ && AlgoliaConfig.TryMarkDebugWarningLogged(factory)`
	`2597`	`+ )`
	`2598`	`+ {`
	`2599`	`+ _logger.LogDebug(`
	`2600`	`+ "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."`
	`2601`	`+ );`
`2592`	`2602`	`}`
`2593`	`2603`	`}`
`2594`	`2604`
Original file line number	Diff line number	Diff line change
`@@ -5628,7 +5628,17 @@ public IngestionClient(`
`5628`	`5628`
`5629`	`5629`	`if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))`
`5630`	`5630`	`{`
`5631`		`- _logger.LogInformation("Algolia Ingestion client is initialized.");`
	`5631`	`+ _logger.LogInformation("Algolia Ingestion client initialized (appId: {AppId})", config.AppId);`
	`5632`	`+ }`
	`5633`	`+`
	`5634`	`+ if (`
	`5635`	`+ _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)`
	`5636`	`+ && AlgoliaConfig.TryMarkDebugWarningLogged(factory)`
	`5637`	`+ )`
	`5638`	`+ {`
	`5639`	`+ _logger.LogDebug(`
	`5640`	`+ "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."`
	`5641`	`+ );`
`5632`	`5642`	`}`
`5633`	`5643`	`}`
`5634`	`5644`
Original file line number	Diff line number	Diff line change
`@@ -548,7 +548,17 @@ public InsightsClient(`
`548`	`548`
`549`	`549`	`if (_logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Information))`
`550`	`550`	`{`
`551`		`- _logger.LogInformation("Algolia Insights client is initialized.");`
	`551`	`+ _logger.LogInformation("Algolia Insights client initialized (appId: {AppId})", config.AppId);`
	`552`	`+ }`
	`553`	`+`
	`554`	`+ if (`
	`555`	`+ _logger.IsEnabled(Microsoft.Extensions.Logging.LogLevel.Debug)`
	`556`	`+ && AlgoliaConfig.TryMarkDebugWarningLogged(factory)`
	`557`	`+ )`
	`558`	`+ {`
	`559`	`+ _logger.LogDebug(`
	`560`	`+ "WARNING: DEBUG level logging is enabled. This logs full request/response bodies which may contain sensitive data. Only use in local development."`
	`561`	`+ );`
`552`	`562`	`}`
`553`	`563`	`}`
`554`	`564`