Custom build with agent disabled by default

.ci/shared.sh

@@ -23,6 +23,8 @@ export ELASTIC_APM_PHP_TESTS_APP_CODE_HOST_KINDS_SHORT_NAMES=("${ELASTIC_APM_PHP
 export ELASTIC_APM_PHP_TESTS_LEAF_GROUPS_SHORT_NAMES=(no_ext_svc with_ext_svc)
 export ELASTIC_APM_PHP_TESTS_GROUPS_SHORT_NAMES=("${ELASTIC_APM_PHP_TESTS_LEAF_GROUPS_SHORT_NAMES[@]}" smoke)
 
+export ELASTIC_APM_PHP_TESTS_AGENT_ENABLED_CONFIG_DEFAULT=false
+
 function ensureSyslogIsRunningImpl () {
     if ps -ef | grep -v 'grep' | grep -q 'syslogd' ; then
         echo 'Syslog is already started.'

.ci/static-check-unit-test.sh

@@ -42,8 +42,14 @@ runPhpCoposerInstall
 composer run-script static_check
 
 # Run unit tests
+composerCommandToRunUnitTests=(composer run-script --)
 phpUnitConfigFile=$(php ./tests/ElasticApmTests/Util/runSelectPhpUnitConfigFile.php --tests-type=unit)
-composer run-script -- run_unit_tests_custom_config -c "${phpUnitConfigFile}"
+composerCommandToRunUnitTests=("${composerCommandToRunUnitTests[@]}" run_unit_tests_custom_config -c "${phpUnitConfigFile}")
+if [ "${ELASTIC_APM_PHP_TESTS_AGENT_ENABLED_CONFIG_DEFAULT:?}" == "false" ]; then
+    composerCommandToRunUnitTests=("${composerCommandToRunUnitTests[@]}" --filter AgentEnabledConfigUnitTest)
+fi
+echo "composerCommandToRunUnitTests: ${composerCommandToRunUnitTests[@]}"
+"${composerCommandToRunUnitTests[@]}"
 ls -l ./build/unit-tests-phpunit-junit.xml
 
 # Generate junit output for phpstan

.ci/validate_agent_installation.sh

@@ -22,12 +22,16 @@ function runComponentTests () {
     phpUnitConfigFile=$(php ./tests/ElasticApmTests/Util/runSelectPhpUnitConfigFile.php --tests-type=component)
     composerCommand=("${composerCommand[@]}" -c "${phpUnitConfigFile}")
 
-    if [ -n "${ELASTIC_APM_PHP_TESTS_GROUP}" ] ; then
-        composerCommand=("${composerCommand[@]}" --group "${ELASTIC_APM_PHP_TESTS_GROUP}")
-    fi
-
-    if [ -n "${ELASTIC_APM_PHP_TESTS_FILTER}" ] ; then
-        composerCommand=("${composerCommand[@]}" --filter "${ELASTIC_APM_PHP_TESTS_FILTER}")
+    if [ "${ELASTIC_APM_PHP_TESTS_AGENT_ENABLED_CONFIG_DEFAULT:?}" == "true" ]; then
+        if [ -n "${ELASTIC_APM_PHP_TESTS_GROUP}" ] ; then
+            composerCommand=("${composerCommand[@]}" --group "${ELASTIC_APM_PHP_TESTS_GROUP}")
+        fi
+
+        if [ -n "${ELASTIC_APM_PHP_TESTS_FILTER}" ] ; then
+            composerCommand=("${composerCommand[@]}" --filter "${ELASTIC_APM_PHP_TESTS_FILTER}")
+        fi
+    else
+        composerCommand=("${composerCommand[@]}" --filter AgentEnabledConfigComponentTest)
     fi
 
     local initialTimeoutInMinutes=30

agent/native/ext/ConfigManager.cpp

@@ -1034,7 +1034,7 @@ static void initOptionsMetadata( OptionMetadata* optsMeta )
             buildBoolOptionMetadata,
             enabled,
             ELASTIC_APM_CFG_OPT_NAME_ENABLED,
-            /* defaultValue: */ true );
+            /* defaultValue: */ false );
 
     ELASTIC_APM_INIT_METADATA(
             buildStringOptionMetadata,

agent/native/ext/lifecycle.cpp

@@ -500,6 +500,22 @@ static void unregisterErrorAndExceptionHooks() {
 
 }
 
+void logImportantAgentInfo( const ConfigSnapshot* config, String calledFromFunc )
+{
+    ELASTIC_APM_LOG_INFO(
+        "Custom build based on version: %s"
+        "; Custom changes:"
+        " * agent is disabled by default (enabled: false)"
+        "; config->enabled: %s."
+        "; SAPI module name: %s"
+        "; Called from: %s"
+        , PHP_ELASTIC_APM_VERSION
+        , boolToString( config->enabled )
+        , getPhpSapiModuleName()
+        , calledFromFunc
+    );
+}
+
 void elasticApmModuleInit( int moduleType, int moduleNumber )
 {
     ELASTIC_APM_LOG_DIRECT_DEBUG( "%s entered: moduleType: %d, moduleNumber: %d, parent PID: %d", __FUNCTION__, moduleType, moduleNumber, (int)(getParentProcessId()) );
@@ -526,10 +542,11 @@ void elasticApmModuleInit( int moduleType, int moduleNumber )
     ELASTIC_APM_CALL_IF_FAILED_GOTO( ensureLoggerInitialConfigIsLatest( tracer ) );
     ELASTIC_APM_CALL_IF_FAILED_GOTO( ensureAllComponentsHaveLatestConfig( tracer ) );
 
-    logSupportabilityInfo( logLevel_debug );
-
     config = getTracerCurrentConfigSnapshot( tracer );
 
+    logImportantAgentInfo( config, __FUNCTION__ );
+    logSupportabilityInfo( logLevel_debug );
+
     if ( ! config->enabled )
     {
         resultCode = resultSuccess;
@@ -580,6 +597,8 @@ void elasticApmModuleShutdown( int moduleType, int moduleNumber )
     Tracer* const tracer = getGlobalTracer();
     const ConfigSnapshot* const config = getTracerCurrentConfigSnapshot( tracer );
 
+    logImportantAgentInfo( config, __FUNCTION__ );
+
     if ( ! config->enabled )
     {
         resultCode = resultSuccess;

agent/native/ext/tests/config_defaults.phpt

@@ -25,9 +25,11 @@ elasticApmAssertSame("getenv('ELASTIC_APM_ENABLED')", getenv('ELASTIC_APM_ENABLE
 
 elasticApmAssertEqual("ini_get('elastic_apm.enabled')", ini_get('elastic_apm.enabled'), false);
 
-elasticApmAssertSame("elastic_apm_is_enabled()", elastic_apm_is_enabled(), true);
-
-elasticApmAssertSame("elastic_apm_get_config_option_by_name('enabled')", elastic_apm_get_config_option_by_name('enabled'), true);
+if (($agentEnabledConfigDefaultEnvVar = getenv('ELASTIC_APM_PHP_TESTS_AGENT_ENABLED_CONFIG_DEFAULT')) !== false) {
+    $agentEnabledConfigDefault = json_decode($agentEnabledConfigDefaultEnvVar);
+    elasticApmAssertSame("elastic_apm_is_enabled()", elastic_apm_is_enabled(), $agentEnabledConfigDefault);
+    elasticApmAssertSame("elastic_apm_get_config_option_by_name('enabled')", elastic_apm_get_config_option_by_name('enabled'), $agentEnabledConfigDefault);
+}
 
 //////////////////////////////////////////////
 ///////////////  log_file

agent/native/ext/tests/config_setting_to_invalid_values_using_env_vars.phpt

@@ -19,9 +19,11 @@ require __DIR__ . '/../tests_util/tests_util.php';
 
 elasticApmAssertSame("getenv('ELASTIC_APM_ENABLED')", getenv('ELASTIC_APM_ENABLED'), 'not_valid_boolean_value');
 
-elasticApmAssertSame("elastic_apm_is_enabled()", elastic_apm_is_enabled(), true);
-
-elasticApmAssertSame("elastic_apm_get_config_option_by_name('enabled')", elastic_apm_get_config_option_by_name('enabled'), true);
+if (($agentEnabledConfigDefaultEnvVar = getenv('ELASTIC_APM_PHP_TESTS_AGENT_ENABLED_CONFIG_DEFAULT')) !== false) {
+    $agentEnabledConfigDefault = json_decode($agentEnabledConfigDefaultEnvVar);
+    elasticApmAssertSame("elastic_apm_is_enabled()", elastic_apm_is_enabled(), $agentEnabledConfigDefault);
+    elasticApmAssertSame("elastic_apm_get_config_option_by_name('enabled')", elastic_apm_get_config_option_by_name('enabled'), $agentEnabledConfigDefault);
+}
 
 //////////////////////////////////////////////
 ///////////////  assert_level

agent/native/ext/tests/config_setting_to_invalid_values_using_ini.phpt

@@ -19,9 +19,11 @@ require __DIR__ . '/../tests_util/tests_util.php';
 
 elasticApmAssertEqual("ini_get('elastic_apm.enabled')", ini_get('elastic_apm.enabled'), 'not valid boolean value');
 
-elasticApmAssertSame("elastic_apm_get_config_option_by_name('enabled')", elastic_apm_get_config_option_by_name('enabled'), true);
-
-elasticApmAssertSame("elastic_apm_is_enabled()", elastic_apm_is_enabled(), true);
+if (($agentEnabledConfigDefaultEnvVar = getenv('ELASTIC_APM_PHP_TESTS_AGENT_ENABLED_CONFIG_DEFAULT')) !== false) {
+    $agentEnabledConfigDefault = json_decode($agentEnabledConfigDefaultEnvVar);
+    elasticApmAssertSame("elastic_apm_is_enabled()", elastic_apm_is_enabled(), $agentEnabledConfigDefault);
+    elasticApmAssertSame("elastic_apm_get_config_option_by_name('enabled')", elastic_apm_get_config_option_by_name('enabled'), $agentEnabledConfigDefault);
+}
 
 //////////////////////////////////////////////
 ///////////////  assert_level

agent/native/ext/util_for_PHP.cpp

@@ -275,6 +275,11 @@ ResultCode callPhpFunctionRetZval( StringView phpFunctionName, uint32_t argsCoun
     return callPhpFunction( phpFunctionName, argsCount, args, consumeZvalRetVal, retVal );
 }
 
+String getPhpSapiModuleName()
+{
+    return sapi_module.name;
+}
+
 bool isPhpRunningAsCliScript()
 {
     return strcmp( sapi_module.name, "cli" ) == 0;

agent/native/ext/util_for_PHP.h

@@ -85,6 +85,7 @@ ResultCode callPhpFunctionRetZval( StringView phpFunctionName, uint32_t argsCoun
 
 void getArgsFromZendExecuteData( zend_execute_data *execute_data, size_t dstArraySize, zval dstArray[], uint32_t* argsCount );
 
+String getPhpSapiModuleName();
 bool isPhpRunningAsCliScript();
 bool detectOpcachePreload();
 bool isScriptRestricedByOpcacheAPI();

agent/php/ElasticApm/Impl/Config/AllOptionsMetadata.php

@@ -93,7 +93,7 @@ public static function get(): array
             OptionNames::DEV_INTERNAL                               => new NullableWildcardListOptionMetadata(),
             OptionNames::DISABLE_INSTRUMENTATIONS                   => new NullableWildcardListOptionMetadata(),
             OptionNames::DISABLE_SEND                               => new BoolOptionMetadata(/* default */ false),
-            OptionNames::ENABLED                                    => new BoolOptionMetadata(/* default */ true),
+            OptionNames::ENABLED                                    => new BoolOptionMetadata(/* default */ false),
             OptionNames::ENVIRONMENT                                => new NullableStringOptionMetadata(),
             OptionNames::GLOBAL_LABELS                              => new NullableLabelsOptionMetadata(),
             OptionNames::HOSTNAME                                   => new NullableStringOptionMetadata(),

tests/ElasticApmTests/ComponentTests/AgentEnabledConfigComponentTest.php

@@ -0,0 +1,112 @@
+<?php
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+declare(strict_types=1);
+
+namespace ElasticApmTests\ComponentTests;
+
+use Elastic\Apm\Impl\Config\OptionNames;
+use ElasticApmTests\ComponentTests\Util\AmbientContextForTests;
+use ElasticApmTests\ComponentTests\Util\AppCodeHostParams;
+use ElasticApmTests\ComponentTests\Util\AppCodeRequestParams;
+use ElasticApmTests\ComponentTests\Util\AppCodeTarget;
+use ElasticApmTests\ComponentTests\Util\ComponentTestCaseBase;
+use ElasticApmTests\Util\AssertMessageStack;
+use ElasticApmTests\Util\DataProviderForTestBuilder;
+use ElasticApmTests\Util\MixedMap;
+
+/**
+ * @group smoke
+ * @group does_not_require_external_services
+ */
+final class AgentEnabledConfigComponentTest extends ComponentTestCaseBase
+{
+    public static function appCodeForTestAgentEnabledConfig(MixedMap $appCodeArgs): void
+    {
+        $agentEnabledExpected = $appCodeArgs->getBool(OptionNames::ENABLED);
+
+        /**
+         * elastic_apm_* functions are provided by the elastic_apm extension
+         *
+         * @noinspection PhpFullyQualifiedNameUsageInspection, PhpUndefinedFunctionInspection
+         * @phpstan-ignore-next-line
+         */
+        $agentEnabledAsSeenByNativePart = \elastic_apm_is_enabled();
+        self::assertSame($agentEnabledExpected, $agentEnabledAsSeenByNativePart);
+    }
+
+    /**
+     * @return iterable<string, array{MixedMap}>
+     */
+    public static function dataProviderForTestAgentEnabledConfig(): iterable
+    {
+        $result = (new DataProviderForTestBuilder())
+            ->addKeyedDimensionAllValuesCombinable(OptionNames::ENABLED, [null, true, false])
+            ->build();
+
+        return DataProviderForTestBuilder::convertEachDataSetToMixedMap($result);
+    }
+
+    /**
+     * @dataProvider dataProviderForTestAgentEnabledConfig
+     */
+    public function testAgentEnabledConfig(MixedMap $testArgs): void
+    {
+        AssertMessageStack::newScope(/* out */ $dbgCtx, AssertMessageStack::funcArgs());
+
+        $testCaseHandle = $this->getTestCaseHandle();
+        $appCodeHost = $testCaseHandle->ensureMainAppCodeHost(
+            function (AppCodeHostParams $appCodeParams) use ($testArgs): void {
+                self::setConfigIfNotNull($testArgs, OptionNames::ENABLED, $appCodeParams);
+            }
+        );
+
+        $agentEnabledTestArg = $testArgs->getNullableBool(OptionNames::ENABLED);
+        $agentEnabledActual = $appCodeHost->appCodeHostParams->getEffectiveAgentConfig()->enabled();
+        if (($agentEnabledExpected = $agentEnabledTestArg ?? AmbientContextForTests::testConfig()->agentEnabledConfigDefault) !== null) {
+            self::assertSame($agentEnabledExpected, $agentEnabledActual);
+        }
+
+        $appCodeHost->sendRequest(
+            AppCodeTarget::asRouted([__CLASS__, 'appCodeForTestAgentEnabledConfig']),
+            function (AppCodeRequestParams $appCodeRequestParams) use ($agentEnabledActual): void {
+                $appCodeRequestParams->setAppCodeArgs([OptionNames::ENABLED => $agentEnabledActual]);
+            }
+        );
+
+        if ($agentEnabledActual) {
+            $dataFromAgent = $this->waitForOneEmptyTransaction($testCaseHandle);
+            self::assertCount(1, $dataFromAgent->idToTransaction);
+            self::assertCount(1, $dataFromAgent->metadatas);
+        } else {
+            $logger = self::getLoggerStatic(__NAMESPACE__, __CLASS__, __FILE__);
+            $waitTimeSeconds = 5;
+            ($loggerProxy = $logger->ifInfoLevelEnabled(__LINE__, __FUNCTION__))
+            && $loggerProxy->log('Sleeping ' . $waitTimeSeconds . ' seconds to give agent enough time to send data (which it should not since it is disabled)...');
+            sleep($waitTimeSeconds);
+            $dataFromAgent = $testCaseHandle->getDataFromAgentWithoutWaiting();
+            self::assertCount(0, $dataFromAgent->idToTransaction);
+            self::assertCount(0, $dataFromAgent->metadatas);
+        }
+        self::assertCount(0, $dataFromAgent->idToSpan);
+        self::assertCount(0, $dataFromAgent->idToError);
+    }
+}

tests/ElasticApmTests/ComponentTests/Util/ComponentTestCaseBase.php

@@ -567,8 +567,10 @@ protected static function disableTimingDependentFeatures(AppCodeHostParams $appC
 
     protected static function setConfigIfNotNull(MixedMap $testArgs, string $optName, AppCodeHostParams $appCodeParams): void
     {
-        $optVal = $testArgs->getNullableString($optName);
+        $optVal = $testArgs->get($optName);
         if ($optVal !== null) {
+            self::assertTrue(is_string($optVal) || is_int($optVal) || is_float($optVal) || is_bool($optVal));
+            /** @var string|int|float|bool $optVal */
             $appCodeParams->setAgentOption($optName, $optVal);
         }
     }

tests/ElasticApmTests/ComponentTests/Util/ConfigSnapshotForTests.php

@@ -60,6 +60,9 @@ final class ConfigSnapshotForTests implements LoggableInterface
     /** @var bool */
     public $deleteTempPhpIni;
 
+    /** @var ?bool */
+    public $agentEnabledConfigDefault = null;
+
     /** @var ?WildcardListMatcher */
     public $envVarsToPassThrough;
 

tests/ElasticApmTests/ComponentTests/Util/ExpectedEventCounts.php

@@ -43,7 +43,7 @@ public function __construct()
     {
         $this->perDataKind = [];
         $this->errors(0);
-        $this->setValueForKind(ApmDataKind::metadata(), 1);
+        $this->metadatas(1);
         $this->metricSets(0);
         $this->spans(0);
         $this->transactions(1);
@@ -65,6 +65,11 @@ private function setValueForKind(ApmDataKind $apmDataKind, ?int $count): self
         return $this;
     }
 
+    public function metadatas(int $count): self
+    {
+        return $this->setValueForKind(ApmDataKind::metadata(), $count);
+    }
+
     public function errors(int $count): self
     {
         return $this->setValueForKind(ApmDataKind::error(), $count);

tests/ElasticApmTests/ComponentTests/Util/TestCaseHandle.php

@@ -156,6 +156,13 @@ function (HttpAppCodeHostParams $appCodeHostParams) use ($setParamsFunc): void {
         return $this->additionalHttpAppCodeHost;
     }
 
+    public function getDataFromAgentWithoutWaiting(): DataFromAgentPlusRaw
+    {
+        $dataFromAgentAccumulator = new DataFromAgentPlusRawAccumulator();
+        $dataFromAgentAccumulator->addReceiverEvents($this->mockApmServer->fetchNewData(/* shouldWait */ false));
+        return $dataFromAgentAccumulator->getAccumulatedData();
+    }
+
     public function waitForDataFromAgent(ExpectedEventCounts $expectedEventCounts, bool $shouldValidate = true): DataFromAgentPlusRaw
     {
         TestCaseBase::assertNotEmpty($this->appCodeInvocations);

tests/ElasticApmTests/UnitTests/AgentEnabledConfigUnitTest.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/** @noinspection PhpUnhandledExceptionInspection */
+
+declare(strict_types=1);
+
+namespace ElasticApmTests\UnitTests;
+
+use Elastic\Apm\Impl\Config\AllOptionsMetadata;
+use Elastic\Apm\Impl\Config\OptionNames;
+use Elastic\Apm\Impl\Log\NoopLoggerFactory;
+use ElasticApmTests\ComponentTests\Util\ConfigUtilForTests;
+use ElasticApmTests\Util\TestCaseBase;
+
+final class AgentEnabledConfigUnitTest extends TestCaseBase
+{
+    public function testDefaultAsSeenByPhpPart(): void
+    {
+        $configForTests = ConfigUtilForTests::read(/* additionalConfigSource */ null, NoopLoggerFactory::singletonInstance());
+        if ($configForTests->agentEnabledConfigDefault === null) {
+            self::dummyAssert();
+            return;
+        }
+        self::assertSame($configForTests->agentEnabledConfigDefault, AllOptionsMetadata::get()[OptionNames::ENABLED]->defaultValue());
+    }
+}