Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added dev_internal_config_on_call_stack #1153

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Added dev_internal_config_on_call_stack #1153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dca25f1
Added dev_internal_curl_instrum_call_curl config
SergeyKleyman Apr 30, 2024
cfb4315
Fixed typo
SergeyKleyman Apr 30, 2024
9c811e6
Added dev_internal_curl_instrum_create_span config
SergeyKleyman Apr 30, 2024
9c77960
dev_internal_curl_instrum_call_curl type from string to bool ...
SergeyKleyman Apr 30, 2024
50b91b5
Merge branch 'dev_internal_curl_instrum_create_span' into dev_interna…
SergeyKleyman Apr 30, 2024
779a4d4
Fixed typo
SergeyKleyman Apr 30, 2024
5344f13
Merge branch 'dev_internal_curl_instrum_create_span' into dev_interna…
SergeyKleyman Apr 30, 2024
2f93994
Merge branch 'dev_internal_curl_instrum_call_curl' into dev_internal_…
SergeyKleyman Apr 30, 2024
928c989
Added dev_internal_config_on_call_stack
SergeyKleyman Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 133 additions & 0 deletions agent/native/ext/ConfigManager.cpp
View file
Open in desktop
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,9 @@ 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 )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, disableSend )
ELASTIC_APM_DEFINE_FIELD_ACCESS_FUNCS( boolValue, enabled )
Expand Down Expand Up @@ -1020,6 +1071,24 @@ 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,
ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CURL_INSTRUM_CALL_CURL,
/* defaultValue: */ true );

ELASTIC_APM_INIT_METADATA(
buildBoolOptionMetadata,
devInternalCurlInstrumCreateSpan,
ELASTIC_APM_CFG_OPT_NAME_DEV_INTERNAL_CURL_INSTRUM_CREATE_SPAN,
/* defaultValue: */ true );

ELASTIC_APM_INIT_METADATA(
buildStringOptionMetadata,
disableInstrumentations,
Expand Down Expand Up @@ -1834,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);
}

11 changes: 11 additions & 0 deletions agent/native/ext/ConfigManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ enum OptionId
optionId_captureErrors,
optionId_devInternal,
optionId_devInternalBackendCommLogVerbose,
optionId_devInternalConfigOnCallStack,
optionId_devInternalCurlInstrumCallCurl,
optionId_devInternalCurlInstrumCreateSpan,
optionId_disableInstrumentations,
optionId_disableSend,
optionId_enabled,
Expand Down Expand Up @@ -212,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 @@ -267,6 +275,9 @@ 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"

#define ELASTIC_APM_CFG_OPT_NAME_DISABLE_INSTRUMENTATIONS "disable_instrumentations"
#define ELASTIC_APM_CFG_OPT_NAME_DISABLE_SEND "disable_send"
Expand Down
3 changes: 3 additions & 0 deletions agent/native/ext/ConfigSnapshot.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ struct ConfigSnapshot
bool captureErrors = false;
String devInternal = nullptr;
bool devInternalBackendCommLogVerbose = false;
bool devInternalConfigOnCallStack = false;
bool devInternalCurlInstrumCallCurl = true;
bool devInternalCurlInstrumCreateSpan = true;
String disableInstrumentations = nullptr;
bool disableSend = false;
bool enabled = false;
Expand Down
3 changes: 3 additions & 0 deletions agent/native/ext/elastic_apm.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,9 @@ 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 )
ELASTIC_APM_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_DISABLE_SEND )
ELASTIC_APM_NOT_RELOADABLE_INI_ENTRY( ELASTIC_APM_CFG_OPT_NAME_ENABLED )
Expand Down
23 changes: 18 additions & 5 deletions agent/native/ext/lifecycle.cpp
View file
Open in desktop
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
Loading
Loading