Vendor customization interface (#19)

* Vendor customizations interface
* Change ARM64 runner

Author: intuibase

.github/workflows/build-native.yml

@@ -32,7 +32,7 @@ jobs:
 
   build-native:
     name: build-agent-library
-    runs-on: ${{ matrix.goarch == 'arm64' && 'oracle-4cpu-16gb-arm64' || 'ubuntu-latest' }}
+    runs-on: ${{ matrix.goarch == 'arm64' && 'ubuntu-24.04-arm' || 'ubuntu-latest' }}
     needs: setup-build-matrix
     timeout-minutes: 300
     strategy:

.github/workflows/native-dev-tools-build.yml

@@ -32,7 +32,7 @@ jobs:
       build_arch: ${{ inputs.build_arch }}
 
   build-compiler-image:
-    runs-on: ${{ matrix.goarch == 'arm64' && 'oracle-4cpu-16gb-arm64' || 'ubuntu-latest' }}
+    runs-on: ${{ matrix.goarch == 'arm64' && 'ubuntu-24.04-arm' || 'ubuntu-latest' }}
     needs: setup-build-matrix
     env:
       DOCKER_BUILDKIT: 1

prod/native/CMakeLists.txt

@@ -39,6 +39,8 @@ project("opentelemetry-php-distro"
     LANGUAGES C CXX
 )
 
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
 set(RELEASE_BUILD false)
 set(DEBUG_BUILD false)
 if(CMAKE_BUILD_TYPE STREQUAL "Release")

prod/native/extension/code/ModuleEntry.cpp

@@ -12,6 +12,8 @@
 
 #include "AutoZval.h"
 #include "os/OsUtils.h"
+#include "config/OptionValueProvider.h"
+
 #include "CallOnScopeExit.h"
 #include "ConfigurationManager.h"
 #include "InferredSpans.h"
@@ -29,20 +31,6 @@
 
 ZEND_DECLARE_MODULE_GLOBALS( opentelemetry_distro )
 
-namespace opentelemetry::php {
-opentelemetry::php::ConfigurationManager configManager([](std::string_view iniName) -> std::optional<std::string> {
-    auto val = cfg_get_entry(iniName.data(), iniName.length());
-
-    opentelemetry::php::AutoZval autoZval(val);
-    auto optStringView = autoZval.getOptStringView();
-    if (!optStringView.has_value()) {
-        return std::nullopt;
-    }
-
-    return std::string(*optStringView);
-});
-}
-
 #ifndef ZEND_PARSE_PARAMETERS_NONE
 #   define ZEND_PARSE_PARAMETERS_NONE() \
         ZEND_PARSE_PARAMETERS_START(0, 0) \
@@ -65,7 +53,7 @@ ZEND_RESULT_CODE  opentelemetry_distro_request_postdeactivate(void) {
 }
 
 PHP_MINFO_FUNCTION(opentelemetry_distro) {
-    printPhpInfo(zend_module);
+    opentelemetry::php::printPhpInfo(zend_module);
 }
 
 
@@ -79,8 +67,6 @@ static PHP_GINIT_FUNCTION(opentelemetry_distro) {
 
     auto logger = std::make_shared<opentelemetry::php::Logger>(std::vector<std::shared_ptr<opentelemetry::php::LoggerSinkInterface>>{logSinkStdErr, logSinkSysLog, logSinkFile});
 
-    opentelemetry::php::configManager.attachLogger(logger);
-
     ELOGF_DEBUG(logger, MODULE, "%s: GINIT called; parent PID: %d", __FUNCTION__, static_cast<int>(opentelemetry::osutils::getParentProcessId()));
     opentelemetry_distro_globals->globals = nullptr;
 
@@ -99,7 +85,19 @@ static PHP_GINIT_FUNCTION(opentelemetry_distro) {
     });
 
     try {
-        opentelemetry_distro_globals->globals = new opentelemetry::php::AgentGlobals(logger, std::move(logSinkStdErr), std::move(logSinkSysLog), std::move(logSinkFile), std::move(phpBridge), std::move(hooksStorage), std::move(inferredSpans), [](opentelemetry::php::ConfigurationSnapshot &cfg) { return opentelemetry::php::configManager.updateIfChanged(cfg); });
+        auto optionValueProvider = std::make_shared<opentelemetry::php::config::OptionValueProvider>([](std::string_view iniName) -> std::optional<std::string> {
+            auto val = cfg_get_entry(iniName.data(), iniName.length());
+
+            opentelemetry::php::AutoZval autoZval(val);
+            auto optStringView = autoZval.getOptStringView();
+            if (!optStringView.has_value()) {
+                return std::nullopt;
+            }
+
+            return std::string(*optStringView);
+        });
+
+        opentelemetry_distro_globals->globals = new opentelemetry::php::AgentGlobals(logger, std::move(logSinkStdErr), std::move(logSinkSysLog), std::move(logSinkFile), std::move(phpBridge), std::move(hooksStorage), std::move(inferredSpans), std::move(optionValueProvider));
     } catch (std::exception const &e) {
         ELOGF_CRITICAL(logger, MODULE, "Unable to allocate AgentGlobals. '%s'", e.what());
     }

prod/native/extension/code/ModuleFunctions.cpp

@@ -1,15 +1,12 @@
 
 #include "ModuleFunctions.h"
-#include "ConfigurationStorage.h"
 #include "LoggerInterface.h"
 #include "LogFeature.h"
-#include "RequestScope.h"
 #include "ModuleGlobals.h"
 #include "ModuleFunctionsImpl.h"
 #include "InternalFunctionInstrumentation.h"
 #undef snprintf
 #include "coordinator/CoordinatorProcess.h"
-#include "transport/OpAmp.h"
 #include "PhpBridge.h"
 #include "OtlpExporter/LogsConverter.h"
 #include "OtlpExporter/MetricConverter.h"
@@ -226,7 +223,7 @@ PHP_FUNCTION(initialize) {
     OTEL_GL(coordinatorProcess_)->getCoordinatorSender().initializeConnection(std::string(ZSTR_VAL(endpoint), ZSTR_LEN(endpoint)), ZSTR_HASH(endpoint), std::string(ZSTR_VAL(contentType), ZSTR_LEN(contentType)), endpointHeaders, std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::duration<double>(timeout)), static_cast<std::size_t>(maxRetries), std::chrono::milliseconds(retryDelay), sslOptions);
 }
 
-ZEND_BEGIN_ARG_INFO_EX(ArgInfoSend, 0, 0, 2)
+ZEND_BEGIN_ARG_INFO_EX(enqueue_arginfo, 0, 0, 2)
 ZEND_ARG_TYPE_INFO(0, endpoint, IS_STRING, 1)
 ZEND_ARG_TYPE_INFO(0, payload, IS_STRING, 1)
 ZEND_END_ARG_INFO()
@@ -376,7 +373,7 @@ const zend_function_entry opentelemetry_distro_functions[] = {
     ZEND_NS_FE( "OpenTelemetry\\Distro", hook, hook_arginfo)
 
     ZEND_NS_FE( "OpenTelemetry\\Distro\\HttpTransport", initialize, ArgInfoInitialize)
-    ZEND_NS_FE( "OpenTelemetry\\Distro\\HttpTransport", enqueue, no_params_arginfo)
+    ZEND_NS_FE( "OpenTelemetry\\Distro\\HttpTransport", enqueue, enqueue_arginfo)
     ZEND_NS_FE( "OpenTelemetry\\Distro\\InferredSpans", force_set_object_property_value, set_object_property_value_arginfo)
 
     ZEND_NS_FE( "OpenTelemetry\\Distro\\OtlpExporters", convert_spans, arginfo_convert_spans)

prod/native/extension/code/ModuleFunctionsImpl.cpp

@@ -6,10 +6,9 @@
 #include "ModuleGlobals.h"
 
 namespace opentelemetry::php {
-extern opentelemetry::php::ConfigurationManager configManager;
 
 void getConfigOptionbyName(std::string_view optionName, zval *return_value) {
-    auto value = opentelemetry::php::configManager.getOptionValue(optionName, OTEL_GL(config_)->get());
+    auto value = OTEL_GL(configManager_)->getOptionValue(optionName, OTEL_GL(config_)->get());
 
     std::visit([return_value](auto &&arg) {
         using T = std::decay_t<decltype(arg)>;
@@ -38,4 +37,4 @@ void getConfigOptionbyName(std::string_view optionName, zval *return_value) {
     }, value);
 }
 
-}
+} // namespace opentelemetry::php

prod/native/extension/code/ModuleInfo.cpp

@@ -2,28 +2,33 @@
 #include "ConfigurationManager.h"
 #include "ConfigurationStorage.h"
 #include "ModuleGlobals.h"
+#include "VendorCustomizationsInterface.h"
 
 #include <php.h>
 #include <ext/standard/info.h>
 
 #include "otel_distro_version.h"
 
 namespace opentelemetry::php {
-extern opentelemetry::php::ConfigurationManager configManager;
-}
 
 void printPhpInfo(zend_module_entry *zend_module) {
 
-
     php_info_print_table_start();
-    php_info_print_table_header( 1, OTEL_DISTRO_PRODUCT_NAME);
-    php_info_print_table_end();
+    if (OTEL_G(globals)->vendorCustomizations_) {
+        php_info_print_table_header(1, OTEL_G(globals)->vendorCustomizations_->getDistributionName().c_str());
+        php_info_print_table_row(2, "Version", OTEL_G(globals)->vendorCustomizations_->getDistributionVersion().c_str());
+        php_info_print_table_row(2, "OpenTelemetry distro base version", OTEL_DISTRO_VERSION);
+
+    } else {
+        php_info_print_table_header(1, OTEL_DISTRO_PRODUCT_NAME);
+        php_info_print_table_row(2, "Version", OTEL_DISTRO_VERSION);
+    }
 
     php_info_print_table_colspan_header(2, "Effective configuration");
     php_info_print_table_start();
     php_info_print_table_header(2, "Configuration option", "Value");
 
-    auto const &options = opentelemetry::php::configManager.getOptionMetadata();
+    auto const &options = OTEL_G(globals)->configManager_->getOptionMetadata();
     for (auto const &option : options) {
         auto value = opentelemetry::php::ConfigurationManager::accessOptionStringValueByMetadata(option.second, OTEL_GL(config_)->get());
         php_info_print_table_row(2, option.first.c_str(), option.second.secret ? "***" : value.c_str());
@@ -32,4 +37,6 @@ void printPhpInfo(zend_module_entry *zend_module) {
 
     php_info_print_table_colspan_header(2, "INI configuration");
     display_ini_entries(zend_module);
-}
+}
+
+} // namespace opentelemetry::php

prod/native/extension/code/ModuleInfo.h

@@ -1,4 +1,9 @@
+#pragma once
 
 #include <Zend/zend_modules.h>
 
-void printPhpInfo(zend_module_entry *zend_module);
+namespace opentelemetry::php {
+
+void printPhpInfo(zend_module_entry *zend_module);
+
+}

prod/native/extension/code/ModuleIniEntries.cpp

@@ -1,5 +1,6 @@
 
 #include "ModuleIniEntries.h"
+#include "ModuleGlobals.h"
 #include "ConfigurationManager.h"
 #include "ConfigurationSnapshot.h"
 #include "CommonUtils.h"
@@ -42,8 +43,6 @@ OTEL_INI_ENTRY(STRINGIFY_HELPER(OTEL_PHP_INFERRED_SPANS_MIN_DURATION))
 PHP_INI_END()
 
 namespace opentelemetry::php {
-extern opentelemetry::php::ConfigurationManager configManager;
-
 
 constexpr const zend_string *iniEntryValue(zend_ini_entry *iniEntry, int type) {
     return (type == ZEND_INI_DISPLAY_ORIG) ? (iniEntry->modified ? iniEntry->orig_value : iniEntry->value) : iniEntry->value;
@@ -62,7 +61,7 @@ bool registerIniEntries(opentelemetry::php::LoggerInterface *log, int module_num
     }
 
     // register custom displayer for secret options
-    auto options = configManager.getOptionMetadata();
+    auto options = OTEL_G(globals)->configManager_->getOptionMetadata();
     for (auto const &option : options) {
         if (!option.second.secret) {
             continue;
@@ -78,4 +77,4 @@ bool registerIniEntries(opentelemetry::php::LoggerInterface *log, int module_num
     return true;
 }
 
-}
+} // namespace opentelemetry::php

prod/native/extension/code/ModuleInit.cpp

@@ -10,14 +10,11 @@
 #include "Hooking.h"
 #include "InternalFunctionInstrumentation.h"
 #include "ModuleIniEntries.h"
-#include "ModuleFunctions.h"
 #include "ModuleGlobals.h"
-#include "PeriodicTaskExecutor.h"
-#include "RequestScope.h"
 #include "SigSegvHandler.h"
 #include "os/OsUtils.h"
-#include "transport/OpAmp.h"
 #include "coordinator/CoordinatorProcess.h"
+#include "VendorCustomizationsInterface.h"
 
 #include <curl/curl.h>
 #include <inttypes.h> // PRIu64
@@ -31,15 +28,20 @@
 
 namespace opentelemetry::php {
 
-extern ConfigurationManager configManager;
-
 void logStartupPreamble(opentelemetry::php::LoggerInterface *logger) {
     constexpr LogLevel level = LogLevel::logLevel_debug;
     constexpr int colWidth = 40;
 
     using namespace std::literals;
-    ELOGF_NF(logger, level, OTEL_DISTRO_PRODUCT_NAME);
-    ELOGF_NF(logger, level, "%*s%s", -colWidth, "Native part version:", OTEL_DISTRO_VERSION);
+
+    if (OTEL_G(globals)->vendorCustomizations_) {
+        ELOG_NF(logger, level, "{} version: {}", OTEL_G(globals)->vendorCustomizations_->getDistributionName(), OTEL_G(globals)->vendorCustomizations_->getDistributionVersion());
+        ELOG_NF(logger, level, "{:<{}}{}", "OpenTelemetry distro base version:", colWidth, OTEL_DISTRO_VERSION);
+    } else {
+        ELOG_NF(logger, level, OTEL_DISTRO_PRODUCT_NAME);
+        ELOGF_NF(logger, level, "%*s%s", -colWidth, "Native part version:", OTEL_DISTRO_VERSION);
+    }
+
     ELOGF_NF(logger, level, "%*s%s", -colWidth, "Process command line:", opentelemetry::utils::sanitizeKeyValueString("OTEL_EXPORTER_OTLP_HEADERS", opentelemetry::osutils::getCommandLine()).c_str());
     ELOGF_NF(logger, level, "%*s%s", -colWidth, "Process environment:", opentelemetry::utils::sanitizeKeyValueString("OTEL_EXPORTER_OTLP_HEADERS", opentelemetry::osutils::getProcessEnvironment()).c_str());
 }
@@ -49,7 +51,7 @@ void moduleInit(int moduleType, int moduleNumber) {
     auto globals = OTEL_G(globals);
 
     opentelemetry::php::registerIniEntries(OTEL_GL(logger_).get(), moduleNumber);
-    configManager.update();
+    globals->configManager_->update();
     globals->config_->update();
 
     ELOGF_DEBUG(globals->logger_, MODULE, "%s entered: moduleType: %d, moduleNumber: %d, parent PID: %d, SAPI: %s (%d) is %s", __FUNCTION__, moduleType, moduleNumber, static_cast<int>(opentelemetry::osutils::getParentProcessId()), sapi.getName().data(), static_cast<uint8_t>(sapi.getType()), sapi.isSupported() ? "supported" : "unsupported");
@@ -79,7 +81,7 @@ void moduleInit(int moduleType, int moduleNumber) {
     // add config update watcher in worker process
     globals->coordinatorConfigProvider_->addConfigUpdateWatcher([globals](opentelemetry::php::coordinator::CoordinatorConfigurationProvider::configFiles_t const &cfgFiles) {
         ELOG_DEBUG(globals->logger_, COORDINATOR, "Received config update with {} files. Updating dynamic config and global config storage", cfgFiles.size());
-        configManager.update(cfgFiles);
+        globals->configManager_->update(cfgFiles);
     });
 
     globals->coordinatorConfigProvider_->triggerUpdateIfChanged();
@@ -123,4 +125,4 @@ void moduleShutdown( int moduleType, int moduleNumber ) {
     unregisterSigSegvHandler();
 }
 
-}
+} // namespace opentelemetry::php