Optimize getFieldFilter to only return a predicate when index has FLS restrictions for user #5777
+29
−1
Conversation
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
… restrictions for user Signed-off-by: Craig Perkins <cwperx@amazon.com>
cwperks
requested review from
DarshitChanpura,
RyanL1997,
derek-ho,
nibix,
peternied,
reta,
shikharj05 and
willyborankin
as code owners
Signed-off-by: Craig Perkins <cwperx@amazon.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #5777 +/- ##
==========================================
+ Coverage 73.66% 73.74% +0.08%
==========================================
Files 438 438
Lines 26660 26654 -6
Branches 3939 3939
==========================================
+ Hits 19638 19655 +17
+ Misses 5148 5126 -22
+ Partials 1874 1873 -1
🚀 New features to boost your workflow:
|
Collaborator
|
Are there any hot thread dumps or profiling data available for cases where performance issues were observed? Would be curious to have a look at it. |
nibix
previously approved these changes
Nov 7, 2025
Collaborator
nibix
left a comment
nibix
left a comment
There was a problem hiding this comment.
Approving. Yet, this only covers the case when no FLS protection is present at all. If there is only a single protected field, we get the old performance profile.
It might be worthwhile to have a closer look at the cause of the issues in order to be able to improve these scenarios as well.
I could take a look at that.
Member
Author
The main cause is lack of resiliency measures to the GET _mapping API so any optimization in security is only of marginal gain IMO. I believe I've identified an opportunity to de-dup indices with the same mappings in the cluster state (for example rolled over indices). FYI In core I tried also adding some resiliency measures for GET _mapping API:
I'm looking into a 3rd improvement in the core as well to cut the in-memory size of the cluster state by keeping a mapping pool. |
Member
Author
|
Example hot threads dump: |
DarshitChanpura
previously approved these changes
Nov 26, 2025
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
DarshitChanpura
previously approved these changes
Nov 26, 2025
Member
|
opensearch-project/OpenSearch#19803 |
Member
Author
Planning to fix that in #5815 |
Signed-off-by: Craig Perkins <cwperx@amazon.com>
DarshitChanpura
previously approved these changes
Nov 26, 2025
shikharj05
reviewed
Dec 1, 2025
| try { | ||
| indexHasRestrictions = dlsFlsValve.indexHasFlsRestrictions(index, ctx); | ||
| } catch (PrivilegesEvaluationException e) { | ||
| log.error("Error while evaluating FLS restrictions for {}", index, e); |
Collaborator
There was a problem hiding this comment.
should the exception be re-thrown?
Member
Author
There was a problem hiding this comment.
I moved this block into the try-catch
if (!indexHasRestrictions) {
return NOOP_FIELD_PREDICATE;
}
In the event of an error, it will use the existing field-level check which I think is sensible.
Signed-off-by: Craig Perkins <cwperx@amazon.com>
…perks/security into get-field-filter-optimization
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
This is another optimization for GET _mapping calls when running with the security plugin. This PR is similar to #5752 and avoids calling
dlsFlsValve.isFieldAllowed(index, field, ctx)for indices without restrictions. With the changes in this PR, security will only return a predicate to filter fields on indices that have FLS restrictions for the current user.Enhancement
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.