Skip to content

[python] update python weblogs for ato sdk v2 #4565

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

Merged
merged 10 commits into from
May 5, 2025

Conversation

christophe-papazian
Copy link
Contributor

@christophe-papazian christophe-papazian commented Apr 25, 2025

To be merged after DataDog/dd-trace-py#13251

  • enable new sdk tests for ATO
  • move all old sdk endpoints to the new sdk for django to check the transition to the new SDK can be done without loss of features. flask and fastapi keep the old sdk to check for unexpected changes in the old sdk
  • for fastapi and flask, we keep the old sdk for all the old tests, to keep coverage on the previous sdk.

APPSEC-56663

Workflow

  1. ⚠️ Create your PR as draft ⚠️
  2. Work on you PR until the CI passes (if something not related to your task is failing, you can ignore it)
  3. Mark it as ready for review
    • Test logic is modified? -> Get a review from RFC owner. We're working on refining the codeowners file quickly.
    • Framework is modified, or non obvious usage of it -> get a review from R&P team

🚀 Once your PR is reviewed, you can merge it!

🛟 #apm-shared-testing 🛟

Reviewer checklist

  • If PR title starts with [<language>], double-check that only <language> is impacted by the change
  • No system-tests internal is modified. Otherwise, I have the approval from R&P team
  • CI is green, or failing jobs are not related to this change (and you are 100% sure about this statement)
  • A docker base image is modified?
    • the relevant build-XXX-image label is present
  • A scenario is added (or removed)?

christophe-papazian added a commit to DataDog/dd-trace-py that referenced this pull request Apr 30, 2025
A new public SDK for ATO/user events for AAP.
Available with 
```python
from ddtrace.appsec import track_user_sdk

# to track successful login attempts
track_user_sdk.track_login_success(login, user_id:optional, metadata:optional)
# to track failed login attempts
track_user_sdk.track_login_failure(login, exists, user_id:optional, metadata:optional)
# to track any custom event
track_user_sdk.track_custom_event(event, metatada)
# to track signup events
track_user_sdk.track_signup(login,  user_id:optional, success:optional, metadata:optional)
# to track authentified user (usually in middleware, using auth token)
track_user_sdk.track_user(login,  user_id, session_id:optional, metadata:optional)

```

Also: 
- minor fixes and improvements in current ATO support.
- threat tests added for sdk (span tags and telemetry unit tests)

This will be validated in system tests with
DataDog/system-tests#4565

The documentation page to be updated is
https://docs.datadoghq.com/security/application_security/threats/add-user-info/?tab=loginsuccess&code-lang=python

APPSEC-56663

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
@christophe-papazian christophe-papazian changed the title [python] update django for ato sdk v2 [python] update python weblogs for ato sdk v2 Apr 30, 2025
@christophe-papazian christophe-papazian marked this pull request as ready for review April 30, 2025 15:38
@christophe-papazian christophe-papazian requested review from a team as code owners April 30, 2025 15:38
@christophe-papazian christophe-papazian requested review from juanjux and erikayasuda and removed request for a team April 30, 2025 15:38
@avara1986 avara1986 merged commit 0d3c0a3 into main May 5, 2025
93 of 94 checks passed
@avara1986 avara1986 deleted the christophe-papazian/use_ato_sdk_v2_for_django branch May 5, 2025 11:29
brettlangdon pushed a commit to DataDog/dd-trace-py that referenced this pull request May 6, 2025
A new public SDK for ATO/user events for AAP.
Available with 
```python
from ddtrace.appsec import track_user_sdk

# to track successful login attempts
track_user_sdk.track_login_success(login, user_id:optional, metadata:optional)
# to track failed login attempts
track_user_sdk.track_login_failure(login, exists, user_id:optional, metadata:optional)
# to track any custom event
track_user_sdk.track_custom_event(event, metatada)
# to track signup events
track_user_sdk.track_signup(login,  user_id:optional, success:optional, metadata:optional)
# to track authentified user (usually in middleware, using auth token)
track_user_sdk.track_user(login,  user_id, session_id:optional, metadata:optional)

```

Also: 
- minor fixes and improvements in current ATO support.
- threat tests added for sdk (span tags and telemetry unit tests)

This will be validated in system tests with
DataDog/system-tests#4565

The documentation page to be updated is
https://docs.datadoghq.com/security/application_security/threats/add-user-info/?tab=loginsuccess&code-lang=python

APPSEC-56663

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants