feat: add serilog logging

[kshitij-k-osmosys]

Description

Add console and file logging using serilog
Log file is present in ./DotnetFoundation.Api/Logs/log-{timestamp}.ndjson

Followed recommended format
Reference for expressionTemplate: https://nblumhardt.com/2021/06/customize-serilog-json-output/#:~:text=Tip%3A%20output,.Code

Osmosys coding standards: https://github.com/OsmosysSoftware/dev-standards/blob/main/coding-standards/log-format.md

Log output using serilog expressionTemplate

{"Timestamp":"2024-03-26T19:51:04.1683766+05:30","Level":"Information","TracebackId":"6e8b492067a8908b680e9520092a765f","RequestPath":"/swagger/v1/swagger.json","StatusCode":200,"SourceContext":"Microsoft.AspNetCore.Hosting.Diagnostics","Data":{"EventId":1948596947,"RequestId":"0HN2DJVRNB7QH:00000003"},"Message":"Request finished HTTP/1.1 GET http://localhost:5000/swagger/v1/swagger.json - 200 null application/json;charset=utf-8 260.5326ms"}

{"Timestamp":"2024-03-26T19:51:11.2268782+05:30","Level":"Information","TracebackId":"6f06532a7cba78ddd9b6bc25c5f479d7","RequestPath":"/api/tasks","SourceContext":"Microsoft.AspNetCore.Hosting.Diagnostics","Data":{"EventId":3574200426,"RequestId":"0HN2DJVRNB7QH:00000004"},"Message":"Request starting HTTP/1.1 GET http://localhost:5000/api/tasks - null null"}

{"Timestamp":"2024-03-26T19:51:11.2658494+05:30","Level":"Warning","TracebackId":"6f06532a7cba78ddd9b6bc25c5f479d7","RequestPath":"/api/tasks","SourceContext":"Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionMiddleware","Data":{"EventId":3396783137,"RequestId":"0HN2DJVRNB7QH:00000004"},"Message":"Failed to determine the https port for redirect."}

{"Timestamp":"2024-03-26T19:51:20.0705410+05:30","Level":"Error","TracebackId":"6f06532a7cba78ddd9b6bc25c5f479d7","RequestMethod":"GET","RequestPath":"/api/tasks","StatusCode":500,"SourceContext":"Serilog.AspNetCore.RequestLoggingMiddleware","Data":{"EventId":1657833564},"Message":"HTTP GET /api/tasks responded 500 in 8792.4283 ms","Exception":"MySqlConnector.MySqlException (0x80004005): Unable to connect to any of the specified MySQL hosts.\r\n   at MySqlConnector.Core.ServerSession.ConnectAsync(ConnectionSettings cs, MySqlConnection connection, Int64 startingTimestamp, ILoadBalancer loadBalancer, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ServerSession.cs:line 437\r\n   at MySqlConnector.Core.ConnectionPool.ConnectSessionAsync(MySqlConnection connection, Action`4 logMessage, Int64 startingTimestamp, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ConnectionPool.cs:line 428\r\n   at MySqlConnector.Core.ConnectionPool.ConnectSessionAsync(MySqlConnection connection, Action`4 logMessage, Int64 startingTimestamp, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ConnectionPool.cs:line 433\r\n   at MySqlConnector.Core.ConnectionPool.GetSessionAsync(MySqlConnection connection, Int64 startingTimestamp, Int32 timeoutMilliseconds, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ConnectionPool.cs:line 111\r\n   at MySqlConnector.Core.ConnectionPool.GetSessionAsync(MySqlConnection connection, Int64 startingTimestamp, Int32 timeoutMilliseconds, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ConnectionPool.cs:line 144\r\n   at MySqlConnector.MySqlConnection.CreateSessionAsync(ConnectionPool pool, Int64 startingTimestamp, Activity activity, Nullable`1 ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/MySqlConnection.cs:line 919\r\n   at MySqlConnector.MySqlConnection.OpenAsync(Nullable`1 ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/MySqlConnection.cs:line 419\r\n   at MySqlConnector.MySqlConnection.Open() in /_/src/MySqlConnector/MySqlConnection.cs:line 381\r\n   at Microsoft.EntityFrameworkCore.ServerVersion.AutoDetect(String connectionString)\r\n   at DotnetFoundation.Infrastructure.DependencyInjection.<>c__DisplayClass0_0.<AddInfrastructure>b__0(DbContextOptionsBuilder options) in d:\\Osmosys\\R&D-X\\dotnet-foundation\\DotnetFoundation\\DotnetFoundation.Infrastructure\\DependencyInjection.cs:line 26\r\n   at Microsoft.Extensions.DependencyInjection.EntityFrameworkServiceCollectionExtensions.<>c__DisplayClass1_0`2.<AddDbContext>b__0(IServiceProvider _, DbContextOptionsBuilder b)\r\n   at Microsoft.Extensions.DependencyInjection.EntityFrameworkServiceCollectionExtensions.CreateDbContextOptions[TContext](IServiceProvider applicationServiceProvider, Action`2 optionsAction)\r\n   at Microsoft.Extensions.DependencyInjection.EntityFrameworkServiceCollectionExtensions.<>c__DisplayClass17_0`1.<AddCoreServices>b__0(IServiceProvider p)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitCache(ServiceCallSite callSite, RuntimeResolverContext context, ServiceProviderEngineScope serviceProviderEngine, RuntimeResolverLock lockType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitScopeCache(ServiceCallSite callSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteVisitor`2.VisitCallSite(ServiceCallSite callSite, TArgument argument)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitConstructor(ConstructorCallSite constructorCallSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitCache(ServiceCallSite callSite, RuntimeResolverContext context, ServiceProviderEngineScope serviceProviderEngine, RuntimeResolverLock lockType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitScopeCache(ServiceCallSite callSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteVisitor`2.VisitCallSite(ServiceCallSite callSite, TArgument argument)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitConstructor(ConstructorCallSite constructorCallSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitCache(ServiceCallSite callSite, RuntimeResolverContext context, ServiceProviderEngineScope serviceProviderEngine, RuntimeResolverLock lockType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitScopeCache(ServiceCallSite callSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteVisitor`2.VisitCallSite(ServiceCallSite callSite, TArgument argument)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitConstructor(ConstructorCallSite constructorCallSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitCache(ServiceCallSite callSite, RuntimeResolverContext context, ServiceProviderEngineScope serviceProviderEngine, RuntimeResolverLock lockType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitScopeCache(ServiceCallSite callSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteVisitor`2.VisitCallSite(ServiceCallSite callSite, TArgument argument)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitConstructor(ConstructorCallSite constructorCallSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitCache(ServiceCallSite callSite, RuntimeResolverContext context, ServiceProviderEngineScope serviceProviderEngine, RuntimeResolverLock lockType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitScopeCache(ServiceCallSite callSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteVisitor`2.VisitCallSite(ServiceCallSite callSite, TArgument argument)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitConstructor(ConstructorCallSite constructorCallSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitCache(ServiceCallSite callSite, RuntimeResolverContext context, ServiceProviderEngineScope serviceProviderEngine, RuntimeResolverLock lockType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.VisitScopeCache(ServiceCallSite callSite, RuntimeResolverContext context)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteVisitor`2.VisitCallSite(ServiceCallSite callSite, TArgument argument)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteRuntimeResolver.Resolve(ServiceCallSite callSite, ServiceProviderEngineScope scope)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.DynamicServiceProviderEngine.<>c__DisplayClass2_0.<RealizeService>b__0(ServiceProviderEngineScope scope)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceProvider.GetService(ServiceIdentifier serviceIdentifier, ServiceProviderEngineScope serviceProviderEngineScope)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceLookup.ServiceProviderEngineScope.GetService(Type serviceType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceProviderServiceExtensions.GetRequiredService(IServiceProvider provider, Type serviceType)\r\n   at Microsoft.Extensions.DependencyInjection.ServiceProviderServiceExtensions.GetRequiredService[T](IServiceProvider provider)\r\n   at Microsoft.AspNetCore.Identity.SecurityStampValidator.ValidateAsync[TValidator](CookieValidatePrincipalContext context)\r\n   at Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationHandler.HandleAuthenticateAsync()\r\n   at Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.AuthenticateAsync()\r\n   at Microsoft.AspNetCore.Authentication.AuthenticationService.AuthenticateAsync(HttpContext context, String scheme)\r\n   at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)\r\n   at Serilog.AspNetCore.RequestLoggingMiddleware.Invoke(HttpContext httpContext)"}

Screenshots

logfile

console

Summary by CodeRabbit

• New Features
  • Integrated advanced logging capabilities into the application for better monitoring and debugging.
• Chores
  • Updated and added new package dependencies to enhance application functionality.

[coderabbitai]

Walkthrough

The Dotnet Foundation's API project has embraced enhanced logging capabilities by integrating Serilog, a popular .NET logging library. This upgrade includes the addition of several Serilog packages to enrich logging functionality, alongside the configuration of both file and console logging with a custom template. This ensures a robust logging mechanism, further augmented by request logging middleware for comprehensive monitoring.

Changes

Files	Change Summary
.../DotnetFoundation.Api.csproj	Added Serilog.AspNetCore, Serilog.Expressions, Serilog.Formatting.Compact; Kept existing references.
.../Program.cs	Configured Serilog with custom log template; Enabled file and console logging; Integrated request logging middleware.

🐇✨
To log, or not to log, that's not the question,
For Serilog's embrace has marked our progression.
With files and consoles, our tales we'll compile,
Each request, a story, logged with style.
So here's to the changes, may they guide our way,
Through the maze of code, day by day.
🌟📖

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cc977ad and f1651f5.

Files ignored due to path filters (1)

• DotnetFoundation/DotnetFoundation.Api/appsettings.Development.json is excluded by: !**/*.json

Files selected for processing (2)

• DotnetFoundation/DotnetFoundation.Api/DotnetFoundation.Api.csproj (1 hunks)
• DotnetFoundation/DotnetFoundation.Api/Program.cs (3 hunks)

Additional comments: 5

DotnetFoundation/DotnetFoundation.Api/DotnetFoundation.Api.csproj (3)

• 11-11: The addition of the Serilog.AspNetCore package reference is correct and necessary for integrating Serilog with ASP.NET Core.
• 12-12: The addition of the Serilog.Expressions package reference is correct and supports advanced log event filtering and transformation.
• 13-13: The addition of the Serilog.Formatting.Compact package reference is correct and enables compact JSON formatting for logs, aligning with the structured logging approach.

DotnetFoundation/DotnetFoundation.Api/Program.cs (2)

• 57-70: The Serilog setup and configuration for both file and console logging are correctly implemented, following best practices for structured logging. However, consider making the log file path configurable through appsettings.json or environment variables to enhance flexibility in different environments.
• 94-94: The integration of Serilog with request logging middleware using UseSerilogRequestLogging is correctly implemented and placed within the request pipeline configuration.