Merge pull request #3415 from DataDog/glopes/http-endpoint

impl rfc "APM endpoint resource renaming in the tracers"

Author: cataphract

Cargo.lock

@@ -24,3 +24,18 @@ lto = true
 codegen-units = 1
 panic = "abort"
 inherits = "release"
+
+# These are to satistfy the build with libdatadog as a path dependency inside
+# components-rs. There may be a better way to fix this, but I'm alreday two
+# tasks removed from what I'm trying to do, so pushing forward.
+[workspace.dependencies]
+hyper = { version = "1.6", features = [
+  "http1",
+  "client",
+], default-features = false }
+hyper-util = { version = "0.1.10", features = [
+  "http1",
+  "client",
+  "client-legacy",
+] }
+

Cargo.toml

@@ -1511,8 +1511,28 @@ typedef enum ddog_LibraryConfigSource {
   DDOG_LIBRARY_CONFIG_SOURCE_FLEET_STABLE_CONFIG = 1,
 } ddog_LibraryConfigSource;
 
+/**
+ * Represents the types of metadata that can be set on a `TracerMetadata` object.
+ */
+typedef enum ddog_MetadataKind {
+  DDOG_METADATA_KIND_RUNTIME_ID = 0,
+  DDOG_METADATA_KIND_TRACER_LANGUAGE = 1,
+  DDOG_METADATA_KIND_TRACER_VERSION = 2,
+  DDOG_METADATA_KIND_HOSTNAME = 3,
+  DDOG_METADATA_KIND_SERVICE_NAME = 4,
+  DDOG_METADATA_KIND_SERVICE_ENV = 5,
+  DDOG_METADATA_KIND_SERVICE_VERSION = 6,
+  DDOG_METADATA_KIND_PROCESS_TAGS = 7,
+  DDOG_METADATA_KIND_CONTAINER_ID = 8,
+} ddog_MetadataKind;
+
 typedef struct ddog_Configurator ddog_Configurator;
 
+/**
+ * This struct MUST be backward compatible.
+ */
+typedef struct ddog_TracerMetadata ddog_TracerMetadata;
+
 /**
  * Ffi safe type representing a borrowed null-terminated C array
  * Equivalent to a std::ffi::CStr
@@ -1581,25 +1601,29 @@ typedef struct ddog_Vec_LibraryConfig {
 } ddog_Vec_LibraryConfig;
 
 /**
- * A generic result type for when an operation may fail,
- * or may return <T> in case of success.
+ * A result type that includes debug/log messages along with the data
  */
-typedef enum ddog_Result_VecLibraryConfig_Tag {
-  DDOG_RESULT_VEC_LIBRARY_CONFIG_OK_VEC_LIBRARY_CONFIG,
-  DDOG_RESULT_VEC_LIBRARY_CONFIG_ERR_VEC_LIBRARY_CONFIG,
-} ddog_Result_VecLibraryConfig_Tag;
-
-typedef struct ddog_Result_VecLibraryConfig {
-  ddog_Result_VecLibraryConfig_Tag tag;
+typedef struct ddog_OkResult {
+  struct ddog_Vec_LibraryConfig value;
+  struct ddog_CString logs;
+} ddog_OkResult;
+
+typedef enum ddog_LibraryConfigLoggedResult_Tag {
+  DDOG_LIBRARY_CONFIG_LOGGED_RESULT_OK,
+  DDOG_LIBRARY_CONFIG_LOGGED_RESULT_ERR,
+} ddog_LibraryConfigLoggedResult_Tag;
+
+typedef struct ddog_LibraryConfigLoggedResult {
+  ddog_LibraryConfigLoggedResult_Tag tag;
   union {
     struct {
-      struct ddog_Vec_LibraryConfig ok;
+      struct ddog_OkResult ok;
     };
     struct {
       struct ddog_Error err;
     };
   };
-} ddog_Result_VecLibraryConfig;
+} ddog_LibraryConfigLoggedResult;
 
 /**
  * C-compatible representation of an anonymous file handle

components-rs/common.h

@@ -28,7 +28,7 @@ void ddog_library_configurator_with_detect_process_info(struct ddog_Configurator
 
 void ddog_library_configurator_drop(struct ddog_Configurator*);
 
-struct ddog_Result_VecLibraryConfig ddog_library_configurator_get(const struct ddog_Configurator *configurator);
+struct ddog_LibraryConfigLoggedResult ddog_library_configurator_get(const struct ddog_Configurator *configurator);
 
 /**
  * Returns a static null-terminated string, containing the name of the environment variable
@@ -48,23 +48,63 @@ struct ddog_CStr ddog_library_config_fleet_stable_config_path(void);
  */
 struct ddog_CStr ddog_library_config_local_stable_config_path(void);
 
-void ddog_library_config_drop(struct ddog_Vec_LibraryConfig);
+void ddog_library_config_drop(struct ddog_LibraryConfigLoggedResult config_result);
 
 /**
- * Store tracer metadata to a file handle
+ * Allocates and returns a pointer to a new `TracerMetadata` object on the heap.
  *
  * # Safety
+ * This function returns a raw pointer. The caller is responsible for calling
+ * `ddog_tracer_metadata_free` to deallocate the memory.
  *
- * Accepts raw C-compatible strings
+ * # Returns
+ * A non-null pointer to a newly allocated `TracerMetadata` instance.
  */
-struct ddog_Result_TracerMemfdHandle ddog_store_tracer_metadata(uint8_t schema_version,
-                                                                ddog_CharSlice runtime_id,
-                                                                ddog_CharSlice tracer_language,
-                                                                ddog_CharSlice tracer_version,
-                                                                ddog_CharSlice hostname,
-                                                                ddog_CharSlice service_name,
-                                                                ddog_CharSlice service_env,
-                                                                ddog_CharSlice service_version);
+struct ddog_TracerMetadata *ddog_tracer_metadata_new(void);
+
+/**
+ * Frees a `TracerMetadata` instance previously allocated with `ddog_tracer_metadata_new`.
+ *
+ * # Safety
+ * - `ptr` must be a pointer previously returned by `ddog_tracer_metadata_new`.
+ * - Double-freeing or passing an invalid pointer results in undefined behavior.
+ * - Passing a null pointer is safe and does nothing.
+ */
+void ddog_tracer_metadata_free(struct ddog_TracerMetadata *ptr);
+
+/**
+ * Sets a field of the `TracerMetadata` object pointed to by `ptr`.
+ *
+ * # Arguments
+ * - `ptr`: Pointer to a `TracerMetadata` instance.
+ * - `kind`: The metadata field to set (as defined in `MetadataKind`).
+ * - `value`: A null-terminated C string representing the value to set.
+ *
+ * # Safety
+ * - Both `ptr` and `value` must be non-null.
+ * - `value` must point to a valid UTF-8 null-terminated string.
+ * - If the string is not valid UTF-8, the function does nothing.
+ */
+void ddog_tracer_metadata_set(struct ddog_TracerMetadata *ptr,
+                              enum ddog_MetadataKind kind,
+                              const char *value);
+
+/**
+ * Serializes the `TracerMetadata` into a platform-specific memory handle (e.g., memfd on Linux).
+ *
+ * # Safety
+ * - `ptr` must be a valid, non-null pointer to a `TracerMetadata`.
+ *
+ * # Returns
+ * - On Linux: a `TracerMemfdHandle` containing a raw file descriptor to a memory file.
+ * - On unsupported platforms: an error.
+ * - On failure: propagates any internal errors from the metadata storage process.
+ *
+ * # Platform Support
+ * This function currently only supports Linux via `memfd`. On other platforms,
+ * it will return an error.
+ */
+struct ddog_Result_TracerMemfdHandle ddog_tracer_metadata_store(struct ddog_TracerMetadata *ptr);
 
 #ifdef __cplusplus
 }  // extern "C"

components-rs/library-config.h

@@ -178,6 +178,7 @@ if test "$PHP_DDTRACE" != "no"; then
     ext/distributed_tracing_headers.c \
     ext/dogstatsd.c \
     ext/dogstatsd_client.c \
+	ext/endpoint_guessing.c \
     ext/engine_api.c \
     ext/engine_hooks.c \
     ext/exception_serialize.c \

config.m4

@@ -29,6 +29,7 @@ if (PHP_DDTRACE != 'no') {
 	DDTRACE_EXT_SOURCES += " distributed_tracing_headers.c";
 	DDTRACE_EXT_SOURCES += " ddshared.c";
 	DDTRACE_EXT_SOURCES += " dogstatsd.c";
+	DDTRACE_EXT_SOURCES += " endpoint_guessing.c";
 	DDTRACE_EXT_SOURCES += " engine_api.c";
 	DDTRACE_EXT_SOURCES += " engine_hooks.c";
 	DDTRACE_EXT_SOURCES += " exception_serialize.c";

config.w32

@@ -202,6 +202,20 @@ static inline void smart_str_append_printf(smart_str *dest, const char *format,
     zend_string_release(str);
 }
 
+static inline size_t smart_str_get_len(smart_str *str) { return str->s ? ZSTR_LEN(str->s) : 0; }
+
+static inline zend_string *smart_str_extract(smart_str *str) {
+    if (str->s) {
+        zend_string *res;
+        smart_str_0(str);
+        res = str->s;
+        str->s = NULL;
+        return res;
+    } else {
+        return ZSTR_EMPTY_ALLOC();
+    }
+}
+
 static inline zend_string *php_base64_encode_str(const zend_string *str) {
     return php_base64_encode((const unsigned char*)(ZSTR_VAL(str)), ZSTR_LEN(str));
 }

ext/compatibility.h

@@ -258,6 +258,8 @@ enum ddtrace_sampling_rules_format {
     CONFIG(SET, DD_TRACE_HTTP_SERVER_ERROR_STATUSES, "500-599", .ini_change = zai_config_system_ini_change)    \
     CONFIG(BOOL, DD_CODE_ORIGIN_FOR_SPANS_ENABLED, "true")                                                     \
     CONFIG(INT, DD_CODE_ORIGIN_MAX_USER_FRAMES, "8")                                                           \
+    CONFIG(BOOL, DD_TRACE_RESOURCE_RENAMING_ENABLED, "false")                                                  \
+    CONFIG(BOOL, DD_TRACE_RESOURCE_RENAMING_ALWAYS_SIMPLIFIED_ENDPOINT, "false")                               \
     DD_INTEGRATIONS
 
 #ifndef _WIN32