Merge branch 'master' of github.com:DataDog/dd-trace-php into glopes/http-endpoint

Author: bwoebi

CHANGELOG.md

@@ -1,40 +1,25 @@
 Changelog for older versions can be found in our [release page](https://github.com/DataDog/dd-trace-php/releases).
 
-## All products
-### Internal
-- Add injection metadata fields to telemetry forwarder #3359
-
 ## Tracer
-### Added
-- Add http.route tag to SymfonyIntegration.php #2992
-- Add setting to avoid obfuscating mongodb queries #3390
-- Handle native HTTP requests #3366
-
 ### Changed
-- Expose curl_multi_exec_get_request_spans() as non-internal #3389
-- Use resources_weak_* API for Curl as well #3386
-- Gracefully handle sidecar broken pipes #3370
-- Enable log injection by default #3355
+- Reduce integrations overhead #3380
+- Avoid unnecessary gc_collect_cycles if there's no open span #3428
+- Make use of fast_shutdown to avoid freeing overhead #3429
+- Optimize PDOIntegration::parseDsn() #3430
 
 ### Fixed
-- Capture the stack for log probes #3367 
-- Properly cache the telemetry cache #3387
-- Fix names of global git tags for debugger #3377
-- Fix SQLSRVIntegration resource handling #3379
-- Set DD_APPSEC_RASP_ENABLED default to true as on the tracer #3374
-- Fix top Code Origin frame for ExecIntegration and KafkaIntegration #3392
-
-### Internal
-- Update baggage telemetry typo #3382
-- Switch to bookworm containers #3375
+- Fix #3135: Force flushing on shutdown of entry point processes #3398
+- Support curl_multi_exec root spans #3419
+- Fix a couple memory leaks #3420
 
-## Application Security Management
+## Profiling
 ### Added
-- Add fingerprint capabilities #3371
-- Implement jwt #3352
+- Add source code integration #3418
 
 ### Fixed
-- Fix musl appsec helper shutdown crash #3378
+- Fix missing line numbers #3417
+- Early init default connector to fix env var race #3432
 
 ### Internal
-- Fix submission of telemetry logs from appsec #3373
+- Refactor tag handling #3423
+- Permanently enable compilation of allocation, exception, and timeline features #3431

VERSION

@@ -1 +1 @@
-1.12.0
+1.13.0

ext/auto_flush.c

@@ -19,14 +19,14 @@
 
 ZEND_EXTERN_MODULE_GLOBALS(ddtrace);
 
-ZEND_RESULT_CODE ddtrace_flush_tracer(bool force_on_startup, bool collect_cycles) {
+ZEND_RESULT_CODE ddtrace_flush_tracer(bool force_on_startup, bool collect_cycles, bool fast_shutdown) {
     bool success = true;
 
     ddog_TracesBytes *traces = ddog_get_traces();
     if (collect_cycles) {
-        ddtrace_serialize_closed_spans_with_cycle(traces);
+        ddtrace_serialize_closed_spans_with_cycle(traces, fast_shutdown);
     } else {
-        ddtrace_serialize_closed_spans(traces);
+        ddtrace_serialize_closed_spans(traces, fast_shutdown);
     }
 
     // Prevent traces from requests not executing any PHP code:
@@ -113,7 +113,7 @@ ZEND_RESULT_CODE ddtrace_flush_tracer(bool force_on_startup, bool collect_cycles
 DDTRACE_PUBLIC void ddtrace_close_all_spans_and_flush()
 {
     ddtrace_close_all_open_spans(true);
-    ddtrace_flush_tracer(true, true);
+    ddtrace_flush_tracer(true, true, false);
 }
 
 #define DEFAULT_UDS_PATH "/var/run/datadog/apm.socket"

ext/auto_flush.h

@@ -5,7 +5,7 @@
 #include <php.h>
 #include <stdbool.h>
 
-ZEND_RESULT_CODE ddtrace_flush_tracer(bool force_on_startup, bool collect_cycles);
+ZEND_RESULT_CODE ddtrace_flush_tracer(bool force_on_startup, bool collect_cycles, bool fast_shutdown);
 
 // This function is exported and used by appsec
 DDTRACE_PUBLIC void ddtrace_close_all_spans_and_flush(void);

ext/configuration.c

@@ -243,6 +243,18 @@ bool ddtrace_config_minit(int module_number) {
     }
 
 #ifndef _WIN32
+    // PID 1 *obviously* needs to ensure the sidecar gets flushed. (As PID 1 terminating will just SIGKILL it.)
+    // As to PPID 1, common scenarios where PHP is a direct child of PID 1:
+    // - apache / fpm running in a container as PID 1 each
+    // - PHP CLI processes running in a container as part of a bash script
+    // - root processes of supervisord/systemd services - if these terminate, it's likely because the service or container shuts down.
+    //   -> If the sidecar is part of a cgroup, it will terminate the sidecar as well.
+    if (getpid() == 1 || getppid() == 1) {
+        config_entries[DDTRACE_CONFIG_DD_TRACE_FORCE_FLUSH_ON_SHUTDOWN].default_encoded_value = (zai_str) ZAI_STR_FROM_CSTR("true");
+        config_entries[DDTRACE_CONFIG_DD_TRACE_FORCE_FLUSH_ON_SIGTERM].default_encoded_value = (zai_str) ZAI_STR_FROM_CSTR("true");
+        config_entries[DDTRACE_CONFIG_DD_TRACE_FORCE_FLUSH_ON_SIGINT].default_encoded_value = (zai_str) ZAI_STR_FROM_CSTR("true");
+    }
+
     // Background sender does not send a Content-Length header, but sidecar does. Force-enable it thus, as the background sender does not work at all.
     if (getenv("AWS_LAMBDA_FUNCTION_NAME")) {
         config_entries[DDTRACE_CONFIG_DD_TRACE_SIDECAR_TRACE_SENDER].default_encoded_value = (zai_str) ZAI_STR_FROM_CSTR("true");

ext/configuration.h

@@ -140,6 +140,9 @@ enum ddtrace_sampling_rules_format {
     CONFIG(STRING, DD_TRACE_MEMORY_LIMIT, "")                                                                  \
     CONFIG(BOOL, DD_TRACE_REPORT_HOSTNAME, "false")                                                            \
     CONFIG(BOOL, DD_TRACE_FLUSH_COLLECT_CYCLES, "false")                                                       \
+    CONFIG(BOOL, DD_TRACE_FORCE_FLUSH_ON_SHUTDOWN, "false") /* true if pid == 1 || ppid == 1 */                \
+    CONFIG(BOOL, DD_TRACE_FORCE_FLUSH_ON_SIGTERM, "false") /* true if pid == 1 || ppid == 1 */                 \
+    CONFIG(BOOL, DD_TRACE_FORCE_FLUSH_ON_SIGINT, "false") /* true if pid == 1 || ppid == 1 */                  \
     CONFIG(BOOL, DD_TRACE_KAFKA_DISTRIBUTED_TRACING, "true")                                                   \
     CONFIG(BOOL, DD_TRACE_LARAVEL_QUEUE_DISTRIBUTED_TRACING, "true")                                           \
     CONFIG(BOOL, DD_TRACE_SYMFONY_MESSENGER_DISTRIBUTED_TRACING, "true")                                       \

ext/ddtrace.c

@@ -1546,6 +1546,10 @@ static PHP_MINIT_FUNCTION(ddtrace) {
     ddtrace_minit_remote_config();
     ddtrace_trace_source_minit();
 
+#ifndef _WIN32
+    ddtrace_signals_minit();
+#endif
+
     return SUCCESS;
 }
 
@@ -1580,8 +1584,11 @@ static PHP_MSHUTDOWN_FUNCTION(ddtrace) {
         if (ddtrace_coms_flush_shutdown_writer_synchronous()) {
             ddtrace_coms_curl_shutdown();
         }
-    }
+    } else /* ! part of the if outside the ifdef */
 #endif
+    if (get_global_DD_TRACE_FORCE_FLUSH_ON_SHUTDOWN() && ddtrace_sidecar) {
+        ddog_sidecar_flush_traces(&ddtrace_sidecar);
+    }
 
     ddtrace_log_mshutdown();
 
@@ -1775,8 +1782,8 @@ static void dd_clean_globals(void) {
 #endif
 }
 
-static void dd_shutdown_hooks_and_observer(void) {
-    zai_hook_clean();
+static void dd_shutdown_hooks_and_observer(bool fast_shutdown) {
+    zai_hook_clean(fast_shutdown);
 
 #if PHP_VERSION_ID >= 80000 && PHP_VERSION_ID < 80200
 #if PHP_VERSION_ID < 80100
@@ -1797,7 +1804,7 @@ static void dd_shutdown_hooks_and_observer(void) {
 #endif
 }
 
-void dd_force_shutdown_tracing(void) {
+void dd_force_shutdown_tracing(bool fast_shutdown) {
     DDTRACE_G(in_shutdown) = true;
 
     zend_try {
@@ -1807,7 +1814,7 @@ void dd_force_shutdown_tracing(void) {
     } zend_end_try();
 
     zend_try {
-        if (ddtrace_flush_tracer(false, true) == FAILURE) {
+        if (ddtrace_flush_tracer(false, true, fast_shutdown) == FAILURE) {
             LOG(WARN, "Unable to flush the tracer");
         }
     } zend_catch {
@@ -1818,7 +1825,7 @@ void dd_force_shutdown_tracing(void) {
     ddtrace_disable_tracing_in_current_request();  // implicitly calling dd_clean_globals
 
     // The hooks shall not be reset, just disabled at runtime.
-    dd_shutdown_hooks_and_observer();
+    dd_shutdown_hooks_and_observer(fast_shutdown);
 
     DDTRACE_G(in_shutdown) = false;
 }
@@ -1832,16 +1839,31 @@ static void dd_finalize_sidecar_lifecycle(bool clear_id) {
 static PHP_RSHUTDOWN_FUNCTION(ddtrace) {
     UNUSED(module_number, type);
 
+    // We deliberately select to not free some data structures, as to avoid the overhead of freeing them.
+    // Just proper destruction can have significant and easily measurable overhead on applications.
+    // Prior to PHP 7.2 fast shutdown was an opcache only feature
+#if ZEND_DEBUG || PHP_VERSION_ID < 70200
+    bool fast_shutdown = 0;
+#elif defined(__SANITIZE_ADDRESS__)
+    char *force_fast_shutdown = getenv("ZEND_ASAN_FORCE_FAST_SHUTDOWN");
+    bool fast_shutdown = (
+        is_zend_mm()
+        || (force_fast_shutdown && ZEND_ATOL(force_fast_shutdown))
+    ) && !EG(full_tables_cleanup);
+#else
+    bool fast_shutdown = is_zend_mm() && !EG(full_tables_cleanup);
+#endif
+
     zend_hash_destroy(&DDTRACE_G(traced_spans));
 
     // this needs to be done before dropping the spans
     // run unconditionally because ddtrace may've been disabled mid-request
     ddtrace_exec_handlers_rshutdown();
 
     if (get_DD_TRACE_ENABLED()) {
-        dd_force_shutdown_tracing();
+        dd_force_shutdown_tracing(fast_shutdown);
     } else if (!ddtrace_disable) {
-        dd_shutdown_hooks_and_observer();
+        dd_shutdown_hooks_and_observer(fast_shutdown);
     }
 
     if (DDTRACE_G(remote_config_state)) {
@@ -1851,7 +1873,9 @@ static PHP_RSHUTDOWN_FUNCTION(ddtrace) {
     if (!ddtrace_disable) {
         ddtrace_autoload_rshutdown();
 
-        OBJ_RELEASE(&DDTRACE_G(active_stack)->std);
+        if (!fast_shutdown) {
+            OBJ_RELEASE(&DDTRACE_G(active_stack)->std);
+        }
         DDTRACE_G(active_stack) = NULL;
     }
 
@@ -2344,7 +2368,7 @@ PHP_FUNCTION(dd_trace_serialize_closed_spans) {
     ddtrace_mark_all_span_stacks_flushable();
 
     ddog_TracesBytes *traces = ddog_get_traces();
-    ddtrace_serialize_closed_spans_with_cycle(traces);
+    ddtrace_serialize_closed_spans_with_cycle(traces, false);
 
     zval traces_zv = dd_serialize_rust_traces_to_zval(traces);
 
@@ -3221,7 +3245,7 @@ PHP_FUNCTION(DDTrace_flush) {
     if (get_DD_AUTOFINISH_SPANS()) {
         ddtrace_close_userland_spans_until(NULL);
     }
-    if (ddtrace_flush_tracer(false, get_DD_TRACE_FLUSH_COLLECT_CYCLES()) == FAILURE) {
+    if (ddtrace_flush_tracer(false, get_DD_TRACE_FLUSH_COLLECT_CYCLES(), false) == FAILURE) {
         LOG_LINE(WARN, "Unable to flush the tracer");
     }
     RETURN_NULL();

ext/ddtrace.h

@@ -71,7 +71,7 @@ bool ddtrace_alter_default_propagation_style(zval *old_value, zval *new_value, z
 bool ddtrace_alter_dd_service(zval *old_value, zval *new_value, zend_string *new_str);
 bool ddtrace_alter_dd_env(zval *old_value, zval *new_value, zend_string *new_str);
 bool ddtrace_alter_dd_version(zval *old_value, zval *new_value, zend_string *new_str);
-void dd_force_shutdown_tracing(void);
+void dd_force_shutdown_tracing(bool fast_shutdown);
 void dd_internal_handle_fork(void);
 #ifdef CXA_THREAD_ATEXIT_WRAPPER
 void dd_run_rust_thread_destructors(void *unused);

ext/handlers_exception.c

@@ -380,7 +380,7 @@ void dd_exception_handler_freed(zend_object *object) {
         // Here we are at the very last chance before objects are unconditionally freed.
         // Let's force-disable the tracing in case it wasn't yet
         // Typically RSHUTDOWN would handle that, but since 8.1.0 opcache will free our objects before module_shutdown during preloading
-        dd_force_shutdown_tracing();
+        dd_force_shutdown_tracing(false);
     }
 }
 #endif