Add in debug logging #293
Merged
Add in debug logging #293
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive debug logging throughout the hot-shots library using Node.js's built-in util.debuglog() functionality, which can be enabled via the NODE_DEBUG=hot-shots environment variable. This addresses issue #257 by providing visibility into the library's internal operations for troubleshooting.
Key changes include:
- Implementation of debug logging across all transport types (TCP, UDP, UDS, Stream)
- Addition of debug statements for client initialization, message sending, buffering, and error handling
- Documentation updates explaining how to enable and use the debug logging feature
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| lib/transport.js | Adds debug logging to all transport creation functions and their send/close operations, including DNS resolution and retry logic |
| lib/statsd.js | Adds debug logging for client initialization, message buffering, queue flushing, and socket operations |
| lib/statsFunctions.js | Adds debug logging to all metric functions (timing, increment, histogram, etc.) to track when metrics are recorded |
| README.md | Documents the new debugging feature with usage instructions and adds an example for timing measurements |
| CHANGES.md | Records the addition of debug logging feature in the changelog |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
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.
Add in debug logging so that you can see what exactly is happening if you use "NODE_DEBUG=hot-shots". Fixes #257