-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #944 from newrelic/dev
Release 11.0
- Loading branch information
Showing
42 changed files
with
812 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 10.22.0 | ||
| 11.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| /* | ||
| * Copyright 2024 New Relic Corporation. All rights reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| /* | ||
| * Functions relating to instrumenting the AWS-SDK-PHP. | ||
| * https://github.com/aws/aws-sdk-php | ||
| */ | ||
| #include "php_agent.h" | ||
| #include "php_call.h" | ||
| #include "php_hash.h" | ||
| #include "php_wrapper.h" | ||
| #include "fw_hooks.h" | ||
| #include "fw_support.h" | ||
| #include "util_logging.h" | ||
| #include "lib_aws_sdk_php.h" | ||
|
|
||
| #define PHP_PACKAGE_NAME "aws/aws-sdk-php" | ||
|
|
||
| /* | ||
| * In a normal course of events, the following line will always work | ||
| * zend_eval_string("Aws\\Sdk::VERSION;", &retval, "Get AWS Version") | ||
| * By the time we have detected the existence of the aws-sdk-php and with | ||
| * default composer profject settings, it callable even from | ||
| * nr_aws_sdk_php_enable which will automatically load the class if it isn't | ||
| * loaded yet and then evaluate the string. However, in the rare case that files | ||
| * are not loaded via autoloader and/or have non-default composer classload | ||
| * settings, if the class is not found, PHP 8.2+ will generate a fatal | ||
| * unrecoverable uncatchable error error whenever it cannot find a class. While | ||
| * calling this from nr_aws_sdk_php_enable would have been great and would allow | ||
| * the sdk version value to be set only once, to avoid the very unlikely but not | ||
| * impossible fatal error, this will be called from the | ||
| * "Aws\\ClientResolver::_apply_user_agent" wrapper which GUARANTEES that | ||
| * aws/sdk exists and is already loaded. | ||
| * | ||
| * | ||
| * Additionally given that aws-sdk-php is currently detected from the | ||
| * AwsClient.php file, this method will always be called when a client is | ||
| * created unlike Sdk::construct which doesn't show with PHP 8.2+. | ||
| * | ||
| * Using Aws/Sdk::__construct for version is currently nonviable as it is | ||
| * unreliable as a version determiner. | ||
| * Having separate functionality to extract from Aws/Sdk::__construct | ||
| * is both not required and is redundant and causes additional overhead and | ||
| * so only one function is needed to extract version. | ||
| * | ||
| * Aws\\ClientResolver::_apply_user_agent a reliable function as it is | ||
| * always called on client initialization since it is key to populating | ||
| * the request headers, and it loads Sdk by default. | ||
| * | ||
| * Concerns about future/past proofing to the checking prioritized the following | ||
| * implementation vs using the eval method. | ||
| */ | ||
| void nr_lib_aws_sdk_php_handle_version() { | ||
| zval* zval_version = NULL; | ||
| zend_class_entry* class_entry = NULL; | ||
| char* version = NULL; | ||
|
|
||
| class_entry = nr_php_find_class("aws\\sdk"); | ||
| if (NULL != class_entry) { | ||
| zval_version = nr_php_get_class_constant(class_entry, "VERSION"); | ||
|
|
||
| if (nr_php_is_zval_non_empty_string(zval_version)) { | ||
| version = Z_STRVAL_P(zval_version); | ||
| } | ||
| } | ||
| if (NRINI(vulnerability_management_package_detection_enabled)) { | ||
| /* Add php package to transaction */ | ||
| nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version); | ||
| } | ||
| nr_fw_support_add_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME, | ||
| version); | ||
| nr_php_zval_free(&zval_version); | ||
| } | ||
|
|
||
| void nr_lib_aws_sdk_php_add_supportability_service_metric( | ||
| const char* service_name) { | ||
| /* total MAX metric name length per agent-specs */ | ||
| char buf[MAX_METRIC_NAME_LEN]; | ||
| char* cp = NULL; | ||
|
|
||
| if (nr_strempty(service_name)) { | ||
| return; | ||
| } | ||
| if (NULL == NRPRG(txn)) { | ||
| return; | ||
| } | ||
|
|
||
| cp = buf; | ||
| strcpy(cp, PHP_AWS_SDK_SERVICE_NAME_METRIC_PREFIX); | ||
| cp += PHP_AWS_SDK_SERVICE_NAME_METRIC_PREFIX_LEN - 1; | ||
| strlcpy(cp, service_name, MAX_AWS_SERVICE_NAME_LEN); | ||
| nrm_force_add(NRPRG(txn) ? NRTXN(unscoped_metrics) : 0, buf, 0); | ||
| } | ||
|
|
||
| NR_PHP_WRAPPER(nr_create_aws_sdk_version_metrics) { | ||
| (void)wraprec; | ||
| NR_PHP_WRAPPER_CALL; | ||
| nr_lib_aws_sdk_php_handle_version(); | ||
| } | ||
| NR_PHP_WRAPPER_END | ||
|
|
||
| /* | ||
| * AwsClient::parseClass | ||
| * This is called from the base AwsClient class for every client associated | ||
| * with a service during client initialization. | ||
| * parseClass already computes the service name for internal use, so we don't | ||
| * need to store it, we just need to snag it from the return value as it goes | ||
| * through the client initialization process. | ||
| */ | ||
| NR_PHP_WRAPPER(nr_create_aws_service_metric) { | ||
| (void)wraprec; | ||
|
|
||
| zval** ret_val_ptr = NULL; | ||
| ret_val_ptr = NR_GET_RETURN_VALUE_PTR; | ||
|
|
||
| NR_PHP_WRAPPER_CALL; | ||
|
|
||
| if (NULL != ret_val_ptr && nr_php_is_zval_valid_array(*ret_val_ptr)) { | ||
| /* obtain ret_val_ptr[0] which contains the service name */ | ||
| zval* service_name | ||
| = nr_php_zend_hash_index_find(Z_ARRVAL_P(*ret_val_ptr), 0); | ||
| if (nr_php_is_zval_non_empty_string(service_name)) { | ||
| nr_lib_aws_sdk_php_add_supportability_service_metric( | ||
| Z_STRVAL_P(service_name)); | ||
| } | ||
| } | ||
| } | ||
| NR_PHP_WRAPPER_END | ||
|
|
||
| /* | ||
| * The ideal file to begin immediate detection of the aws-sdk is: | ||
| * aws-sdk-php/src/functions.php | ||
| * Unfortunately, Php8.2+ and composer autoload leads to the | ||
| * file being optimized directly and not loaded. | ||
| * | ||
| * Options considered: | ||
| * | ||
| * 1. for PHP8.2, and only optimizable libraries, when encountering autoload.php | ||
| * files, ask the file what includes it added and check against only the | ||
| * optimizable library. Small overhead incurred when encountering an autoload | ||
| * file, but detects aws-sdk-php immediately before any sdk code executes | ||
| * (changes needed for this are detailed in the original PR) | ||
| * 2. use a file that gets called later and only when AwsClient.php file file is | ||
| * called. It's called later and we'll miss some instrumentation, but if we're | ||
| * only ever going to be interested in Client calls anyway, maybe that's ok? | ||
| * Doesn't detect Sdk.php (optimized out) so when customers only use that or | ||
| * when they use it first, we will not instrument it. This only detects when a | ||
| * Client is called to use a service so potentially misses out on other | ||
| * instrumentation and misses out when customers use the aws-sdk-php but use | ||
| * non-SDK way to interact with the service (possibly with redis/memcached). | ||
| * This way is definitely the least complex and lowest overhead and less | ||
| * complexity means lower risk as well. | ||
| * 3. Directly add the wrappers to the hash map. With potentially 50ish clients | ||
| * to wrap, this will add overhead to every hash map lookup. Currently | ||
| * implemented option is 2, use the AwsClient.php as this is our main focus. | ||
| * This means until a call to an Aws/AwsClient function, | ||
| * all calls including aws\sdk calls are ignored. Version detection will be | ||
| * tied to Aws/ClientResolver::_apply_user_agent which is ALWAYS called when | ||
| * dealing with aws clients. It will not be computed from | ||
| * Aws/Sdk::__constructor which would at best be duplicate info and worst would | ||
| * never be ignored until a client is called. | ||
| */ | ||
| void nr_aws_sdk_php_enable() { | ||
| /* This will be used to extract the version. */ | ||
| nr_php_wrap_user_function(NR_PSTR("Aws\\ClientResolver::_apply_user_agent"), | ||
| nr_create_aws_sdk_version_metrics); | ||
| /* Called when initializing all other Clients */ | ||
| nr_php_wrap_user_function(NR_PSTR("Aws\\AwsClient::parseClass"), | ||
| nr_create_aws_service_metric); | ||
|
|
||
| if (NRINI(vulnerability_management_package_detection_enabled)) { | ||
| nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, | ||
| PHP_PACKAGE_VERSION_UNKNOWN); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /* | ||
| * Copyright 2024 New Relic Corporation. All rights reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Functions relating to instrumenting AWS-SDK-PHP. | ||
| */ | ||
| #ifndef LIB_AWS_SDK_PHP_HDR | ||
| #define LIB_AWS_SDK_PHP_HDR | ||
|
|
||
| #define PHP_AWS_SDK_SERVICE_NAME_METRIC_PREFIX \ | ||
| "Supportability/PHP/AWS/Services/" | ||
| #define MAX_METRIC_NAME_LEN 256 | ||
| #define PHP_AWS_SDK_SERVICE_NAME_METRIC_PREFIX_LEN \ | ||
| sizeof(PHP_AWS_SDK_SERVICE_NAME_METRIC_PREFIX) | ||
| #define MAX_AWS_SERVICE_NAME_LEN \ | ||
| (MAX_METRIC_NAME_LEN - PHP_AWS_SDK_SERVICE_NAME_METRIC_PREFIX_LEN) | ||
|
|
||
| extern void nr_aws_sdk_php_enable(); | ||
| extern void nr_lib_aws_sdk_php_handle_version(); | ||
| extern void nr_lib_aws_sdk_php_add_supportability_service_metric( | ||
| const char* service_name); | ||
|
|
||
| #endif /* LIB_AWS_SDK_PHP_HDR */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.