Add support for v1 trace payloads in the library interface for DEFAULT scenario

[ajgajg1134]

Motivation

To better cover the efficient trace payload (aka V1), this adds support for acting on v1 trace payloads to the default scenario on the tracer side. The agent interface already supported this, but there are far more assertions on the library side of things so this change is very valuable. And in fact this work caught a bug around how appsec meta_struct data was being handled.

Additionally I had to modify utils/build/docker/golang/install_ddtrace.sh to support testing against a specific PR of dd-trace-go for this development. It seems that due to contribs having their own modules the previous go get code wouldn't properly handle unreleased/unmerged PRs? But I admit I don't fully understand the motivations here so am willing to adjust these changes as needed!

Changes

Access span/trace data through helper methods on the interface to ensure they are payload-format agnostic. I verified this by running with dd-trace-go with v1 enabled.

Much of this change was created with the assistance of Cursor / AI. I (the human) have read and reviewed every line of code though to ensure it is reasonable and accomplishes the desired purpose

Workflow

1. ⚠️ Create your PR as draft ⚠️
2. Work on you PR until the CI passes
3. Mark it as ready for review
   • Test logic is modified? -> Get a review from RFC owner.
   • Framework is modified, or non obvious usage of it -> get a review from R&P team

🚀 Once your PR is reviewed and the CI green, you can merge it!

🛟 #apm-shared-testing 🛟

Reviewer checklist

• Anything but tests/ or manifests/ is modified ? I have the approval from R&P team
• A docker base image is modified?
  • the relevant build-XXX-image label is present
• A scenario is added, removed or renamed?
  • Get a review from R&P team

[github-actions]

CODEOWNERS have been resolved as:

tests/appsec/api_security/test_api_security_rc.py                       @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/api_security/test_apisec_sampling.py                       @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/api_security/test_custom_data_classification.py            @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/api_security/test_endpoint_fallback.py                     @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/api_security/test_schemas.py                               @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/iast/test_vulnerability_schema.py                          @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/iast/utils.py                                              @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/rasp/test_api10.py                                         @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/rasp/utils.py                                              @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_asm_standalone.py                                     @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_automated_login_events.py                             @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_automated_user_and_session_tracking.py                @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_blocking_addresses.py                                 @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_event_tracking.py                                     @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_extended_data_collection.py                           @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_extended_header_collection.py                         @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_extended_request_body_collection.py                   @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_fingerprinting.py                                     @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_identify.py                                           @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_metastruct.py                                         @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_reports.py                                            @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_shell_execution.py                                    @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_traces.py                                             @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/test_user_blocking_full_denylist.py                        @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/waf/test_addresses.py                                      @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/waf/test_blocking_security_response_id.py                  @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/waf/test_exclusions.py                                     @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/waf/test_reports.py                                        @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/waf/test_telemetry.py                                      @DataDog/asm-libraries @DataDog/system-tests-core
tests/appsec/waf/test_truncation.py                                     @DataDog/asm-libraries @DataDog/system-tests-core
tests/external_processing/test_apm.py                                   @DataDog/asm-libraries @DataDog/system-tests-core
tests/integrations/crossed_integrations/test_kafka.py                   @DataDog/system-tests-core
tests/integrations/crossed_integrations/test_kinesis.py                 @DataDog/system-tests-core
tests/integrations/crossed_integrations/test_rabbitmq.py                @DataDog/system-tests-core
tests/integrations/crossed_integrations/test_sns_to_sqs.py              @DataDog/system-tests-core
tests/integrations/crossed_integrations/test_sqs.py                     @DataDog/system-tests-core
tests/integrations/test_dbm.py                                          @DataDog/system-tests-core
tests/integrations/test_inferred_proxy.py                               @DataDog/system-tests-core
tests/integrations/utils.py                                             @DataDog/system-tests-core
tests/test_config_consistency.py                                        @DataDog/system-tests-core
tests/test_data_integrity.py                                            @DataDog/system-tests-core
tests/test_distributed.py                                               @DataDog/system-tests-core
tests/test_graphql.py                                                   @DataDog/system-tests-core
tests/test_identify.py                                                  @DataDog/system-tests-core
tests/test_library_conf.py                                              @DataDog/system-tests-core
tests/test_resource_renaming.py                                         @DataDog/system-tests-core
tests/test_sampling_rates.py                                            @DataDog/system-tests-core
tests/test_scrubbing.py                                                 @DataDog/system-tests-core
tests/test_semantic_conventions.py                                      @DataDog/system-tests-core
tests/test_span_events.py                                               @DataDog/system-tests-core
tests/test_standard_tags.py                                             @DataDog/system-tests-core
utils/build/docker/golang/install_ddtrace.sh                            @DataDog/dd-trace-go-guild @DataDog/system-tests-core
utils/dd_constants.py                                                   @DataDog/system-tests-core
utils/interfaces/_agent.py                                              @DataDog/system-tests-core
utils/interfaces/_backend.py                                            @DataDog/system-tests-core
utils/interfaces/_library/appsec.py                                     @DataDog/system-tests-core
utils/interfaces/_library/core.py                                       @DataDog/system-tests-core
utils/interfaces/_library/miscs.py                                      @DataDog/system-tests-core
utils/proxy/traces/trace_v1.py                                          @DataDog/system-tests-core
utils/tools.py                                                          @DataDog/system-tests-core

[datadog-datadog-prod-us1]

⚠️ Tests

✨ Fix all issues with Cursor

⚠️ Warnings

❄️ 1 New flaky test detected

tests.parametric.test_dynamic_configuration.TestDynamicConfigSamplingRules.test_remote_sampling_rules_retention[library_env0, parametric-python] from system_tests_suite (Datadog) (Fix with Cursor)

assert 1.0 == 0.1 ± 1.0e-07
  comparison failed
  Obtained: 1.0
  Expected: 0.1 ± 1.0e-07

self = <tests.parametric.test_dynamic_configuration.TestDynamicConfigSamplingRules object at 0x7f78b8be4260>
test_agent = <utils.docker_fixtures._test_agent.TestAgentAPI object at 0x7f78b632e750>
test_library = <utils.docker_fixtures._test_clients._test_client_parametric.ParametricTestClientApi object at 0x7f78844e4620>

    @parametrize("library_env", [{**DEFAULT_ENVVARS}])
...

🧪 3 Tests failed

tests.test_config_consistency.Test_Config_IntegrationEnabled_True.test_integration_enabled_true[apache-mod-7.0] from system_tests_suite (Datadog) (Fix with Cursor)

AssertionError: No PDO span found in trace: [({'service': 'weblog', 'name': 'web.request', 'resource': 'GET /dbm', 'type': 'web', 'trace_id': 461167382037346352, 'span_id': 461167382037346352, 'start': 1770844092934583884, 'duration': 14509832, 'meta': {'http.endpoint': '/dbm', '_dd.appsec.s.req.headers': [{'user-agent': [8], 'accept-encoding': [8], 'host': [8]}], '_dd.appsec.event_rules.version': '1.15.1', '_dd.appsec.s.req.body': [[], {'len': 0}], 'http.request.headers.user-agent': 'system_tests rid/EESRAWHCIWNNSSSBVJCZUENXBTREWALWLFSP', 'http.useragent': 'system_tests rid/EESRAWHCIWNNSSSBVJCZUENXBTREWALWLFSP', '_dd.appsec.s.req.params': [[[8]], {'len': 1}], 'http.status_code': '200', 'http.method': 'GET', 'key2': 'val2', '_dd.appsec.fp.http.network': 'net-0-0000000000', '_dd.appsec.s.req.query': [{'integration': [8]}], '_dd.appsec.fp.http.endpoint': 'http-get-f77b7008-eb92cc52-', '_dd.runtime_family': 'php', '_dd.p.tid': '698cefbc00000000', '_dd.p.dm': '-1', 'key1': 'val1', '_dd.appsec.fp.http.header': 'hdr-0010000000-f5718b11-1-4740ae63', '_dd.appsec.s.req.cookies': [[], {'len': 0}], '_dd.appsec.fp.session': 'ssn----', 'env': 'system-tests', '_dd.appsec.s.res.headers': [{'x-powered-by': [[[8]], {'len': 1}]}], 'version': '1.0.0', 'runtime-id': '04480127-d1a4-4399-9831-a9c7252c07a2', 'http.url': 'http://localhost:7777/dbm?integration=pdo-pgsql'}, 'metrics': {'_dd.appsec.waf.duration': 679.6579999999999, '_dd.appsec.rasp.duration_ext': 137.126, '_sampling_priority_v1': 1.0, 'process_id': 53.0, 'php.memory.peak_usage_bytes': 1181952.0, 'php.memory.peak_real_usage_bytes': 2097152.0, '_dd.agent_psr': 1.0, 'php.compilation.total_time_ms': 7144.178, '_dd.appsec.rasp.duration': 61.585, '_dd.appsec.enabled': 1.0, '_dd.appsec.rasp.rule.eval': 1.0}}, <TraceLibraryPayloadFormat.v04: 'v04'>), ({'service': 'pdo', 'name': 'PDO.query', 'resource': 'SELECT version()', 'type': 'sql', 'trace_id': 461167382037346352, 'span_id': 16346629301001725886, 'parent_id': 461167382037346352, 'start': 1770844092947400274, 'duration': 1245034, 'meta': {'component': 'pdo', 'key2': 'val2', 'db.system': 'postgresql', '_dd.code_origin.frames.1.file': '/var/www/html/dbm.php', 'key1': 'val1', 'db.engine': 'pgsql', 'db.name': 'system_tests_dbname', '_dd.code_origin.frames.1.line': '13', 'db.type': 'postgresql', 'out.host': 'postgres', 'db.user': 'system_tests_user', 'out.port': '5433', 'span.kind': 'client', '_dd.code_origin.type': 'exit', '_dd.base_service': 'weblog', 'env': 'system-tests'}, 'metrics': {'db.row_count': 1.0}}, <TraceLibraryPayloadFormat.v04: 'v04'>), ({'service': 'pdo', 'name': 'PDO.__construct', 'resource': 'PDO.__construct', 'type': 'sql', 'trace_id': 461167382037346352, 'span_id': 7525837442345549248, 'parent_id': 461167382037346352, 'start': 1770844092942308843, 'duration': 4630300, 'meta': {'component': 'pdo', 'out.port': '5433', '_dd.code_origin.frames.1.file': '/var/www/html/dbm.php', 'db.engine': 'pgsql', 'env': 'system-tests', 'key2': 'val2', 'db.type': 'postgresql', '_dd.code_origin.frames.1.line': '12', 'db.user': 'system_tests_user', 'span.kind': 'client', 'db.system': 'postgresql', '_dd.base_service': 'weblog', '_dd.code_origin.type': 'exit', 'key1': 'val1', 'out.host': 'postgres', 'db.name': 'system_tests_dbname'}}, <TraceLibraryPayloadFormat.v04: 'v04'>)]
assert []
 +  where [] = list(<filter object at 0x7f45681ba530>)
 +    where <filter object at 0x7f45681ba530> = filter(<function Test_Config_IntegrationEnabled_True.test_integration_enabled_true.<locals>.<lambda> at 0x7f456888b880>, [({'duration': 14509832, 'meta': {'_dd.appsec.event_rules.version': '1.15.1', '_dd.appsec.fp.http.endpoint': 'http-get...exit', ...}, 'name': 'PDO.__construct', 'parent_id': 461167382037346352, ...}, <TraceLibraryPayloadFormat.v04: 'v04'>)])

self = <tests.test_config_consistency.Test_Config_IntegrationEnabled_True object at 0x7f4584c36630>

    def test_integration_enabled_true(self):
        assert self.r.status_code == 200
        spans_with_format = [
...

tests.test_config_consistency.Test_Config_IntegrationEnabled_True.test_integration_enabled_true[apache-mod-8.2] from system_tests_suite (Datadog) (Fix with Cursor)

AssertionError: No PDO span found in trace: [({'service': 'weblog', 'name': 'web.request', 'resource': 'GET /dbm', 'type': 'web', 'trace_id': 16519401668471584366, 'span_id': 16519401668471584366, 'start': 1770844282106639328, 'duration': 15039753, 'meta': {'_dd.p.tid': '698cf07a00000000', '_dd.appsec.fp.http.network': 'net-0-0000000000', '_dd.appsec.fp.session': 'ssn----', '_dd.runtime_family': 'php', '_dd.appsec.s.req.query': [{'integration': [8]}], 'http.request.headers.user-agent': 'system_tests rid/VKIATJANFBRXTEAJCBSAWVZZRQUOYZAWKPXW', '_dd.appsec.fp.http.header': 'hdr-0010000000-0b493470-1-4740ae63', '_dd.p.dm': '-1', 'http.url': 'http://localhost:7777/dbm?integration=pdo-pgsql', 'key1': 'val1', 'env': 'system-tests', 'version': '1.0.0', '_dd.appsec.fp.http.endpoint': 'http-get-f77b7008-eb92cc52-', 'http.endpoint': '/dbm', 'key2': 'val2', 'http.useragent': 'system_tests rid/VKIATJANFBRXTEAJCBSAWVZZRQUOYZAWKPXW', '_dd.appsec.event_rules.version': '1.15.1', '_dd.appsec.s.req.headers': [{'user-agent': [8], 'accept-encoding': [8], 'host': [8]}], 'runtime-id': 'e0bfc9d7-a57e-4b3f-975d-94fc1e0b21db', '_dd.appsec.s.res.headers': [{'x-powered-by': [[[8]], {'len': 1}]}], '_dd.appsec.s.req.params': [[[8]], {'len': 1}], 'http.method': 'GET', '_dd.appsec.s.req.body': [[], {'len': 0}], 'http.status_code': '200', '_dd.appsec.s.req.cookies': [[], {'len': 0}]}, 'metrics': {'_dd.appsec.waf.duration': 403.67600000000004, 'php.compilation.total_time_ms': 7138.743, 'php.memory.peak_real_usage_bytes': 2097152.0, '_dd.appsec.rasp.rule.eval': 1.0, '_dd.appsec.rasp.duration': 50.394, 'php.memory.peak_usage_bytes': 1441160.0, 'process_id': 53.0, '_dd.appsec.enabled': 1.0, '_sampling_priority_v1': 1.0, '_dd.appsec.rasp.duration_ext': 139.23, '_dd.agent_psr': 1.0}}, <TraceLibraryPayloadFormat.v04: 'v04'>), ({'service': 'pdo', 'name': 'PDO.query', 'resource': 'SELECT version()', 'type': 'sql', 'trace_id': 16519401668471584366, 'span_id': 9353475400330210762, 'parent_id': 16519401668471584366, 'start': 1770844282119933313, 'duration': 1297979, 'meta': {'env': 'system-tests', 'key2': 'val2', 'db.name': 'system_tests_dbname', 'span.kind': 'client', '_dd.code_origin.type': 'exit', 'db.system': 'postgresql', 'db.engine': 'pgsql', 'component': 'pdo', '_dd.base_service': 'weblog', 'key1': 'val1', 'out.port': '5433', 'db.user': 'system_tests_user', '_dd.code_origin.frames.1.file': '/var/www/html/dbm.php', 'db.type': 'postgresql', '_dd.code_origin.frames.1.line': '13', 'out.host': 'postgres'}, 'metrics': {'db.row_count': 1.0}}, <TraceLibraryPayloadFormat.v04: 'v04'>), ({'service': 'pdo', 'name': 'PDO.__construct', 'resource': 'PDO.__construct', 'type': 'sql', 'trace_id': 16519401668471584366, 'span_id': 14807782262501581080, 'parent_id': 16519401668471584366, 'start': 1770844282114313563, 'duration': 5093145, 'meta': {'db.system': 'postgresql', 'key2': 'val2', 'out.port': '5433', 'db.type': 'postgresql', '_dd.code_origin.frames.1.line': '12', '_dd.base_service': 'weblog', 'out.host': 'postgres', 'db.name': 'system_tests_dbname', 'key1': 'val1', '_dd.code_origin.type': 'exit', 'db.user': 'system_tests_user', 'env': 'system-tests', '_dd.code_origin.frames.1.file': '/var/www/html/dbm.php', 'component': 'pdo', 'db.engine': 'pgsql', 'span.kind': 'client'}}, <TraceLibraryPayloadFormat.v04: 'v04'>)]
assert []
 +  where [] = list(<filter object at 0x7f2910186fe0>)
 +    where <filter object at 0x7f2910186fe0> = filter(<function Test_Config_IntegrationEnabled_True.test_integration_enabled_true.<locals>.<lambda> at 0x7f291011b880>, [({'duration': 15039753, 'meta': {'_dd.appsec.event_rules.version': '1.15.1', '_dd.appsec.fp.http.endpoint': 'http-get...it', ...}, 'name': 'PDO.__construct', 'parent_id': 16519401668471584366, ...}, <TraceLibraryPayloadFormat.v04: 'v04'>)])

self = <tests.test_config_consistency.Test_Config_IntegrationEnabled_True object at 0x7f292872ddf0>

    def test_integration_enabled_true(self):
        assert self.r.status_code == 200
        spans_with_format = [
...

tests.test_config_consistency.Test_Config_IntegrationEnabled_True.test_integration_enabled_true[php-fpm-7.4] from system_tests_suite (Datadog) (Fix with Cursor)

AssertionError: No PDO span found in trace: [({'service': 'weblog', 'name': 'web.request', 'resource': 'GET /dbm', 'type': 'web', 'trace_id': 1228759301419472682, 'span_id': 1228759301419472682, 'start': 1770844250081327585, 'duration': 24115619, 'meta': {'http.request.headers.user-agent': 'system_tests rid/IZEQZPOZUSFPDZWZQDOYLEFXOHEJPIINVPBA', 'http.useragent': 'system_tests rid/IZEQZPOZUSFPDZWZQDOYLEFXOHEJPIINVPBA', '_dd.appsec.event_rules.version': '1.15.1', 'http.method': 'GET', '_dd.appsec.fp.http.endpoint': 'http-get-f77b7008-eb92cc52-', 'runtime-id': '38a9ae9d-5736-4d6f-a9c2-9879a55bc66d', '_dd.appsec.s.req.body': [[], {'len': 0}], 'http.url': 'http://localhost:7777/dbm?integration=pdo-pgsql', '_dd.appsec.fp.http.header': 'hdr-0010000000-de32f140-1-4740ae63', '_dd.appsec.s.req.params': [[[8]], {'len': 1}], '_dd.appsec.s.res.headers': [{'x-powered-by': [[[8]], {'len': 1}]}], 'env': 'system-tests', '_dd.p.tid': '698cf05a00000000', '_dd.p.dm': '-1', 'http.endpoint': '/dbm', '_dd.appsec.s.req.query': [{'integration': [8]}], '_dd.appsec.s.req.cookies': [[], {'len': 0}], '_dd.appsec.s.req.headers': [{'host': [8], 'accept-encoding': [8], 'user-agent': [8]}], 'version': '1.0.0', 'key2': 'val2', '_dd.appsec.fp.http.network': 'net-0-0000000000', 'http.status_code': '200', '_dd.runtime_family': 'php', '_dd.appsec.fp.session': 'ssn----', 'key1': 'val1'}, 'metrics': {'process_id': 129.0, '_dd.appsec.waf.duration': 522.611, '_sampling_priority_v1': 1.0, '_dd.agent_psr': 1.0, '_dd.appsec.rasp.duration_ext': 200.172, 'php.compilation.total_time_ms': 989.943, '_dd.appsec.rasp.duration': 97.09, 'php.memory.peak_usage_bytes': 807264.0, '_dd.appsec.rasp.rule.eval': 1.0, 'php.memory.peak_real_usage_bytes': 2097152.0, '_dd.appsec.enabled': 1.0}}, <TraceLibraryPayloadFormat.v04: 'v04'>), ({'service': 'pdo', 'name': 'PDO.query', 'resource': 'SELECT version()', 'type': 'sql', 'trace_id': 1228759301419472682, 'span_id': 6769502306372988376, 'parent_id': 1228759301419472682, 'start': 1770844250103452720, 'duration': 1487308, 'meta': {'db.name': 'system_tests_dbname', '_dd.code_origin.frames.1.file': '/var/www/html/dbm.php', '_dd.base_service': 'weblog', 'db.type': 'postgresql', 'key2': 'val2', '_dd.code_origin.type': 'exit', 'env': 'system-tests', '_dd.code_origin.frames.1.line': '13', 'out.host': 'postgres', 'span.kind': 'client', 'db.user': 'system_tests_user', 'key1': 'val1', 'out.port': '5433', 'component': 'pdo', 'db.engine': 'pgsql', 'db.system': 'postgresql'}, 'metrics': {'db.row_count': 1.0}}, <TraceLibraryPayloadFormat.v04: 'v04'>), ({'service': 'pdo', 'name': 'PDO.__construct', 'resource': 'PDO.__construct', 'type': 'sql', 'trace_id': 1228759301419472682, 'span_id': 1896113480745316840, 'parent_id': 1228759301419472682, 'start': 1770844250083827100, 'duration': 18862230, 'meta': {'_dd.base_service': 'weblog', 'out.port': '5433', 'out.host': 'postgres', 'db.engine': 'pgsql', 'db.user': 'system_tests_user', 'env': 'system-tests', '_dd.code_origin.frames.1.line': '12', 'key1': 'val1', 'db.system': 'postgresql', 'db.type': 'postgresql', '_dd.code_origin.type': 'exit', 'db.name': 'system_tests_dbname', '_dd.code_origin.frames.1.file': '/var/www/html/dbm.php', 'key2': 'val2', 'component': 'pdo', 'span.kind': 'client'}}, <TraceLibraryPayloadFormat.v04: 'v04'>)]
assert []
 +  where [] = list(<filter object at 0x7f3bb63aad40>)
 +    where <filter object at 0x7f3bb63aad40> = filter(<function Test_Config_IntegrationEnabled_True.test_integration_enabled_true.<locals>.<lambda> at 0x7f3bb653b880>, [({'duration': 24115619, 'meta': {'_dd.appsec.event_rules.version': '1.15.1', '_dd.appsec.fp.http.endpoint': 'http-get...xit', ...}, 'name': 'PDO.__construct', 'parent_id': 1228759301419472682, ...}, <TraceLibraryPayloadFormat.v04: 'v04'>)])

self = <tests.test_config_consistency.Test_Config_IntegrationEnabled_True object at 0x7f3bca1376b0>

    def test_integration_enabled_true(self):
        assert self.r.status_code == 200
        spans_with_format = [
...

_{This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 18cc9da | Docs | Datadog PR Page | Was this helpful? Give us feedback!}