Repository navigation
docs: Keploy's logs carry no application data unless KEPLOY_LOG_CONTENT is set - #933
Draft
slayerjain wants to merge 1 commit into
Draft
slayerjain wants to merge 1 commit into
slayerjain wants to merge 1 commit into
Conversation
…NT is set Debug logs, agent-debug.log included, name a payload, a header value, a query value or a row by its length and fingerprint. KEPLOY_LOG_CONTENT=1 opts into the data itself; the page says where it applies, what it costs, and that reports still show the values they compare. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
1 of 5 tasks
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents
KEPLOY_LOG_CONTENT, from keploy/keploy#4858 (the switch) and keploy/keploy#4861 (the log lines it gates). Merge with the keploy release that ships them.What changes for users
Keploy's log lines no longer carry the application's data by default: request and response bodies, header values, URL query values, database rows and bind values, recorded mocks. That holds at every level,
--debugincluded, on the console, inkeploy-logs.txt, and in the agent'sagent-debug.log, which the agent writes on every Docker-mode run. A line names such a value by its length and a 12-hex-digit fingerprint, beside facts that are not data (message type, method and path, header names, ids, counts).KEPLOY_LOG_CONTENT=1(ortrue), read once at start, opts back into the data itself. Keploy passes it on to the agent it starts, in a container or throughsudo.The edit
versioned_docs/version-4.0.0/running-keploy/cli-commands.md:--debugentries ofrecordandtestlink to it.prettier@2.8.8 --checkpasses on the page.