Skip to content

Conversation

@anjupathak03
Copy link
Contributor

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 debugModules setting, including hierarchical module matching and usage examples.

Debug Logging Enhancements:

  • Added documentation for the debugModules setting, allowing users to include or exclude debug logs by module name, with hierarchical matching and clear YAML configuration examples. [1] [2]
  • Updated the configuration file example to show the new debugModules include and exclude lists.
Screenshot 2026-01-20 023118 image

This PR Resolves #(issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

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:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

Signed-off-by: Anju Pathak <anjupathak9810@gmail.com>
Copilot AI review requested due to automatic review settings January 19, 2026 21:08
Copy link

Copilot AI left a 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 debugModules configuration fields (include and exclude) to the YAML configuration example
  • Documented the Debug Logging section explaining debug and debugModules settings 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`.
Copy link

Copilot AI Jan 19, 2026

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."

Suggested change
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`.

Copilot uses AI. Check for mistakes.
exclude: ["proxy.mysql"]
```
See the [Configuration File](configuration-file) doc for details and hierarchical matching behavior.
Copy link

Copilot AI Jan 19, 2026

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.
Comment on lines +104 to +106
- **`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`.
Copy link

Copilot AI Jan 19, 2026

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.

Suggested change
- **`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`.

Copilot uses AI. Check for mistakes.
Comment on lines +104 to +106
- **`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`.
Copy link

Copilot AI Jan 19, 2026

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.

Suggested change
- **`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`.

Copilot uses AI. Check for mistakes.
Copy link
Member

@Achanandhi-M Achanandhi-M left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants