Skip to content

Add a note that obfuscate literals does not work with malformed queries #2318

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 7, 2025
Merged

Add a note that obfuscate literals does not work with malformed queries #2318

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e4ec33
Add a note that obfuscate literals does not work with malformed queries
renetapopova May 6, 2025
b6b62a0
fix the failing test
renetapopova May 7, 2025
36c5e85
Update modules/ROOT/pages/configuration/configuration-settings.adoc
renetapopova May 7, 2025
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
6 changes: 5 additions & 1 deletion modules/ROOT/pages/configuration/configuration-settings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1699,7 +1699,7 @@ m|+++true+++
|Description
a|The load balancing plugin to use.
|Valid values
a|A string that specified load balancer plugin exist..
a|A string.
|Default value
m|+++server_policies+++
|===
Expand Down Expand Up @@ -2457,6 +2457,10 @@ a|A boolean.
m|+++false+++
|===

[NOTE]
====
Keep in mind that if Neo4j receives a malformed query that cannot be parsed, it cannot obfuscate its literals (because it does not know which parts are literals) and, therefore, the query text will not be included in any logging.
====

[role=label--dynamic]
[[config_db.logs.query.parameter_logging_enabled]]
Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/monitoring/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,8 +875,10 @@ This is useful when Cypher queries expose sensitive information.
====
Node labels, relationship types, and map property keys are still shown.
Changing the setting does not affect cached queries.
Therefore, if you want the switch to have an immediate effect, you must also clear the query cache; `CALL db.clearQueryCaches()`.
Therefore, if you want the switch to have an immediate effect, you must also clear the query cache; `CALL db.clearQueryCaches()`. +
Also, keep in mind that if Neo4j receives a malformed query that cannot be parsed, it cannot obfuscate its literals (because it does not know which parts are literals) and, therefore, the query text will not be included in any logging.
====

[WARNING]
====
This does not obfuscate literals in parameters.
Expand Down