Skip to content
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

feat(core): improve entitlements performance #1271

Merged
merged 25 commits into from
Aug 12, 2024

Conversation

suchak1
Copy link
Contributor

@suchak1 suchak1 commented Aug 7, 2024

Context:

While developing COP, we found that GetEntitlements could take around 5.5 seconds to return a response for the federal dataset. This forced us to increase the server timeout, increase the grpc message size, and implement caches.

After investigating the latency, we determined the two main causes: excess logs (33%) and excess database queries (66%).

Proposed Solution:

Primary

  1. In the case of logging subject mappings, we now log their count instead of their content.
  2. In the case of database calls, we now list attributes, list subject mappings, and match them based on their values. The database calls were O(n) time complexity because they were dependent on the number of attribute values. Now the database calls are constant time. We still loop through all the values to match their subject mappings; however we were already doing that in the prepareValues values function, so the new approach is strictly better (especially due to our ubiquitous use of maps).

Rego Query Optimization:

Yet if we simply match subject mappings and attribute values, the rego query becomes massive (65 mb). It takes 3 seconds to build (20%) and evaluate (80%). To optimize for not only time but also space, we remove unrelated values for each fqn/attribute pair in the rego input (unless the attribute rule is hierarchical).

After all the optimizations, fetching entitlements using the federal dataset now takes about 125 ms. This is a latency reduction of 98%.

resolves: #1259

@suchak1 suchak1 requested review from a team as code owners August 7, 2024 06:59
Copy link
Contributor

github-actions bot commented Aug 7, 2024

Warning

This pull request does not reference any issues. Please add a reference to an issue in the body of the pull request description.

@suchak1 suchak1 marked this pull request as draft August 7, 2024 06:59
@suchak1 suchak1 linked an issue Aug 7, 2024 that may be closed by this pull request
@suchak1 suchak1 marked this pull request as ready for review August 8, 2024 12:12
Copy link
Member

@jrschumacher jrschumacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@suchak1 this looks good. Could we add some comments to make sure others understand what's happening?

jrschumacher
jrschumacher previously approved these changes Aug 8, 2024
Copy link
Member

@jrschumacher jrschumacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

ttschampel
ttschampel previously approved these changes Aug 8, 2024
@strantalis
Copy link
Member

@suchak1 Would the MatchSubjectMappings rpc have helped here?

@suchak1
Copy link
Contributor Author

suchak1 commented Aug 8, 2024

No, since the MatchSubjectMappings rpc just matches SubjectConditionSets with SubjectMappings and returns those SubjectMappings based on the provided SubjectConditionSets conditions.

strantalis
strantalis previously approved these changes Aug 9, 2024
@suchak1 suchak1 enabled auto-merge August 9, 2024 19:19
@suchak1 suchak1 added this pull request to the merge queue Aug 12, 2024
Merged via the queue into main with commit f6a1b26 Aug 12, 2024
19 checks passed
@suchak1 suchak1 deleted the feature/speed-up-entitlements branch August 12, 2024 18:59
github-merge-queue bot pushed a commit that referenced this pull request Aug 12, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.4.18](service/v0.4.17...service/v0.4.18)
(2024-08-12)


### Features

* **authz:** Remove external ers configuration from authorization
([#1265](#1265))
([aa925a8](aa925a8))
* **authz:** Typed Entities
([#1249](#1249))
([cfab3ad](cfab3ad))
* **core:** ability to run a set of isolated services
([#1245](#1245))
([aa5636a](aa5636a))
* **core:** improve entitlements performance
([#1271](#1271))
([f6a1b26](f6a1b26))
* **core:** policy support for LIST of kas grants (protos/db)
([#1317](#1317))
([599fc56](599fc56))
* **core:** Simplifies support for kidless clients
([#1272](#1272))
([dedeb32](dedeb32))
* **policy:** 1256 resource mapping groups db support
([#1270](#1270))
([c020e9b](c020e9b))
* **policy:** 1277 add Resource Mapping Group to objects proto
([#1309](#1309))
([514f1b8](514f1b8)),
closes [#1277](#1277)


### Bug Fixes

* **core:** Autobump service
([#1322](#1322))
([9460fb5](9460fb5))
* **core:** casbin policy should support assign/remove/deactivate rpc
naming ([#1298](#1298))
([288921b](288921b)),
closes [#1303](#1303)
* **core:** put back proto breaking change detection in CI
([#1292](#1292))
([9921962](9921962)),
closes [#1293](#1293)
* **core:** Update casbin policy for rewrap with unknown role
([#1305](#1305))
([de5be3c](de5be3c))
* **policy:** deprecates and reserves value members from value object in
protos ([#1151](#1151))
([07fcc9e](07fcc9e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Slow response with GetEntitlement requests
6 participants