feat: Updates fingerprinting and deduplication docs #61
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
amkera
reviewed
Feb 7, 2023
| Fingerprinting provides a way to correlate multiple tokens together that contain the same data without needing access to the underlying data. | ||
| Creating multiple tokens in a tenant with the same token type, data, and [fingerprint expression](/docs/expressions/fingerprints) will result in the same fingerprint. | ||
| This can be useful for correlating purchases with the same credit card for multiple members of the same household or helping with | ||
| master data management of multiple user accounts. Token fingerprints are also used for automatic [deduplication](#deduplication) of tokens within a tenant. |
There was a problem hiding this comment.
There was a discussion regarding preferring absolute paths a while back. Not sure if we want to adhere to that here, since this is probably linking to another section on the same page.
There was a problem hiding this comment.
We only need to use absolute paths to other pages - when I changed those before I left anchors on the same page like this since it works fine with or without the trailing slash in the url while you're already on the page
amkera
reviewed
Feb 7, 2023
docs/concepts/what-are-tokens.mdx
Outdated
| Duplicate data can be problematic for some systems. It can potentially lead to data consistency problems as multiple copies of the data | ||
| need to be kept in sync. For example, you may have an accounts payable system and an e-commerce system both accepting credit cards for customers, | ||
| and you want to ensure a single credit card is on file for that customer as the source of truth. | ||
| Deduplication may also be required within some business domains, for example, a system may collect sensitive user information and wish to |
There was a problem hiding this comment.
nit:
Suggested change
| Deduplication may also be required within some business domains, for example, a system may collect sensitive user information and wish to | |
| Deduplication may also be required within some business domains; for example, a system may collect sensitive user information and wish to |
amkera
previously approved these changes
Feb 7, 2023
armsteadj1
previously requested changes
Feb 7, 2023
docs/expressions/fingerprints.mdx
Outdated
Comment on lines
20
to
23
| Since fingerprinting performs a CPU-intensive cryptographic operation, creating tokens without fingerprints will be more performant than | ||
| creating tokens with fingerprints. We recommend that you disable the <code>Fingerprint All Tokens</code> setting in production environments | ||
| and only enable fingerprinting on a per-token basis when it is necessary. | ||
| </Alert> |
There was a problem hiding this comment.
Suggested change
| Since fingerprinting performs a CPU-intensive cryptographic operation, creating tokens without fingerprints will be more performant than | |
| creating tokens with fingerprints. We recommend that you disable the <code>Fingerprint All Tokens</code> setting in production environments | |
| and only enable fingerprinting on a per-token basis when it is necessary. | |
| </Alert> | |
| Since fingerprinting performs a CPU-intensive cryptographic operation, creating tokens with fingerprints will increase the latency of each request. For this reason, we recommend that you leave the <code>Fingerprint All Tokens</code> setting disabled, and only enable fingerprinting on a per-token basis when it is necessary unless you need every new token to be fingerprinted. | |
| </Alert> |
amkera
approved these changes
Feb 7, 2023
bt-platform-eng
pushed a commit
that referenced
this pull request
Feb 7, 2023
# [1.25.0](v1.24.0...v1.25.0) (2023-02-07) ### Features * Updates fingerprinting and deduplication docs ([#61](#61)) ([b5edb07](b5edb07))
|
🎉 This PR is included in version 1.25.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Testing required outside of automated testing?
Screenshots (if appropriate):
Rollback / Rollforward Procedure
Reviewer Checklist