-
-
Notifications
You must be signed in to change notification settings - Fork 270
feat: added Module-level Debug Filtering #754
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Anju Pathak <anjupathak9810@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
|
|
||
| - **`debugModules.exclude`**: Blacklist of module prefixes applied after `include`. | ||
|
|
||
| Module names are logger prefixes (for example: `proxy`, `record`, `test`, `hooks`, `telemetry`, `proxy.http`, `proxy.mysql`). Matching is hierarchical: `proxy` matches `proxy.http` and `proxy.mysql`. |
Copilot
AI
Jan 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The parenthetical phrase should use "e.g." instead of "for example" for consistency with formal documentation style. Alternatively, for better readability, consider restructuring as: "Module names are logger prefixes such as proxy, record, test, hooks, telemetry, proxy.http, and proxy.mysql."
| Module names are logger prefixes (for example: `proxy`, `record`, `test`, `hooks`, `telemetry`, `proxy.http`, `proxy.mysql`). Matching is hierarchical: `proxy` matches `proxy.http` and `proxy.mysql`. | |
| Module names are logger prefixes such as `proxy`, `record`, `test`, `hooks`, `telemetry`, `proxy.http`, and `proxy.mysql`. Matching is hierarchical: `proxy` matches `proxy.http` and `proxy.mysql`. |
| exclude: ["proxy.mysql"] | ||
| ``` | ||
| See the [Configuration File](configuration-file) doc for details and hierarchical matching behavior. |
Copilot
AI
Jan 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link reference is incomplete. It should point to the specific section within the configuration file documentation. Update the link to include the anchor: [Configuration File](configuration-file#debug-logging) to ensure users are directed to the relevant Debug Logging section.
| See the [Configuration File](configuration-file) doc for details and hierarchical matching behavior. | |
| See the [Configuration File](configuration-file#debug-logging) doc for details and hierarchical matching behavior. |
| - **`debugModules.include`**: Whitelist of module prefixes. When set, only matching modules emit debug logs. When empty, all modules are allowed (if `debug` is `true`). | ||
|
|
||
| - **`debugModules.exclude`**: Blacklist of module prefixes applied after `include`. |
Copilot
AI
Jan 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word "Whitelist" is considered outdated terminology. Use "Allowlist" instead, which is the modern, more inclusive term recommended in current best practices.
| - **`debugModules.include`**: Whitelist of module prefixes. When set, only matching modules emit debug logs. When empty, all modules are allowed (if `debug` is `true`). | |
| - **`debugModules.exclude`**: Blacklist of module prefixes applied after `include`. | |
| - **`debugModules.include`**: Allowlist of module prefixes. When set, only matching modules emit debug logs. When empty, all modules are allowed (if `debug` is `true`). | |
| - **`debugModules.exclude`**: Denylist of module prefixes applied after `include`. |
| - **`debugModules.include`**: Whitelist of module prefixes. When set, only matching modules emit debug logs. When empty, all modules are allowed (if `debug` is `true`). | ||
|
|
||
| - **`debugModules.exclude`**: Blacklist of module prefixes applied after `include`. |
Copilot
AI
Jan 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word "Blacklist" is considered outdated terminology. Use "Denylist" or "Blocklist" instead, which are the modern, more inclusive terms recommended in current best practices.
| - **`debugModules.include`**: Whitelist of module prefixes. When set, only matching modules emit debug logs. When empty, all modules are allowed (if `debug` is `true`). | |
| - **`debugModules.exclude`**: Blacklist of module prefixes applied after `include`. | |
| - **`debugModules.include`**: Allowlist of module prefixes. When set, only matching modules emit debug logs. When empty, all modules are allowed (if `debug` is `true`). | |
| - **`debugModules.exclude`**: Denylist of module prefixes applied after `include`. |
Achanandhi-M
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @anjupathak03, could you please fix the build pipeline? It’s currently failing.
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: