Add logic to send logs through File Sink #2825
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RubenCerna2079
requested review from
Aniruddh25,
aaronburtle,
anushakolan,
souvikghosh04,
neeraj-sharma2592,
sourabh1007,
vadeveka,
Alekhya-Polavarapu and
rusamant
as code owners
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
There was a problem hiding this comment.
Pull Request Overview
This PR implements the logic to send logs from Data API Builder (DAB) to files using the File Sink feature with Serilog. It completes the File Sink functionality by adding the actual logging pipeline that writes logs to specified file paths.
Key changes include:
- Integration of Serilog file logging pipeline in the service configuration
- Removal of custom
RollingIntervalModeenum in favor of Serilog's built-inRollingInterval - Addition of comprehensive unit tests for File Sink functionality
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Service/Startup.cs | Adds Serilog configuration and File Sink setup logic |
| src/Service/Program.cs | Updates logger factory to include Serilog file logging |
| src/Service/Azure.DataApiBuilder.Service.csproj | Adds Serilog package dependencies |
| src/Service.Tests/Configuration/Telemetry/FileSinkTests.cs | Adds comprehensive unit tests for File Sink functionality |
| src/Directory.Packages.props | Defines Serilog package versions |
| src/Config/ObjectModel/RollingIntervalMode.cs | Removes custom enum (deleted file) |
| src/Config/ObjectModel/FileSinkOptions.cs | Updates to use Serilog's RollingInterval enum |
| src/Config/Converters/FileSinkConverter.cs | Updates converter to use Serilog's RollingInterval |
| src/Config/Azure.DataApiBuilder.Config.csproj | Adds Serilog dependency to config project |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
souvikghosh04
approved these changes
Aug 20, 2025
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Aniruddh25
reviewed
Aug 21, 2025
Aniruddh25
reviewed
Aug 21, 2025
Aniruddh25
reviewed
Aug 21, 2025
Aniruddh25
reviewed
Aug 21, 2025
Aniruddh25
approved these changes
Aug 21, 2025
aaronburtle
reviewed
Aug 21, 2025
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Aniruddh25
approved these changes
Aug 22, 2025
RubenCerna2079
added a commit
that referenced
this pull request
Aug 22, 2025
## Why make this change? - Closes issue #2578 - In order to complete the File Sink feature, the logic that sends the logs created by DAB to the file is required. ## What is this change? - This change implements the logic that sends all the logs from DAB to the file through the path the user requests. This is done with the help of Serilog which is a logging library that simplifies the creation of file sinks. - The `Startup.cs` program creates the Serilog logger pipeline and adds it as part of the services so that it is used later by the `Program.cs` to set the different loggers with the Serilog pipeline and allow the logs to be sent to the file sink. - We also deleted the `RollingIntervalMode.cs` since we discovered that Serilog has its own rolling interval enum class, which makes the one implemented in DAB obsolete. ## How was this tested? - [ ] Integration Tests - [X] Unit Tests Created tests that check if the services needed for the File Sink exist when the File Sink property is enabled. Also, created test to check if the file sink with the appropriate name is created when the property is enabled. ## Sample Request(s) <img width="917" height="136" alt="image" src="https://github.com/user-attachments/assets/a470844a-6ea3-4d05-9dfa-650f878c1c59" /> <img width="1873" height="948" alt="image" src="https://github.com/user-attachments/assets/1895eaae-0223-4d48-924e-c5275a98e3dc" />
RubenCerna2079
added a commit
that referenced
this pull request
Aug 22, 2025
## Why make this change? - Closes issue #2578 - In order to complete the File Sink feature, the logic that sends the logs created by DAB to the file is required. ## What is this change? - This change implements the logic that sends all the logs from DAB to the file through the path the user requests. This is done with the help of Serilog which is a logging library that simplifies the creation of file sinks. - The `Startup.cs` program creates the Serilog logger pipeline and adds it as part of the services so that it is used later by the `Program.cs` to set the different loggers with the Serilog pipeline and allow the logs to be sent to the file sink. - We also deleted the `RollingIntervalMode.cs` since we discovered that Serilog has its own rolling interval enum class, which makes the one implemented in DAB obsolete. ## How was this tested? - [ ] Integration Tests - [X] Unit Tests Created tests that check if the services needed for the File Sink exist when the File Sink property is enabled. Also, created test to check if the file sink with the appropriate name is created when the property is enabled. ## Sample Request(s) <img width="917" height="136" alt="image" src="https://github.com/user-attachments/assets/a470844a-6ea3-4d05-9dfa-650f878c1c59" /> <img width="1873" height="948" alt="image" src="https://github.com/user-attachments/assets/1895eaae-0223-4d48-924e-c5275a98e3dc" />
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why make this change?
What is this change?
Startup.csprogram creates the Serilog logger pipeline and adds it as part of the services so that it is used later by theProgram.csto set the different loggers with the Serilog pipeline and allow the logs to be sent to the file sink.RollingIntervalMode.cssince we discovered that Serilog has its own rolling interval enum class, which makes the one implemented in DAB obsolete.How was this tested?
Created tests that check if the services needed for the File Sink exist when the File Sink property is enabled.
Also, created test to check if the file sink with the appropriate name is created when the property is enabled.
Sample Request(s)