[log] Add debug logging to TLS helper functions in proxy/tls.go#9285
Merged
Conversation
Add logTLS debug logging calls to randomSerial and writePEM helper functions, and to the TLS directory creation step in GenerateSelfSignedTLS. These provide visibility into: - TLS directory creation path - Random serial number generation values - PEM file write operations (path, type, size) - PEM file write completion Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds debug tracing to TLS certificate generation and PEM file writes.
Changes:
- Logs TLS directory and serial generation.
- Logs PEM write attempts and successful encoding.
Show a summary per file
| File | Description |
|---|---|
internal/proxy/tls.go |
Adds TLS helper debug logging. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Medium
| if serial.Sign() == 0 { | ||
| serial = new(big.Int).Add(serial, big.NewInt(1)) | ||
| } | ||
| logTLS.Printf("generated random serial number: %s", serial.String()) |
| if err := pem.Encode(f, &pem.Block{Type: blockType, Bytes: derBytes}); err != nil { | ||
| return err | ||
| } | ||
| logTLS.Printf("PEM file written successfully: path=%s", path) |
Collaborator
|
@copilot address review feedback |
- Pass *big.Int directly to Printf instead of calling .String() eagerly - Close file explicitly in writePEM, handle close error, and only log success after confirmed close
Log the file close error when pem.Encode fails, rather than silently discarding it.
Contributor
Addressed in the latest commits:
|
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.
Summary
Adds
logTLSdebug logging calls to helper functions ininternal/proxy/tls.gothat previously had no logging coverage.Changes
GenerateSelfSignedTLS: Added log call afteros.MkdirAllto confirm the TLS directory was ensured.randomSerial: Added log call after successful serial number generation, showing the generated value.writePEM: Added log calls at function entry (path, type, size) and on successful write.These logs appear under
DEBUG=proxy:*and are zero-overhead when debug logging is disabled. They help trace certificate generation issues during development and troubleshooting.Checklist
internal/proxy/tls.go)var logTLS = logger.New("proxy:tls")), reusedpkg:filenameconventiongo buildpassesgo test ./internal/proxy/passesgo vet ./internal/proxy/passesWarning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
awmgmcpgSee Network Configuration for more information.