From 937c3dd7458048f8a6c162f488d983f2e11a0ece Mon Sep 17 00:00:00 2001 From: Anju Pathak Date: Mon, 19 Jan 2026 20:58:47 +0000 Subject: [PATCH 1/4] feat: added Module-level Debug Filtering Signed-off-by: Anju Pathak --- .../running-keploy/cli-commands.md | 13 ++++++++++ .../running-keploy/configuration-file.md | 24 +++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index cf80e4bf2..3962ffcca 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -38,6 +38,19 @@ Here are some examples of how to use some common flags: | `sanitize` | `--test-sets, -t`, `-p, --path` | | `config` | `--generate`,`-p, --path` | +### Module-level Debug Filtering + +`--debug` enables debug logs. To filter debug logs by module, set `debugModules` in the config file: + +```yaml +debug: true +debugModules: + include: ["proxy", "record"] + exclude: ["proxy.mysql"] +``` + +See the [Configuration File](configuration-file) doc for details and hierarchical matching behavior. + ## [record](#record) The `record` mode in Keploy allows the user to record Keploy testcases from the API calls. The recorded testcases and generated mocks are then saved in the `keploy` directory in the current working directory. diff --git a/versioned_docs/version-3.0.0/running-keploy/configuration-file.md b/versioned_docs/version-3.0.0/running-keploy/configuration-file.md index 6eb6ee0ce..fdca0f34d 100644 --- a/versioned_docs/version-3.0.0/running-keploy/configuration-file.md +++ b/versioned_docs/version-3.0.0/running-keploy/configuration-file.md @@ -40,6 +40,9 @@ port: 0 proxyPort: 16789 dnsPort: 26789 debug: false +debugModules: + include: [] + exclude: [] disableTele: false inDocker: false generateGithubActions: true @@ -92,6 +95,27 @@ Visit the [CLI Command Docs](http://keploy.io/docs/running-keploy/cli-commands/) ## Configuration Sections +### Debug Logging + +The `debug` and `debugModules` settings control debug log output. + +- **`debug`**: Enables debug logs. When `false`, debug logs are suppressed and `debugModules` is ignored. + +- **`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`. + +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`. + +Example: + +```yaml +debug: true +debugModules: + include: ["proxy", "record"] + exclude: ["proxy.mysql"] +``` + ### Record Section The `record` section in the Keploy-config file allows you to define parameters for recording API calls. From b34cf4892d3e3b5f2963ec9db1b5898b91e2347e Mon Sep 17 00:00:00 2001 From: Anju Pathak Date: Thu, 22 Jan 2026 13:33:49 +0530 Subject: [PATCH 2/4] fix: build Signed-off-by: Anju Pathak --- versioned_docs/version-3.0.0/running-keploy/cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index 3962ffcca..fc196b239 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -49,7 +49,7 @@ debugModules: exclude: ["proxy.mysql"] ``` -See the [Configuration File](configuration-file) doc for details and hierarchical matching behavior. +See the [Configuration File](configuration-file.md) doc for details and hierarchical matching behavior. ## [record](#record) From 7f04e8044836dad11de0781be062a40f1d6af8b3 Mon Sep 17 00:00:00 2001 From: Anju <168076172+anjupathak03@users.noreply.github.com> Date: Thu, 22 Jan 2026 13:40:41 +0530 Subject: [PATCH 3/4] Update versioned_docs/version-3.0.0/running-keploy/configuration-file.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Anju <168076172+anjupathak03@users.noreply.github.com> --- .../version-3.0.0/running-keploy/configuration-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-3.0.0/running-keploy/configuration-file.md b/versioned_docs/version-3.0.0/running-keploy/configuration-file.md index fdca0f34d..70dcae3c6 100644 --- a/versioned_docs/version-3.0.0/running-keploy/configuration-file.md +++ b/versioned_docs/version-3.0.0/running-keploy/configuration-file.md @@ -105,7 +105,7 @@ The `debug` and `debugModules` settings control debug log output. - **`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`. +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`. Example: From dcff2fdd7ef3b0cefd3adfc193766e78f04df2dd Mon Sep 17 00:00:00 2001 From: Anju <168076172+anjupathak03@users.noreply.github.com> Date: Thu, 22 Jan 2026 13:42:05 +0530 Subject: [PATCH 4/4] Update versioned_docs/version-3.0.0/running-keploy/configuration-file.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Anju <168076172+anjupathak03@users.noreply.github.com> --- .../version-3.0.0/running-keploy/configuration-file.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-3.0.0/running-keploy/configuration-file.md b/versioned_docs/version-3.0.0/running-keploy/configuration-file.md index 70dcae3c6..f1fe8725e 100644 --- a/versioned_docs/version-3.0.0/running-keploy/configuration-file.md +++ b/versioned_docs/version-3.0.0/running-keploy/configuration-file.md @@ -101,9 +101,9 @@ The `debug` and `debugModules` settings control debug log output. - **`debug`**: Enables debug logs. When `false`, debug logs are suppressed and `debugModules` is ignored. -- **`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.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`**: Blacklist of module prefixes applied after `include`. +- **`debugModules.exclude`**: Denylist of module prefixes applied after `include`. 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`.