[DOCS] Fingerprint ingest processor #68610
Merged
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
danhermann
added
>docs
elasticmachine
added
Team:Docs
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
Collaborator
|
Pinging @elastic/es-core-features (Team:Core/Features) |
jrodewig
approved these changes
Feb 5, 2021
Contributor
jrodewig
left a comment
jrodewig
left a comment
There was a problem hiding this comment.
LGTM.
I left a few minor nits but nothing blocking. Feel free to disregard if wanted. Thanks @danhermann!
Comment on lines
9
to
10
| Calculates a hash that can be used for content fingerprinting based on the | ||
| content of the specified fields in a document. |
Contributor
There was a problem hiding this comment.
Nit: I'd split this into two sentences for clarity.
Suggested change
| Calculates a hash that can be used for content fingerprinting based on the | |
| content of the specified fields in a document. | |
| Computes a hash of the document's content. You can use this hash for | |
| {wikipedia}/Fingerprint_(computing)[content fingerprinting]. |
Comment on lines
17
to
18
| | `fields` | yes | n/a | Array containing the names of the document | ||
| fields whose content will be used to compute the fingerprint |
Contributor
There was a problem hiding this comment.
I'd clarify "content" here as we discussed offline. I'd also add a period for consistency.
Suggested change
| | `fields` | yes | n/a | Array containing the names of the document | |
| fields whose content will be used to compute the fingerprint | |
| | `fields` | yes | n/a | Array of fields to include in | |
| the fingerprint. For objects, the processor hashes both the field key and | |
| value. For other fields, the processor hashes only the field value. |
Comment on lines
20
to
21
| | `salt` | no | <none> | Salt value that will be applied to every | ||
| fingerprint calculated by this processor |
Contributor
There was a problem hiding this comment.
Nit: I'd add a link and a period.
Suggested change
| | `salt` | no | <none> | Salt value that will be applied to every | |
| fingerprint calculated by this processor | |
| | `salt` | no | <none> | | |
| {wikipedia}/Salt_(cryptography)[Salt value] for the hash function. |
Comment on lines
24
to
26
| | `ignore_missing` | no | `false` | If true, any missing elements in `fields` | ||
| will be ignored when computing the fingerprint. If all fields are missing, the processor | ||
| silently exits without modifying the document. |
Contributor
There was a problem hiding this comment.
Minor nit: I'd make true a literal and reword the first sentence for active voice.
Suggested change
| | `ignore_missing` | no | `false` | If true, any missing elements in `fields` | |
| will be ignored when computing the fingerprint. If all fields are missing, the processor | |
| silently exits without modifying the document. | |
| | `ignore_missing` | no | `false` | If `true`, the processor | |
| ignores any missing `fields`. If all fields are missing, the processor silently | |
| exits without modifying the document. |
|
|
||
| [discrete] | ||
| [[fingerprint-processor-ex]] | ||
| ===== Examples |
Contributor
There was a problem hiding this comment.
Nit
Suggested change
| ===== Examples | |
| ===== Example |
| } | ||
| ---- | ||
| // TESTRESPONSE[s/\.\.\./"_index":"_index","_id":"_id","_ingest":{"timestamp":$body.docs.0.doc._ingest.timestamp},/] | ||
| // NOTCONSOLE |
Contributor
Contributor
Author
|
@elasticmachine update branch |
Contributor
Author
danhermann
added a commit
to danhermann/elasticsearch
that referenced
this pull request
Mar 16, 2021
danhermann
added a commit
to danhermann/elasticsearch
that referenced
this pull request
Mar 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Documentation for the processor added in #68415.
Depends on #68415.