Update Logging to Structured.

[paulomorgado]

Found multiple occurrences of CA2254 in the code base.

This is detected when:

A message template passed to a logger API is not constant. This occurs when the template passed uses either string concatenation or interpolation. Instead, the template should be a constant value that represents the log message in message template format. For example: "User {User} logged in from {Address}". For more information, see Log message template formatting.

Using semantic logging with Microsoft.Extensions.Logging offers several advantages over simple string concatenation. Here are some key points, supported by documentation:

Performance Efficiency

String concatenation in logging can be inefficient, especially when logging is disabled. The concatenation operation still occurs, consuming resources unnecessarily. Semantic logging, on the other hand, uses structured logging, which avoids this overhead by deferring the creation of the log message until it's actually needed.

Structured Data

Semantic logging allows you to log structured data, which can be easily parsed and analyzed by logging systems. This means you can include properties and context in your logs, making it easier to filter and search through logs based on specific criteria. For example:

logger.LogInformation("User {UserId} logged in at {LoginTime}", userId, loginTime);

This logs the UserId and LoginTime as separate properties, which can be queried independently.

Consistency and Readability

Using semantic logging ensures that log messages are consistent and readable. It separates the message template from the actual values, making it easier to maintain and understand the logs. This is particularly useful in large applications where multiple developers are contributing to the logging.

Enhanced Debugging and Monitoring

Semantic logging integrates well with various logging backends and monitoring tools like Application Insights, Kibana, and Seq. These tools can leverage the structured data to provide more insightful analytics and visualizations, helping in quicker diagnosis and resolution of issues.

Security

String concatenation can introduce security risks, such as injection attacks, if not handled properly. Semantic logging mitigates these risks by treating the message template and values separately, reducing the chances of malicious data being logged.

Flexibility and Extensibility

Microsoft.Extensions.Logging provides a flexible and extensible logging framework that supports multiple logging providers. This means you can easily switch or add new logging providers without changing your logging code2.

Example Comparison

##String Concatenation

logger.LogInformation("User " + userId + " logged in at " + loginTime);

Semantic Logging

logger.LogInformation("User {UserId} logged in at {LoginTime}", userId, loginTime);

In summary, semantic logging with Microsoft.Extensions.Logging offers significant benefits in terms of performance, structure, readability, security, and integration with monitoring tools, making it a superior choice over simple string concatenation for logging purposes.

References

• Logging in .NET Core and ASP.NET Core