chore(console): Add a note about Heap and data redaction

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8521
GitOrigin-RevId: cd0b148febc510e37da0b0a53af92a7653916648
This commit is contained in:
Stefano Magni 2023-03-28 10:26:58 +02:00 committed by hasura-bot
parent b167aa84d1
commit 05c935a607
2 changed files with 6 additions and 0 deletions

View File

@ -10,6 +10,9 @@ import type { RedactOptions, HtmlRedactAttributes } from './types';
*/
export const REDACT_EVERYTHING: RedactOptions = {
redactText: true,
// Please note that ids cannot be fully redacted, be sure ids do not contain sensitive information.
// see https://developers.heap.io/docs/web#precise-data-redaction-via-heap-redact
htmlAttributesToRedact:
'id,title,data-test,data-element,data-cy,data-testid,data-index-id,data-key,href,value,name,key,placeholder,for',
};

View File

@ -43,6 +43,9 @@ export interface RedactOptions {
redactText?: boolean;
/**
* A comma-separated list of HTML attributes to redact.
*
* Please note that ids cannot be fully redacted, be sure ids do not contain sensitive information.
* @see https://developers.heap.io/docs/web#precise-data-redaction-via-heap-redact
*/
htmlAttributesToRedact?: string;
}