chore(aap): telemetry wrapper for ato sdk v1 (#13727)

Add telemetry support for the legacy ATO SDK.

This will also be tested using system tests
DataDog/system-tests#4806

APPSEC-58051

## 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)

Author: christophe-papazian

ddtrace/appsec/trace_utils/__init__.py

@@ -1,13 +1,38 @@
 """Public API for User events"""
+from functools import wraps
 
+from ddtrace.appsec import _metrics
 from ddtrace.appsec._trace_utils import block_request  # noqa: F401
 from ddtrace.appsec._trace_utils import block_request_if_user_blocked  # noqa: F401
 from ddtrace.appsec._trace_utils import should_block_user  # noqa: F401
-from ddtrace.appsec._trace_utils import track_custom_event  # noqa: F401
-from ddtrace.appsec._trace_utils import track_user_login_failure_event  # noqa: F401
-from ddtrace.appsec._trace_utils import track_user_login_success_event  # noqa: F401
-from ddtrace.appsec._trace_utils import track_user_signup_event  # noqa: F401
+from ddtrace.appsec._trace_utils import track_custom_event
+from ddtrace.appsec._trace_utils import track_user_login_failure_event
+from ddtrace.appsec._trace_utils import track_user_login_success_event
+from ddtrace.appsec._trace_utils import track_user_signup_event
 import ddtrace.internal.core
 
 
 ddtrace.internal.core.on("set_user_for_asm", block_request_if_user_blocked, "block_user")
+
+
+def _telemetry_report_factory(event_name: str):
+    """
+    Factory function to create a telemetry report decorator.
+    This decorator will report the event name when the decorated function is called.
+    """
+
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            _metrics._report_ato_sdk_usage(event_name, False)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+track_custom_event = _telemetry_report_factory("custom")(track_custom_event)
+track_user_login_success_event = _telemetry_report_factory("login_success")(track_user_login_success_event)
+track_user_login_failure_event = _telemetry_report_factory("login_failure")(track_user_login_failure_event)
+track_user_signup_event = _telemetry_report_factory("signup")(track_user_signup_event)

tests/appsec/appsec/test_appsec_trace_utils.py

@@ -1,4 +1,6 @@
 import logging
+from unittest.mock import MagicMock
+from unittest.mock import patch as mock_patch
 
 import pytest
 
@@ -14,12 +16,17 @@
 from ddtrace.appsec.track_user_sdk import track_user
 from ddtrace.contrib.internal.trace_utils import set_user
 from ddtrace.ext import user
+import ddtrace.internal.telemetry
 import tests.appsec.rules as rules
 from tests.appsec.utils import asm_context
 from tests.appsec.utils import is_blocked
 from tests.utils import TracerTestCase
 
 
+def get_telemetry_metrics(mocked):
+    return [(args[0].value, args[1].value) + args[2:] for args, kwargs in mocked.add_metric.call_args_list]
+
+
 config_asm = {"_asm_enabled": True}
 config_good_rules = {"_asm_static_rule_file": rules.RULES_GOOD_PATH, "_asm_enabled": True}
 
@@ -137,7 +144,9 @@ def test_track_user_login_event_success_auto_mode_extended(self):
             assert root_span.get_tag(APPSEC.AUTO_LOGIN_EVENTS_SUCCESS_MODE) == str(LOGIN_EVENTS_MODE.IDENT)
 
     def test_track_user_login_event_success_with_metadata(self):
-        with asm_context(tracer=self.tracer, span_name="test_success2", config=config_asm):
+        with mock_patch.object(
+            ddtrace.internal.telemetry.telemetry_writer, "_namespace", MagicMock()
+        ) as telemetry_mock, asm_context(tracer=self.tracer, span_name="test_success2", config=config_asm):
             track_user_login_success_event(self.tracer, "1234", metadata={"foo": "bar"})
             root_span = self.tracer.current_root_span()
             assert root_span.get_tag("appsec.events.users.login.success.track") == "true"
@@ -152,6 +161,14 @@ def test_track_user_login_event_success_with_metadata(self):
             assert not root_span.get_tag(user.SCOPE)
             assert not root_span.get_tag(user.ROLE)
             assert not root_span.get_tag(user.SESSION_ID)
+            metrics = get_telemetry_metrics(telemetry_mock)
+            assert (
+                "count",
+                "appsec",
+                "sdk.event",
+                1,
+                (("event_type", "login_success"), ("sdk_version", "v1")),
+            ) in metrics
 
     def test_track_user_login_event_failure_user_exists(self):
         with asm_context(tracer=self.tracer, span_name="test_failure", config=config_asm):
@@ -192,7 +209,9 @@ def test_track_user_login_event_failure_user_exists(self):
             assert not root_span.get_tag(user.SESSION_ID)
 
     def test_track_user_login_event_failure_user_doesnt_exists(self):
-        with self.trace("test_failure"):
+        with mock_patch.object(
+            ddtrace.internal.telemetry.telemetry_writer, "_namespace", MagicMock()
+        ) as telemetry_mock, self.trace("test_failure"):
             track_user_login_failure_event(
                 self.tracer,
                 "john",
@@ -202,22 +221,34 @@ def test_track_user_login_event_failure_user_doesnt_exists(self):
             root_span = self.tracer.current_root_span()
             failure_prefix = "%s.failure" % APPSEC.USER_LOGIN_EVENT_PREFIX_PUBLIC
             assert root_span.get_tag("%s.%s" % (failure_prefix, user.EXISTS)) == "false"
+            metrics = get_telemetry_metrics(telemetry_mock)
+            assert metrics == [
+                ("count", "appsec", "sdk.event", 1, (("event_type", "login_failure"), ("sdk_version", "v1")))
+            ]
 
     def test_track_user_signup_event_exists(self):
-        with self.trace("test_signup_exists"):
+        with mock_patch.object(
+            ddtrace.internal.telemetry.telemetry_writer, "_namespace", MagicMock()
+        ) as telemetry_mock, self.trace("test_signup_exists"):
             track_user_signup_event(self.tracer, "john", True)
             root_span = self.tracer.current_root_span()
             assert root_span.get_tag(APPSEC.USER_SIGNUP_EVENT) == "true"
             assert root_span.get_tag(user.ID) == "john"
+            metrics = get_telemetry_metrics(telemetry_mock)
+            assert metrics == [("count", "appsec", "sdk.event", 1, (("event_type", "signup"), ("sdk_version", "v1")))]
 
     def test_custom_event(self):
-        with self.trace("test_custom"):
+        with mock_patch.object(
+            ddtrace.internal.telemetry.telemetry_writer, "_namespace", MagicMock()
+        ) as telemetry_mock, self.trace("test_custom"):
             event = "some_event"
             track_custom_event(self.tracer, event, {"foo": "bar"})
             root_span = self.tracer.current_root_span()
 
             assert root_span.get_tag("%s.%s.foo" % (APPSEC.CUSTOM_EVENT_PREFIX, event)) == "bar"
             assert root_span.get_tag("%s.%s.track" % (APPSEC.CUSTOM_EVENT_PREFIX, event)) == "true"
+            metrics = get_telemetry_metrics(telemetry_mock)
+            assert metrics == [("count", "appsec", "sdk.event", 1, (("event_type", "custom"), ("sdk_version", "v1")))]
 
     def test_set_user_blocked(self):
         with asm_context(tracer=self.tracer, span_name="fake_span", config=config_good_rules) as span: