Structured HTTP Request Logging via Serilog JSON Sink by mchlkntrv · Pull Request #77 · Kros-sk/TeaPie

mchlkntrv · 2025-09-10T14:42:59Z

This pull request introduces structured logging of HTTP requests by adding a new JSON requests log file feature. It allows users to specify a separate file for detailed, structured logs of HTTP requests and responses, including retries and authentication details, while keeping the main log file and console output clean. The implementation involves updates to the logging configuration, command-line options, and HTTP pipeline.

The most important changes are:

Structured HTTP Requests Logging

Added a new --requests-log-file command-line option to specify a file for structured JSON logs of HTTP requests.
Introduced RequestLogFileEntry and related classes to represent structured log entries for HTTP requests, responses, retries, and authentication.
Implemented delegating handler RequestsLoggingHandler, that creates and logs structured entries for each HTTP request, including retries and errors.

Logging Pipeline

Updated ApplicationBuilder and logging setup to accept the new requests log file path, and to configure Serilog to write structured HTTP request logs to the specified file in JSON format, filtering them out from the main log file and console output.

HTTP Pipeline

Registered RequestsLoggingHandler in the HTTP pipeline so that all outgoing requests are logged.

These changes provide users with a new way to analyze HTTP requests in a structured, machine-readable format, and lay the groundwork for further use (e.g. VS Code Extension).

…rv/TeaPie into feature/requests-logging

…xecuteRequestStep

… of Setup.cs

Copilot

Pull Request Overview

This PR adds structured HTTP request logging to TeaPie by implementing a JSON-based logging system that captures detailed information about HTTP requests, responses, retries, and authentication. The implementation uses Serilog's JSON formatter to write structured logs to a separate file when the --requests-log-file option is provided.

Key Changes:

Added RequestsLoggingHandler as a DelegatingHandler to intercept and log HTTP requests/responses
Introduced data structures (RequestLogFileEntry, RequestInfo, ResponseInfo, etc.) to capture structured request information
Enhanced Serilog configuration to support separate JSON log file for HTTP requests with filtering

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/TeaPie/Logging/Setup.cs	Adds sink configuration methods for console, file, and requests logging with filtering logic
src/TeaPie/Logging/RequestsLoggingHandler.cs	Implements the core logging handler that captures request/response data and retry attempts
src/TeaPie/Logging/RequestLogFileEntry.cs	Defines data structures for structured logging of requests, responses, retries, and authentication
src/TeaPie/Http/ExecuteRequestStep.cs	Integrates logging handler into request execution pipeline and tracks request context
src/TeaPie/Http/Auth/Setup.cs	Registers RequestsLoggingHandler in HTTP client pipeline
src/TeaPie/ApplicationBuilder.cs	Adds pathToRequestsLogFile parameter to logging configuration
src/TeaPie.DotnetTool/TestCommand.cs	Passes RequestsLogFile setting to application builder
src/TeaPie.DotnetTool/LoggingSettings.cs	Adds --requests-log-file command option
src/TeaPie.DotnetTool/ExploreCommand.cs	Passes RequestsLogFile setting to application builder

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-21T12:59:41Z

+        if (File.Exists(pathToRequestsLogFile))
+        {
+            File.Delete(pathToRequestsLogFile);
+        }


Deleting the file without synchronization could cause issues if multiple processes or threads attempt to write to the same log file simultaneously. Consider using a lock mechanism or checking if the file is in use before deletion.

Copilot

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 10 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-12T11:06:15Z

+            StatusCode = (int)response.StatusCode,
+            ReasonPhrase = response.ReasonPhrase,
+            Headers = ProcessHeaders(response.Headers),
+            Body = await GetContentBodyAsync(response.Content),


Reading the HTTP response content body will consume the stream and prevent it from being read again by subsequent code that expects to process the response. This will cause failures when the response needs to be read elsewhere. Consider buffering the response content before reading it, or removing body logging for responses.

Copilot · 2025-11-12T11:06:16Z

+            Method = request.Method.ToString(),
+            Uri = request.RequestUri?.ToString() ?? string.Empty,
+            Headers = ProcessHeaders(request.Headers),
+            Body = await GetContentBodyAsync(request.Content),


Reading the HTTP request content body will consume the stream and prevent it from being read again later in the pipeline. This will cause the actual HTTP request to fail when it tries to send the body. Consider either:

Removing body logging for requests, or

Using a buffered approach that preserves the content stream for later use

we need to read the content body only once for now

hmm nie som si istý. My ho teraz už čítame 2x. Lebo raz ho čítaš tu pre účely logovania a druhýkrát sa číta na mieste kde sa spracováva výsledok toho responsu.
Takže by sme to mali zvážiť. Čitanie obsahu je tricky vec.

Nad týmto si sa zamyslela?

obsah je čítaný viackrát ale skrz CloneMessage v ExecuteRequestStep, kt. implementoval ešte Maťo sa stream ukladá do StringContentu a mal by byť readable viac ako raz,
aj v .json je body requestu uložené správne:

{"Name":"AddCarRequest","Method":"POST","Uri":"http://localhost:3001/cars","Headers":{"Authorization":"Bearer authToken"},"Body":"{\"Id\":10,\"Brand\":\"Ford\",\"Model\":\"Focus\",\"EngineType\":\"Petrol\",\"TransmissionType\":\"Automatic\",\"PeopleCapacity\":2,\"Color\":\"indigo\",\"Year\":1994,\"DrivenKilometres\":124679.6246257195,\"Description\":\"Vero similique ut sed.\"}",

Copilot · 2025-11-12T11:06:17Z

+    {
+        if (File.Exists(pathToRequestsLogFile))
+        {
+            File.Delete(pathToRequestsLogFile);


The file deletion logic could cause issues in concurrent scenarios or when the file is locked by another process. Consider wrapping this in a try-catch block or using a safer file handling approach that doesn't silently fail if the file cannot be deleted.

Suggested change

File.Delete(pathToRequestsLogFile);

try

{

File.Delete(pathToRequestsLogFile);

}

catch (IOException)

{

// The file is in use or cannot be deleted. Optionally log this event.

}

catch (UnauthorizedAccessException)

{

// The file cannot be deleted due to permission issues. Optionally log this event.

}

Copilot · 2025-11-12T11:06:17Z

+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    public Exception? Exception { get; set; }


The exception object itself is being serialized directly into the JSON log. This could cause serialization issues or expose sensitive stack trace information. Consider logging only essential exception details like exception.GetType().Name and exception.Message, or use a custom exception serializer.

Suggested change

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]

public Exception? Exception { get; set; }

[JsonIgnore]

public Exception? Exception { get; set; }

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]

public string? ExceptionType => Exception?.GetType().Name;

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]

public string? ExceptionMessage => Exception?.Message;

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]

public string? ExceptionStackTrace => Exception?.StackTrace;

Copilot · 2025-11-12T11:06:18Z

            .AddHttpMessageHandler<AuthHttpMessageHandler>()
+            .AddHttpMessageHandler<RequestsLoggingHandler>()


The handler order matters for DelegatingHandlers. RequestsLoggingHandler is added after AuthHttpMessageHandler but before LoggingInterceptorHandler. This means authentication headers will be captured in the logs, which could be a security concern if tokens or credentials are logged. Consider the security implications of this ordering or add sanitization for sensitive headers.

Suggested change

.AddHttpMessageHandler<AuthHttpMessageHandler>()

.AddHttpMessageHandler<RequestsLoggingHandler>()

.AddHttpMessageHandler<RequestsLoggingHandler>()

.AddHttpMessageHandler<AuthHttpMessageHandler>()

Burgyn · 2025-11-13T11:20:50Z

+            Method = request.Method.ToString(),
+            Uri = request.RequestUri?.ToString() ?? string.Empty,
+            Headers = ProcessHeaders(request.Headers),
+            Body = await GetContentBodyAsync(request.Content),


hmm nie som si istý. My ho teraz už čítame 2x. Lebo raz ho čítaš tu pre účely logovania a druhýkrát sa číta na mieste kde sa spracováva výsledok toho responsu.
Takže by sme to mali zvážiť. Čitanie obsahu je tricky vec.

Kantorová Michaela and others added 12 commits September 8, 2025 12:09

support for requests logging into .json file through serilog

c208e5d

Merge branch 'Kros-sk:master' into feature/requests-logging

c035a9a

renaming

699a606

Merge branch 'feature/requests-logging' of https://github.com/mchlknt…

c366e4c

…rv/TeaPie into feature/requests-logging

added DelegatingHandler (RequestResponseLoggingHandler), cleaned up E…

6c586c1

…xecuteRequestStep

renaming, using sourcecontext

05568d1

code

9c6b9f7

reverted unnecessary code changes

d186c63

retries logging

7e9f36c

removed unnecessary code

ff2666a

using ILogger instead of Serilog

9561245

dont write requests information into console and log files + clean up…

c7c9f31

… of Setup.cs

satano requested a review from Copilot October 21, 2025 12:58

Copilot AI reviewed Oct 21, 2025

View reviewed changes

Kantorová Michaela added 2 commits November 10, 2025 15:23

fixes

7bb84ef

made requests handler async

c6af778

mchlkntrv requested a review from Copilot November 12, 2025 11:02

Copilot started reviewing on behalf of mchlkntrv November 12, 2025 11:03 View session

Copilot finished reviewing on behalf of mchlkntrv November 12, 2025 11:04

Copilot AI reviewed Nov 12, 2025

View reviewed changes

Kantorová Michaela added 6 commits November 12, 2025 12:49

changed logs filtering

d93fa3a

removed redundant metadata property

f957013

wording

a1333b0

added exception

6c05f51

dont log requests into console

4d3766c

removed unnecessary conditions

10bd12e

Burgyn reviewed Nov 13, 2025

View reviewed changes

Kantorová Michaela added 3 commits November 14, 2025 10:09

removed retry attempts handling

79588ae

changed sinks filtering

fc9a439

renaming

55de903

set RequestId to readonly

fad56fa

Burgyn approved these changes Nov 25, 2025

View reviewed changes

Comment thread src/TeaPie/Logging/RequestsLoggingHandler.cs Outdated

Burgyn marked this pull request as ready for review November 25, 2025 06:56

Burgyn merged commit 17699f0 into Kros-sk:master Nov 25, 2025
4 checks passed

-            File.Delete(pathToRequestsLogFile);
+            try
+            {
+                File.Delete(pathToRequestsLogFile);
+            }
+            catch (IOException)
+            {
+                // The file is in use or cannot be deleted. Optionally log this event.
+            }
+            catch (UnauthorizedAccessException)
+            {
+                // The file cannot be deleted due to permission issues. Optionally log this event.
+            }

		[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
		public Exception? Exception { get; set; }

		.AddHttpMessageHandler<AuthHttpMessageHandler>()
		.AddHttpMessageHandler<RequestsLoggingHandler>()

Uh oh!

Conversation

mchlkntrv commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

mchlkntrv Nov 12, 2025

Choose a reason for hiding this comment

we need to read the content body only once for now

Uh oh!

Burgyn Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Burgyn Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

mchlkntrv Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Burgyn Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mchlkntrv commented Sep 10, 2025 •

edited

Loading