Skip to content

[docs] Warn that debug logging can expose passwords #17458

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

Open
wants to merge 1 commit into
base: 8.17
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/static/logging.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ example, if you are debugging issues with Elasticsearch Output, you can increase
log levels just for that component. This approach reduces noise from
excessive logging and helps you focus on the problem area.

NOTE: When debug logging is enabled in Logstash, sensitive information such as passwords may be logged in plain text. This is because debug logging is intended to provide detailed information about the system's operation, which can include configuration settings and other sensitive data. Enable debug logging only when necessary for troubleshooting specific issues. Once the issue is resolved, switch back to a less verbose logging level (such as INFO or WARN) to avoid exposing sensitive information. If you need to share logs with others (e.g., for support purposes), make sure to redact or remove any sensitive information, such as passwords, before sharing.

You can configure logging using the `log4j2.properties` file or the Logstash API.

* *`log4j2.properties` file.* Changes made through the `log4j2.properties`
Expand Down