Skip to content

Commit

Permalink
Added dev_internal_config_on_call_stack
Browse files Browse the repository at this point in the history
  • Loading branch information
@SergeyKleyman
SergeyKleyman committed Apr 30, 2024
1 parent 2f93994 commit 928c989
Show file tree
Hide file tree
Showing 5 changed files with 146 additions and 5 deletions.
119 changes: 119 additions & 0 deletions agent/native/ext/ConfigManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,14 @@
#ifndef ELASTIC_APM_MOCK_PHP_DEPS
# include <zend_ini.h>
#endif
#include <span>
#include "elastic_apm_assert.h"
#include "log.h"
#include "util.h"
#include "TextOutputStream.h"
#include "elastic_apm_alloc.h"
#include "time_util.h"
#include "basic_macros.h"

#define ELASTIC_APM_CURRENT_LOG_CATEGORY ELASTIC_APM_LOG_CATEGORY_CONFIG

Expand Down Expand Up @@ -136,6 +138,8 @@ typedef String (* StreamParsedValueFunc )( const OptionMetadata* optMeta, Parsed
typedef void (* SetConfigSnapshotFieldFunc )( const OptionMetadata* optMeta, ParsedOptionValue parsedValue, ConfigSnapshot* dst );
typedef ParsedOptionValue (* GetConfigSnapshotFieldFunc )( const OptionMetadata* optMeta, const ConfigSnapshot* src );
typedef void (* ParsedOptionValueToZvalFunc )( const OptionMetadata* optMeta, ParsedOptionValue parsedValue, zval* return_value );
typedef bool (* AreEqualParsedValuesFunc )( const OptionMetadata* optMeta, ParsedOptionValue parsedValue1, ParsedOptionValue parsedValue2 );

struct OptionMetadata
{
String name = nullptr;
Expand All @@ -150,6 +154,7 @@ struct OptionMetadata
SetConfigSnapshotFieldFunc setField = nullptr;
GetConfigSnapshotFieldFunc getField = nullptr;
ParsedOptionValueToZvalFunc parsedValueToZval = nullptr;
AreEqualParsedValuesFunc areEqualParsedValues = nullptr;
OptionAdditionalMetadata additionalData = {};
};

Expand Down Expand Up @@ -279,6 +284,14 @@ static void parsedStringValueToZval( const OptionMetadata* optMeta, ParsedOption
RETURN_STRING( parsedValue.u.stringValue );
}

static bool areEqualParsedStringValues( const OptionMetadata* optMeta, ParsedOptionValue parsedValue1, ParsedOptionValue parsedValue2 )
{
return
(parsedValue1.u.stringValue == nullptr || parsedValue2.u.stringValue == nullptr)
? (parsedValue1.u.stringValue == parsedValue2.u.stringValue)
: strcmp(parsedValue1.u.stringValue, parsedValue2.u.stringValue) == 0;
}

static ResultCode parseBoolValueImpl( const OptionMetadata* optMeta, ParsedOptionValueType expectedType, String rawValue, /* out */ ParsedOptionValue* parsedValue )
{
ELASTIC_APM_ASSERT_VALID_PTR( optMeta );
Expand Down Expand Up @@ -335,6 +348,11 @@ static void parsedBoolValueToZval( const OptionMetadata* optMeta, ParsedOptionVa
RETURN_BOOL( parsedValue.u.boolValue );
}

static bool areEqualParsedBoolValues( const OptionMetadata* optMeta, ParsedOptionValue parsedValue1, ParsedOptionValue parsedValue2 )
{
return parsedValue1.u.boolValue == parsedValue2.u.boolValue;
}

static ResultCode parseOptionalBoolValue( const OptionMetadata* optMeta, String rawValue, /* out */ ParsedOptionValue* parsedValue )
{
ParsedOptionValue tempParsedValue;
Expand Down Expand Up @@ -368,6 +386,14 @@ static void parsedOptionalBoolValueToZval( const OptionMetadata* optMeta, Parsed
RETURN_STRING( optionalBoolToString( parsedValue.u.optionalBoolValue ) );
}

static bool areEqualParsedOptionalBoolValues( const OptionMetadata* optMeta, ParsedOptionValue parsedValue1, ParsedOptionValue parsedValue2 )
{
return
(parsedValue1.u.optionalBoolValue.isSet && parsedValue2.u.optionalBoolValue.isSet)
? (parsedValue1.u.optionalBoolValue.value == parsedValue2.u.optionalBoolValue.value)
: (parsedValue1.u.optionalBoolValue.isSet == parsedValue2.u.optionalBoolValue.isSet);
}

static ResultCode parseDurationValue( const OptionMetadata* optMeta, String rawValue, /* out */ ParsedOptionValue* parsedValue )
{
ELASTIC_APM_ASSERT_VALID_PTR( optMeta );
Expand Down Expand Up @@ -412,6 +438,11 @@ static void parsedDurationValueToZval( const OptionMetadata* optMeta, ParsedOpti
RETURN_DOUBLE( durationToMilliseconds( parsedValue.u.durationValue ) );
}

static bool areEqualParsedDurationValues( const OptionMetadata* optMeta, ParsedOptionValue parsedValue1, ParsedOptionValue parsedValue2 )
{
return durationToMilliseconds(parsedValue1.u.durationValue) == durationToMilliseconds(parsedValue2.u.durationValue);
}

static ResultCode parseSizeValue( const OptionMetadata* optMeta, String rawValue, /* out */ ParsedOptionValue* parsedValue )
{
ELASTIC_APM_ASSERT_VALID_PTR( optMeta );
Expand Down Expand Up @@ -448,6 +479,11 @@ static void parsedSizeValueToZval( const OptionMetadata* optMeta, ParsedOptionVa
RETURN_DOUBLE( sizeToBytes( parsedValue.u.sizeValue ) );
}

static bool areEqualParsedSizeValues( const OptionMetadata* optMeta, ParsedOptionValue parsedValue1, ParsedOptionValue parsedValue2 )
{
return sizeToBytes(parsedValue1.u.sizeValue) == sizeToBytes(parsedValue2.u.sizeValue);
}

static
ResultCode parseEnumValue( const OptionMetadata* optMeta, String rawValue, /* out */ ParsedOptionValue* parsedValue )
{
Expand Down Expand Up @@ -512,6 +548,11 @@ static void parsedEnumValueToZval( const OptionMetadata* optMeta, ParsedOptionVa
RETURN_LONG( (long)( parsedValue.u.intValue ) );
}

static bool areEqualParsedEnumValues( const OptionMetadata* optMeta, ParsedOptionValue parsedValue1, ParsedOptionValue parsedValue2 )
{
return parsedValue1.u.intValue == parsedValue2.u.intValue;
}

static String streamParsedLogLevel( const OptionMetadata* optMeta, ParsedOptionValue parsedValue, TextOutputStream* txtOutStream )
{
ELASTIC_APM_ASSERT_VALID_PTR( optMeta );
Expand Down Expand Up @@ -546,6 +587,7 @@ static OptionMetadata buildStringOptionMetadata(
.setField = setFieldFunc,
.getField = getFieldFunc,
.parsedValueToZval = &parsedStringValueToZval,
.areEqualParsedValues = &areEqualParsedStringValues,
.additionalData = {}
};
}
Expand Down Expand Up @@ -574,6 +616,7 @@ static OptionMetadata buildLoggingRelatedStringOptionMetadata(
.setField = setFieldFunc,
.getField = getFieldFunc,
.parsedValueToZval = &parsedStringValueToZval,
.areEqualParsedValues = &areEqualParsedStringValues,
.additionalData = {}
};
}
Expand Down Expand Up @@ -602,6 +645,7 @@ static OptionMetadata buildBoolOptionMetadata(
.setField = setFieldFunc,
.getField = getFieldFunc,
.parsedValueToZval = &parsedBoolValueToZval,
.areEqualParsedValues = &areEqualParsedBoolValues,
.additionalData = {}
};
}
Expand Down Expand Up @@ -630,6 +674,7 @@ static OptionMetadata buildOptionalBoolOptionMetadata(
.setField = setFieldFunc,
.getField = getFieldFunc,
.parsedValueToZval = &parsedOptionalBoolValueToZval,
.areEqualParsedValues = &areEqualParsedOptionalBoolValues,
.additionalData = {}
};
}
Expand Down Expand Up @@ -659,6 +704,7 @@ static OptionMetadata buildDurationOptionMetadata(
.setField = setFieldFunc,
.getField = getFieldFunc,
.parsedValueToZval = &parsedDurationValueToZval,
.areEqualParsedValues = &areEqualParsedDurationValues,
.additionalData = (OptionAdditionalMetadata){ .durationData = (DurationOptionAdditionalMetadata){ .defaultUnits = defaultUnits, .isNegativeValid = isNegativeValid } }
};
}
Expand Down Expand Up @@ -688,6 +734,7 @@ static OptionMetadata buildDurationOptionMetadata(
.setField = setFieldFunc,
.getField = getFieldFunc,
.parsedValueToZval = &parsedSizeValueToZval,
.areEqualParsedValues = &areEqualParsedSizeValues,
.additionalData = (OptionAdditionalMetadata){ .sizeData = (SizeOptionAdditionalMetadata){ .defaultUnits = defaultUnits } }
};
}
Expand Down Expand Up @@ -720,6 +767,7 @@ static OptionMetadata buildEnumOptionMetadata(
.setField = setFieldFunc,
.getField = getFieldFunc,
.parsedValueToZval = &parsedEnumValueToZval,
.areEqualParsedValues = &areEqualParsedEnumValues,
.additionalData = (OptionAdditionalMetadata){ .enumData = additionalMetadata }
};
}
Expand Down Expand Up @@ -803,6 +851,7 @@ ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, breakdownMetrics )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, captureErrors )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( stringValue, devInternal )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, devInternalBackendCommLogVerbose )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, devInternalConfigOnCallStack )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, devInternalCurlInstrumCallCurl )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, devInternalCurlInstrumCreateSpan )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( stringValue, disableInstrumentations )
Expand Down Expand Up @@ -1022,6 +1071,12 @@ static void initOptionsMetadata( OptionMetadata* optsMeta )
ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_BACKEND_COMM_LOG_VERBOSE,
/* defaultValue: */ false );

ELASTIC_APM_INIT_METADATA(
buildBoolOptionMetadata,
devInternalConfigOnCallStack,
ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CONFIG_ON_CALL_STACK,
/* defaultValue: */ false );

ELASTIC_APM_INIT_METADATA(
buildBoolOptionMetadata,
devInternalCurlInstrumCallCurl,
Expand Down Expand Up @@ -1848,3 +1903,67 @@ ResultCode newConfigManager( ConfigManager** pNewCfgManager, bool isLoggingRelat
deleteConfigManagerAndSetToNull( /* in,out */ &cfgManager );
goto finally;
}

bool isOptionValueSameAsDefault(const ConfigManager* cfgManager, OptionId optId)
{
const OptionMetadata* optMeta = &(cfgManager->meta.optionsMeta[optId]);
return optMeta->areEqualParsedValues(optMeta, optMeta->defaultValue, optMeta->getField(optMeta, &(cfgManager->current.snapshot)));
}

struct ConfigMarkerFunc
{
using FuncType = bool (*)(const ConfigManager* configManager, std::span<ConfigMarkerFunc> configMarkerFuncs, AddConfigToCallStackContinuation continuation);

FuncType value;
};

#define ELASTIC_APM_MAKE_CONFIG_MARKER_FUNC_NAME(optSnapFieldName) ELASTIC_APM_PP_CONCAT(config_, optSnapFieldName)

static void callFirstMatchingOrContinuation(const ConfigManager* configManager, std::span<ConfigMarkerFunc> configMarkerFuncs, AddConfigToCallStackContinuation continuation)
{
ELASTIC_APM_FOR_EACH_INDEX(i, configMarkerFuncs.size())
{
if (configMarkerFuncs[i].value(configManager, configMarkerFuncs.last(configMarkerFuncs.size() - (i + 1)), continuation))
{
return;
}
}

continuation();
}

static bool configMarkerFuncImpl(OptionId optId, const ConfigManager* configManager, std::span<ConfigMarkerFunc> configMarkerFuncs, AddConfigToCallStackContinuation continuation)
{
if (isOptionValueSameAsDefault(configManager, optId))
{
return false;
}

callFirstMatchingOrContinuation(configManager, configMarkerFuncs, continuation);
return true;
}

#define ELASTIC_APM_DEFINE_CONFIG_MARKER_FUNC(optSnapFieldName) \
bool ELASTIC_APM_MAKE_CONFIG_MARKER_FUNC_NAME(optSnapFieldName)(const ConfigManager* configManager, std::span<ConfigMarkerFunc> configMarkerFuncs, AddConfigToCallStackContinuation continuation) \
{ \
return configMarkerFuncImpl(ELASTIC_APM_PP_CONCAT(optionId_, optSnapFieldName), configManager, configMarkerFuncs, continuation); \
} \
/**/

ELASTIC_APM_DEFINE_CONFIG_MARKER_FUNC(devInternalCurlInstrumCallCurl)
ELASTIC_APM_DEFINE_CONFIG_MARKER_FUNC(devInternalCurlInstrumCreateSpan)
ELASTIC_APM_DEFINE_CONFIG_MARKER_FUNC(disableSend)

static std::array g_configMarkerFuncs{
ConfigMarkerFunc{ &( ELASTIC_APM_MAKE_CONFIG_MARKER_FUNC_NAME(devInternalCurlInstrumCallCurl) ) },
ConfigMarkerFunc{ &( ELASTIC_APM_MAKE_CONFIG_MARKER_FUNC_NAME(devInternalCurlInstrumCreateSpan) ) },
ConfigMarkerFunc{ &( ELASTIC_APM_MAKE_CONFIG_MARKER_FUNC_NAME(disableSend) ) }
};

#undef ELASTIC_APM_MAKE_CONFIG_MARKER_FUNC_NAME

void addConfigToCallStack(const ConfigManager* configManager, AddConfigToCallStackContinuation continuation)
{
callFirstMatchingOrContinuation(configManager, g_configMarkerFuncs, continuation);
}

7 changes: 7 additions & 0 deletions agent/native/ext/ConfigManager.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ enum OptionId
optionId_captureErrors,
optionId_devInternal,
optionId_devInternalBackendCommLogVerbose,
optionId_devInternalConfigOnCallStack,
optionId_devInternalCurlInstrumCallCurl,
optionId_devInternalCurlInstrumCreateSpan,
optionId_disableInstrumentations,
Expand Down Expand Up @@ -214,6 +215,11 @@ void getConfigManagerRawData(

const ConfigSnapshot* getGlobalCurrentConfigSnapshot();

bool isOptionValueSameAsDefault(const ConfigManager* cfgManager, OptionId optId);

typedef void (* AddConfigToCallStackContinuation)();
void addConfigToCallStack(const ConfigManager* configManager, AddConfigToCallStackContinuation continuation);

#define ELASTIC_APM_CFG_OPT_HAS_NO_VALUE "no value"

/**
Expand Down Expand Up @@ -269,6 +275,7 @@ const ConfigSnapshot* getGlobalCurrentConfigSnapshot();
*/
#define ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL "dev_internal"
#define ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_BACKEND_COMM_LOG_VERBOSE "dev_internal_backend_comm_log_verbose"
#define ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CONFIG_ON_CALL_STACK "dev_internal_config_on_call_stack"
#define ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CURL_INSTRUM_CALL_CURL "dev_internal_curl_instrum_call_curl"
#define ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CURL_INSTRUM_CREATE_SPAN "dev_internal_curl_instrum_create_span"

Expand Down
1 change: 1 addition & 0 deletions agent/native/ext/ConfigSnapshot.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ struct ConfigSnapshot
bool captureErrors = false;
String devInternal = nullptr;
bool devInternalBackendCommLogVerbose = false;
bool devInternalConfigOnCallStack = false;
bool devInternalCurlInstrumCallCurl = true;
bool devInternalCurlInstrumCreateSpan = true;
String disableInstrumentations = nullptr;
Expand Down
1 change: 1 addition & 0 deletions agent/native/ext/elastic_apm.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ PHP_INI_BEGIN()
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_CAPTURE_ERRORS )
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL )
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_BACKEND_COMM_LOG_VERBOSE )
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CONFIG_ON_CALL_STACK )
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CURL_INSTRUM_CALL_CURL )
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CURL_INSTRUM_CREATE_SPAN )
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_DISABLE_INSTRUMENTATIONS )
Expand Down
23 changes: 18 additions & 5 deletions agent/native/ext/lifecycle.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -400,12 +400,8 @@ auto buildPeriodicTaskExecutor() {
return periodicTaskExecutor;
}

void elasticApmRequestInit()
void elasticApmRequestInitImpl()
{
if (!ELASTICAPM_G(globals)->sapi_.isSupported()) {
return;
}

requestCounter++;

Tracer* const tracer = getGlobalTracer();
Expand Down Expand Up @@ -547,6 +543,23 @@ void elasticApmRequestInit()
// , timePointToEpochMicroseconds( currentTime ) );
// }

void elasticApmRequestInit()
{
if (!ELASTICAPM_G(globals)->sapi_.isSupported()) {
return;
}

const ConfigSnapshot* config = getTracerCurrentConfigSnapshot( getGlobalTracer() );
if ( config->devInternalConfigOnCallStack )
{
addConfigToCallStack( getGlobalTracer()->configManager, &elasticApmRequestInitImpl );
}
else
{
elasticApmRequestInitImpl();
}
}

void elasticApmRequestShutdown()
{
if (!ELASTICAPM_G(globals)->sapi_.isSupported()) {
Expand Down

0 comments on commit 928c989

Please sign in to comment.