feat: added Module-level Debug Filtering

versioned_docs/version-3.0.0/running-keploy/cli-commands.md

@@ -38,6 +38,19 @@
 | `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.
@@ -58,7 +71,7 @@
 
 In the command above, `node src/app.js` is the command which starts the user application.
 
 - `--config-path string` - Path to the Keploy configuration file. The default is ".".
 
 ```bash
 keploy record -c "node src/app.js" --config-path "./config-dir/"
@@ -125,7 +138,7 @@
 
 ## [test](#test)
 
 The `test` mode in Keploy allows the user to run the recoded testcases from the API calls and execute assertion. A detailed report is produced after the tests are executed and it's then saved in the yaml format in `keploy/reports` directory in the current working directory.
 
 <b> Usage: </b>
 
@@ -149,7 +162,7 @@
 
 In the command above, `node src/app.js` is the command which starts the user application.
 
 - `--config-path string` - Path to the Keploy configuration file. The default is ".".
 
 ```bash
 keploy test -c "node src/app.js" --config-path "./config-dir/"
@@ -169,7 +182,7 @@
 keploy test -c "node src/app.js" --delay 10
 ```
 
 - `--mongo-password string` - Authentication password for mocking MongoDB connection. The default password is "default123".
 
 ```bash
 keploy test -c "node src/app.js" --mongo-password "my-password"
@@ -237,25 +250,25 @@
 
 - `--jacoco-agent-path` - Only applicable for test coverage for Java projects. You can override the jacoco agent jar by providing its path
 
 - `--proto-dir string` - Path of the directory where all protos of a service are located. Used for GRPC test cases to enable better deterministic and proper comparison of protobuf responses.
 
 ```bash
 keploy test -c "node src/app.js" --proto-dir "./protos"
 ```
 
 - `--proto-file string` - Path of main proto file. Used for GRPC test cases to enable better deterministic and proper comparison of protobuf responses. Either `--proto-file` or `--proto-dir` must be provided for GRPC tests.
 
 ```bash
 keploy test -c "node src/app.js" --proto-file "./protos/main.proto"
 ```
 
 - `--proto-include stringArray` - Path of directories to be included while parsing import statements in proto files. This is optional and used for GRPC test cases when proto files have import dependencies.
 
 ```bash
 keploy test -c "node src/app.js" --proto-file "./protos/main.proto" --proto-include "./protos/common,./protos/shared"
 ```
 
 > **Note for GRPC Tests:** When running GRPC test cases, it's recommended to provide proto information using either `--proto-file` or `--proto-dir` flags. If proto information is not provided, Keploy will use basic canonical matching of the protoscopic textual format of GRPC response body, which may be less accurate than proto-based comparison.
 
 ## [gen](#gen)
 
@@ -287,11 +300,11 @@
 
 - `testDir` - Directory where tests will be written.
 
 - `llmBaseUrl` - Base url of the llm.
 
 - `model` - Specifies the AI model to use by default it uses "gpt-4o" model.
 
 - `llmApiVersion` - API version of the llm if any.
 
 ## [normalize](#normalize)
 
@@ -335,7 +348,7 @@
 
 ## [rerecord](#rerecord)
 
 The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testset(s).
 
 **Usage:**
 
@@ -377,7 +390,7 @@
 keploy report -t "test-set-1"
 ```
 
 - `-p, --path string` - Path to the local directory where generated testcases/mocks are stored. Default is ".".
 
 ```bash
 keploy report -p "./keploy-tests"
@@ -395,7 +408,7 @@
 keploy report -t "test-set-1" --full
 ```
 
 - `--summary` - Print only a summarized view (grand totals and per–test-set table with time taken). Useful for a quick dashboard-style overview. Can be combined with `-t/--test-sets` and `--report-path`.
 
 ```bash
 keploy report --summary
@@ -411,7 +424,7 @@
 >
 > - By default, `report` shows only **failed** tests with a compact, human-readable diff (status, headers—including trailers/content-length where applicable—and body changes).
 > - Use `--full` to see the complete expected vs actual bodies (with JSON colorization).
 > - `--summary` prints just the totals and a per–test-set table, optionally restricted with `-t/--test-sets`.
 > - When `--report-path` is provided, Keploy reads that file directly. Legacy files that contain only a `tests` list are supported.
 
 ## [templatize](#templatize)
@@ -442,7 +455,7 @@
 keploy config --generate
 ```
 
 - `-p, --path string` - Path to the local directory where the Keploy Configuration File will be stored. The default is ".".
 
 ```bash
 keploy config --generate --path "./config-dir/"

versioned_docs/version-3.0.0/running-keploy/configuration-file.md

@@ -40,6 +40,9 @@
 proxyPort: 16789
 dnsPort: 26789
 debug: false
+debugModules:
+  include: []
+  exclude: []
 disableTele: false
 inDocker: false
 generateGithubActions: true
@@ -92,6 +95,27 @@
 
 ## 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.
@@ -108,7 +132,7 @@
 
 - **`delay`**: Delay in seconds before recording each request. Default is 5 seconds.
 
 - **`filters`**: API calls to the application to avoid recording. You can also control how these conditions are matched using matchType.
 
   - **`matchType (optional)`**: Determines how urlMethods and headers are evaluated.
 
@@ -244,7 +268,7 @@
 
 ### Managing Secrets with `secret.yaml`
 
 Keploy allows you to manage sensitive information like API keys or tokens securely, without hardcoding them into your test files. This is done using a `secret.yaml` file within each test set directory.
 
 1.  **Create `secret.yaml`**: Inside your test set directory (e.g., `keploy/test-set-0/`), create a file named `secret.yaml`.
 
@@ -300,7 +324,7 @@
 
 The `global subsection` of `globalNoise` is used to define parameters that are globally ignored for all API calls during testing. It enables you to filter out consistent noise, ensuring a cleaner evaluation of responses.
 
 **Note** - The examples below support both the xml as well as the json type responses.
 
 ```yml
 globalNoise: