chore(logging): Updated log messages for consistancy

rlabbeptc · rlabbeptc · commit 7da2cf18cb93 · 2025-07-21T16:16:03.000-04:00
diff --git a/Kepware.Api/ClientHandler/AdminApiHandler.cs b/Kepware.Api/ClientHandler/AdminApiHandler.cs
@@ -88,7 +88,7 @@ public async Task<bool> SetAdminSettingsAsync(AdminSettings settings, Cancellati
             }
             catch (HttpRequestException httpEx)
             {
-                m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);
+                m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);
                 m_kepwareApiClient.OnHttpRequestException(httpEx);
             }
 
@@ -148,7 +148,7 @@ public async Task<bool> CreateOrUpdateUaEndpointAsync(UaEndpoint endpoint, Cance
             }
             catch (HttpRequestException httpEx)
             {
-                m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);
+                m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);
                 m_kepwareApiClient.OnHttpRequestException(httpEx);
             }
 
@@ -217,7 +217,7 @@ public async Task<bool> CreateOrUpdateServerUserGroupAsync(ServerUserGroup userG
             }
             catch (HttpRequestException httpEx)
             {
-                m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);
+                m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);
                 m_kepwareApiClient.OnHttpRequestException(httpEx);
             }
 
@@ -295,7 +295,7 @@ public async Task<bool> CreateOrUpdateServerUserAsync(ServerUser user, Cancellat
             }
             catch (HttpRequestException httpEx)
             {
-                m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);
+                m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);
                 m_kepwareApiClient.OnHttpRequestException(httpEx);
             }
 
@@ -384,7 +384,7 @@ public async Task<bool> UpdateProjectPermissionAsync(string serverUserGroupName,
             }
             catch (HttpRequestException httpEx)
             {
-                m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);
+                m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);
                 m_kepwareApiClient.OnHttpRequestException(httpEx);
             }
 
diff --git a/Kepware.Api/KepwareApiClient.cs b/Kepware.Api/KepwareApiClient.cs
@@ -164,7 +164,7 @@ await response.Content.ReadAsStreamAsync(cancellationToken).ConfigureAwait(false
             catch (HttpRequestException httpEx)
             {
                 if (m_isConnected == null || m_isConnected == true) // first time after connection change or when connection is lost
-                    m_logger.LogWarning(httpEx, "Failed to connect to {ClientName}-client at {BaseAddress}", ClientName, m_httpClient.BaseAddress);
+                    m_logger.LogWarning("Failed to connect to {ClientName}-client at {BaseAddress}, Reason: {Message}", ClientName, m_httpClient.BaseAddress, httpEx.Message);
             }
             m_isConnected = blnIsConnected;
             return blnIsConnected && m_hasValidCredentials == true;

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public async Task<bool> SetAdminSettingsAsync(AdminSettings settings, Cancellati`
`88`	`88`	`}`
`89`	`89`	`catch (HttpRequestException httpEx)`
`90`	`90`	`{`
`91`		`- m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);`
	`91`	`+ m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);`
`92`	`92`	`m_kepwareApiClient.OnHttpRequestException(httpEx);`
`93`	`93`	`}`
`94`	`94`
`@@ -148,7 +148,7 @@ public async Task<bool> CreateOrUpdateUaEndpointAsync(UaEndpoint endpoint, Cance`
`148`	`148`	`}`
`149`	`149`	`catch (HttpRequestException httpEx)`
`150`	`150`	`{`
`151`		`- m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);`
	`151`	`+ m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);`
`152`	`152`	`m_kepwareApiClient.OnHttpRequestException(httpEx);`
`153`	`153`	`}`
`154`	`154`
`@@ -217,7 +217,7 @@ public async Task<bool> CreateOrUpdateServerUserGroupAsync(ServerUserGroup userG`
`217`	`217`	`}`
`218`	`218`	`catch (HttpRequestException httpEx)`
`219`	`219`	`{`
`220`		`- m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);`
	`220`	`+ m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);`
`221`	`221`	`m_kepwareApiClient.OnHttpRequestException(httpEx);`
`222`	`222`	`}`
`223`	`223`
`@@ -295,7 +295,7 @@ public async Task<bool> CreateOrUpdateServerUserAsync(ServerUser user, Cancellat`
`295`	`295`	`}`
`296`	`296`	`catch (HttpRequestException httpEx)`
`297`	`297`	`{`
`298`		`- m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);`
	`298`	`+ m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);`
`299`	`299`	`m_kepwareApiClient.OnHttpRequestException(httpEx);`
`300`	`300`	`}`
`301`	`301`
`@@ -384,7 +384,7 @@ public async Task<bool> UpdateProjectPermissionAsync(string serverUserGroupName,`
`384`	`384`	`}`
`385`	`385`	`catch (HttpRequestException httpEx)`
`386`	`386`	`{`
`387`		`- m_logger.LogWarning(httpEx, "Failed to connect to {BaseAddress}", m_kepwareApiClient.HttpClient.BaseAddress);`
	`387`	`+ m_logger.LogWarning("Failed to connect to {BaseAddress}, Reason: {Message}", m_kepwareApiClient.HttpClient.BaseAddress, httpEx.Message);`
`388`	`388`	`m_kepwareApiClient.OnHttpRequestException(httpEx);`
`389`	`389`	`}`
`390`	`390`
Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ await response.Content.ReadAsStreamAsync(cancellationToken).ConfigureAwait(false`
`164`	`164`	`catch (HttpRequestException httpEx)`
`165`	`165`	`{`
`166`	`166`	`if (m_isConnected == null \|\| m_isConnected == true) // first time after connection change or when connection is lost`
`167`		`- m_logger.LogWarning(httpEx, "Failed to connect to {ClientName}-client at {BaseAddress}", ClientName, m_httpClient.BaseAddress);`
	`167`	`+ m_logger.LogWarning("Failed to connect to {ClientName}-client at {BaseAddress}, Reason: {Message}", ClientName, m_httpClient.BaseAddress, httpEx.Message);`
`168`	`168`	`}`
`169`	`169`	`m_isConnected = blnIsConnected;`
`170`	`170`	`return blnIsConnected && m_hasValidCredentials == true;`