Rename: PreTransactionLogData -> NonHttpSmLogData#13154
Open
bneradt wants to merge 1 commit into
Open
Conversation
bneradt
force-pushed
the
non-http-sm-log-data
branch
from
363126d to
0a3c2f7
Compare
bneradt
changed the title
The alternate-HttpSM access log entries have more opportunities for use than just pre-HttpSM state machine uses. There may be uses for it, for instance, to log TLS handshake issues, for instance. Thus the old pre-transaction terminology was too narrow. This renames the exceptional carrier to NonHttpSmLogData, documents that normal transaction logs should still use HttpSM-backed data, and updates the protocol logging path and tests to use the new terminology.
bneradt
force-pushed
the
non-http-sm-log-data
branch
from
0a3c2f7 to
50c4b78
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Renames the “pre-transaction” access-log data carrier to broader “non-HttpSM” terminology, reflecting that these log entries can be emitted for exceptional cases not backed by an HttpSM.
Changes:
- Renamed
PreTransactionLogDatatoNonHttpSmLogDataand updatedTransactionLogDatato consume it. - Updated protocol-layer logging call sites (HTTP/2, HTTP/3) and
ProxyTransactionAPI to use the new name. - Updated unit tests and inline documentation to reflect the new terminology.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/proxy/logging/unit-tests/test_LogAccess.cc | Updates tests/helpers to use NonHttpSmLogData. |
| src/proxy/logging/TransactionLogData.cc | Switches fallback storage from PreTransactionLogData to NonHttpSmLogData. |
| src/proxy/http3/Http3HeaderVIOAdaptor.cc | Updates HTTP/3 malformed-header logging to new API name. |
| src/proxy/http2/Http2ConnectionState.cc | Updates HTTP/2 malformed-header logging to new API name. |
| src/proxy/ProxyTransaction.cc | Renames logging method and uses NonHttpSmLogData as the carrier. |
| include/proxy/logging/TransactionLogData.h | Renames ctor arg + member pointer and updates doc text. |
| include/proxy/logging/LogAccess.h | Updates doc wording to match new “non-HttpSM” terminology. |
| include/proxy/logging/Log.h | Minor doc wording adjustment. |
| include/proxy/ProxyTransaction.h | Renames public API and updates associated documentation. |
| include/proxy/PreTransactionLogData.h | Changes class/documentation to NonHttpSmLogData (but file path suggests it may not be fully renamed). |
|
|
||
| #include "proxy/logging/TransactionLogData.h" | ||
| #include "proxy/PreTransactionLogData.h" | ||
| #include "proxy/NonHttpSmLogData.h" |
| */ | ||
| void log_pre_transaction_access(HTTPHdr const *request, const char *protocol_str); | ||
| void log_non_http_sm_access(HTTPHdr const *request, const char *protocol_str); | ||
|
|
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
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.
The alternate-HttpSM access log entries have more opportunities for use
than just pre-HttpSM state machine uses. There may be uses for it, for
instance, to log TLS handshake issues, for instance. Thus the old
pre-transaction terminology was too narrow.
This renames the exceptional carrier to NonHttpSmLogData, documents
that normal transaction logs should still use HttpSM-backed data, and
updates the protocol logging path and tests to use the new terminology.