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

[DOCS-6870] Add OP SDS transform guide #20962

Merged
merged 9 commits into from
Dec 14, 2023

Conversation

maycmlee
Copy link
Contributor

@maycmlee maycmlee commented Dec 8, 2023

What does this PR do? What is the motivation?

Adds new guide for OP SDS transform.

DOCS-6870

Merge instructions

  • Please merge after reviewing

Additional notes

@maycmlee maycmlee added the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 8, 2023
@maycmlee maycmlee requested a review from a team as a code owner December 8, 2023 22:11
@github-actions github-actions bot added the Guide Content impacting a guide label Dec 8, 2023
Copy link
Contributor

github-actions bot commented Dec 8, 2023

@maycmlee maycmlee requested a review from jszwedko December 8, 2023 22:14
@jszwedko jszwedko requested review from bruceg and fuchsnj December 11, 2023 14:57
Copy link
Contributor

@estherk15 estherk15 left a comment

Choose a reason for hiding this comment

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

Very cool! Left non-blocking suggestions!

Copy link
Contributor

@fuchsnj fuchsnj left a comment

Choose a reason for hiding this comment

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

Overall it looks good, just some small comments


### Using regex for custom rules

The `sensitive_data_scanner` transform supports Perl Compatible RegEx (PCRE), but the following patterns are not supported:
Copy link
Contributor

@fuchsnj fuchsnj Dec 13, 2023

Choose a reason for hiding this comment

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

Suggested change
The `sensitive_data_scanner` transform supports Perl Compatible RegEx (PCRE), but the following patterns are not supported:
The `sensitive_data_scanner` transform supports Perl Compatible RegEx (PCRE2), but the following patterns are not supported:

The supported syntax is a subset of PCRE2. I have compiled an exhaustive list of exactly what is supported if that helps here at all: https://datadoghq.atlassian.net/wiki/spaces/SDS/pages/3221292288/SDS+Regex+Syntax

Just note that the syntax listed above is what the Core SDS library supports. OPW is currently using a different implementation (which is NOT PCRE or PCRE2 compliant) but it will be switched out very soon (likely next week).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @fuchsnj, good to know! I'd like to publish this doc this week, do you think it makes sense to remove this information for now, and then add it back when OPW has switched to be PCRE2 compliant?

Also, thanks for the confluence link. At some point, it seems we should have public documentation on what regex syntax is supported? Is it usually so specific what syntax is available? Or can we point them to the regex101.com site you mention?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd like to publish this doc this week, do you think it makes sense to remove this information for now, and then add it back when OPW has switched to be PCRE2 compliant?

It's probably fine to keep it as PCRE2 for now. The differences are fairly subtle and not something users are likely to notice.

At some point, it seems we should have public documentation on what regex syntax is supported?

That confluence doc is mostly for internal documentation now, and to help write any public documentation whenever that happens. I don't expect you to include the whole thing here. I expect in the future we will probably have more detailed public docs about the regex syntax in the SDS docs that you could link to here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perfect, thanks for the info!

@maycmlee maycmlee merged commit fb7c08a into master Dec 14, 2023
10 checks passed
@maycmlee maycmlee deleted the may/docs-6870/sds-transform-guide branch December 14, 2023 15:42
MaelNamNam pushed a commit that referenced this pull request Jan 17, 2024
* add guide

* edits

* Update content/en/observability_pipelines/guide/sensitive_data_scanner_transform.md

Co-authored-by: Bruce Guenter <[email protected]>

* add frontmatter

* Update content/en/observability_pipelines/guide/sensitive_data_scanner_transform.md

Co-authored-by: Esther Kim <[email protected]>

* apply suggestions

* add hashing info

* Update content/en/observability_pipelines/guide/sensitive_data_scanner_transform.md

Co-authored-by: Nathan Fox <[email protected]>

---------

Co-authored-by: Bruce Guenter <[email protected]>
Co-authored-by: Esther Kim <[email protected]>
Co-authored-by: Nathan Fox <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Guide Content impacting a guide WORK IN PROGRESS No review needed, it's a wip ;)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants