Document logging instrumentation patterns using createLogger helper #9
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
- Document debug package usage with logging.ts - Explain logger categories per file (mcp:filename pattern) - Include printf-style formatting examples (%s, %d, %j, %o) - Add security warnings about not logging secrets - Provide safe logging patterns for sensitive data - Include examples for adding logging to new code - Document DEBUG environment variable usage Co-authored-by: pelikhan <[email protected]>
- Use optional chaining for apiKey.substring() to handle undefined - Replace type assertion with instanceof check for error handling - Add fallback values for safer logging examples Co-authored-by: pelikhan <[email protected]>
Copilot
AI
changed the title
[WIP] Update AGENTS.md with logging section
Document logging instrumentation patterns using debug package
Nov 7, 2025
Copilot finished work on behalf of
pelikhan
November 7, 2025 12:56
pelikhan
reviewed
Nov 7, 2025
AGENTS.md
Outdated
| import debug from 'debug' | ||
|
|
||
| // Create a dedicated logger for this file | ||
| const log = debug('mcp:server') |
Collaborator
There was a problem hiding this comment.
@copilot use helper function from logger.ts instead of directly from the debug package
Contributor
Author
There was a problem hiding this comment.
Updated documentation to use createLogger() helper from logging.ts instead of directly importing debug package. Added the helper function in commit 55ec7c7.
- Add createLogger() helper function to logging.ts - Update all documentation examples to use createLogger instead of directly importing debug - Maintains namespace pattern 'mcp:<name>' internally - Addresses feedback to use helper function from logging.ts Co-authored-by: pelikhan <[email protected]>
Copilot
AI
changed the title
Document logging instrumentation patterns using debug package
Document logging instrumentation patterns using createLogger helper
Nov 7, 2025
Copilot finished work on behalf of
pelikhan
November 7, 2025 13:05
pelikhan
approved these changes
Nov 7, 2025
Collaborator
|
@copilot merge main |
Merged commits: - Add vitest test suites for TypeScript functions (#8) - Add comprehensive input/output schema for stdio and http MCP transports (#7) - Add agentic workflow for action metadata consistency checking (#11) - Add agentic workflow for automated super-linter analysis and reporting (#4) Resolved merge conflict in dist/index.js.map by rebuilding the package. Co-authored-by: pelikhan <[email protected]>
Contributor
Author
Copilot finished work on behalf of
pelikhan
November 7, 2025 13:16
Collaborator
|
@copilot merge main and only keep AGENTS.md file changes |
Removed files brought in from main branch merge: - .github/workflows/check-consistency.md - .github/workflows/super-linter-report.md - CONTRIBUTING.md - __tests__/docker.test.ts - __tests__/logging.test.ts - __tests__/port.test.ts - __tests__/server.test.ts Reverted modifications to files that were changed in merge: - README.md - __tests__/main.test.ts - action.yml - dist/index.js - dist/index.js.map - src/main.ts - src/server.ts Retained only the original PR changes: - AGENTS.md (logging documentation) - src/logging.ts (createLogger helper) Co-authored-by: pelikhan <[email protected]>
Contributor
Author
Copilot finished work on behalf of
pelikhan
November 7, 2025 13:28
pelikhan
approved these changes
Nov 7, 2025
Added merge=ours to dist/** in .gitattributes to prefer our version during merges since dist files are generated artifacts. Co-authored-by: pelikhan <[email protected]>
Merged commits from main: - Move test files to src/ directory alongside source files (#12) - Add daily test improver agentic workflow (#10) - Add agentic workflow for automated super-linter analysis and reporting (#4) - Add agentic workflow for action metadata consistency checking (#11) - Add comprehensive input/output schema for stdio and http MCP transports (#7) - Add vitest test suites for TypeScript functions (#8) Used merge=ours strategy for dist/index.js.map to keep our generated version. All 49 tests pass. Co-authored-by: pelikhan <[email protected]>
Contributor
Author
Updated .gitattributes to mark dist/* with merge=ours strategy in commit 176ede8, then merged main branch in commit a18f2c4. The merge=ours strategy successfully kept our version of dist/index.js.map during the merge. All 49 tests pass. |
Copilot finished work on behalf of
pelikhan
November 7, 2025 16:59
pelikhan
approved these changes
Nov 7, 2025
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.
Update AGENTS.md with Logging Documentation
This PR adds a comprehensive logging section to AGENTS.md that documents how to instrument TypeScript code with logging and tracing.
Changes Made
Files Changed
createLogger()helper function for creating per-file loggersDocumentation Highlights
The new section covers:
debugpackage and its benefitslogging.tsfilecreateLogger('filename')helperLatest Updates
createLogger()helper function tosrc/logging.tsfor creating per-file loggerscreateLogger('name')instead of directly importingdebugmcp:<name>internally while providing a cleaner APIAll tests pass (49 tests across 5 test files) and the documentation follows the existing format and style.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.