Skip to content

Add doc for automatic user ID collection modes and remote-config #23871

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

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

obordeau
Copy link
Contributor

What does this PR do? What is the motivation?

Merge instructions

  • Please merge after reviewing

Additional notes

@obordeau obordeau added WORK IN PROGRESS No review needed, it's a wip ;) Do Not Merge Just do not merge this PR :) labels Jun 26, 2024
@github-actions github-actions bot added the Images Images are added/removed with this PR label Jun 26, 2024
Copy link
Contributor

github-actions bot commented Jun 26, 2024

Preview links (active after the build_preview check completes)

Modified Files

@obordeau obordeau force-pushed the oceane.bordeau/update-auto-user-instrum-doc branch from b22224e to fa05ac8 Compare June 26, 2024 13:04
Copy link
Contributor

@jkirsteins jkirsteins left a comment

Choose a reason for hiding this comment

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

Overall LGTM. We should get rid of before x in two places, and mention why people might want to turn the feature off (or rather - why they shouldn't). Added the appropriate suggestions.

@@ -712,6 +712,8 @@ The events that can be automatically detected are:

### Automatic user activity event tracking mode

<div class="alert alert-warning"><strong>This is deprecated</strong> and only applies to older agent versions before x</div>
Copy link
Contributor

Choose a reason for hiding this comment

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

before x - we should link to the compatibility page here: https://docs.datadoghq.com/security/application_security/enabling/compatibility/

As the version depends per-library, we can't list all of them here.

**Note**: There could be cases in which the trace library won't be able to extract any information from the user event. The event would be reported with empty metadata. In those cases, we recommend using the [SDK](#adding-business-logic-information-login-success-login-failure-any-business-logic-to-traces) to manually instrument the user events.

## Disabling automatic user activity event tracking

<div class="alert alert-warning"><strong>This is deprecated</strong> and only applies to older agent versions before x</div>
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above - before x (suggest to link to the compatibility page)

@jkirsteins
Copy link
Contributor

Note: we should not merge this until we have the green light from @Julio-Guerra that the feature is available and the corresponding compatibility page is updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Do Not Merge Just do not merge this PR :) Images Images are added/removed with this PR WORK IN PROGRESS No review needed, it's a wip ;)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants