Conversation
Signed-off-by: Anju Pathak <anjupathak9810@gmail.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds documentation for a new module-level debug filtering feature in Keploy's CLI and configuration. The feature allows users to selectively include or exclude debug logs from specific modules using the debugModules configuration setting, with support for hierarchical module matching.
Changes:
- Added
debugModulesconfiguration fields (includeandexclude) to the YAML configuration example - Documented the Debug Logging section explaining
debuganddebugModulessettings with usage examples - Added Module-level Debug Filtering section to CLI commands documentation with cross-reference to configuration file
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| versioned_docs/version-3.0.0/running-keploy/configuration-file.md | Added debugModules fields to config example and new Debug Logging section with detailed explanation and YAML example |
| versioned_docs/version-3.0.0/running-keploy/cli-commands.md | Added Module-level Debug Filtering section with usage example and reference to configuration file documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
versioned_docs/version-3.0.0/running-keploy/configuration-file.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-3.0.0/running-keploy/configuration-file.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-3.0.0/running-keploy/configuration-file.md
Outdated
Show resolved
Hide resolved
Achanandhi-M
left a comment
There was a problem hiding this comment.
Hey @anjupathak03, could you please fix the build pipeline? It’s currently failing.
Signed-off-by: Anju Pathak <anjupathak9810@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Anju <168076172+anjupathak03@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Anju <168076172+anjupathak03@users.noreply.github.com>
amaan-bhati
left a comment
There was a problem hiding this comment.
Thank you for documenting the module-level debug filtering feature - the structure with include/exclude lists and hierarchical module matching is well thought out and useful to document.
Consider working through a few things:
Issues to be Considered
1. CI pipeline is failing
The PR currently has 20+ Vale linting failures across both modified files. Please run vale <filename> locally to catch and fix all of them. Common issues flagged include:
- Quotation mark placement conventions
yamlshould beYAML- En dash vs em dash usage
- Plural form inconsistencies
2. Feature availability unconfirmed
Please confirm that the debugModules feature is actually available in the version of Keploy these docs describe. Documenting an unreleased feature would be misleading to users.
3. No coverage for the current version
The changes are only made to the version-3.0.0 docs. If debugModules is also supported in the current version consider adding the documentation there as well.
Please also respond to the reviewer's earlier comment - a status update would be helpful.
What has changed?
This pull request updates the documentation to introduce and explain module-level debug log filtering in Keploy's CLI and configuration. The changes clarify how users can control debug output using the new
debugModulessetting, including hierarchical module matching and usage examples.Debug Logging Enhancements:
debugModulessetting, allowing users to include or exclude debug logs by module name, with hierarchical matching and clear YAML configuration examples. [1] [2]debugModulesincludeandexcludelists.This PR Resolves #(issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
Checklist: