Skip to content

Commit 2df782f

Browse files
zsistlazsistla
committed
feat(agent): Add RabbitMQ instrumentation using the php-amqplib library
Initial commit does the following: * Detect library via magic file * Detect package and version information. * Basic unit tests
1 parent 996dcc9 commit 2df782f

7 files changed

+212
-1
lines changed

‎agent/Makefile.frag

+1
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ TEST_BINARIES = \
9393
tests/test_internal_instrument \
9494
tests/test_hash \
9595
tests/test_lib_aws_sdk_php \
96+
tests/test_lib_php_ampqlib \
9697
tests/test_memcached \
9798
tests/test_mongodb \
9899
tests/test_monolog \

‎agent/config.m4

+1-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ if test "$PHP_NEWRELIC" = "yes"; then
231231
LIBRARIES="lib_aws_sdk_php.c lib_monolog.c lib_doctrine2.c lib_guzzle3.c \
232232
lib_guzzle4.c lib_guzzle6.c lib_guzzle_common.c \
233233
lib_mongodb.c lib_phpunit.c lib_predis.c lib_zend_http.c \
234-
lib_composer.c"
234+
lib_composer.c lib_php_amqplib.c"
235235
PHP_NEW_EXTENSION(newrelic, $FRAMEWORKS $LIBRARIES $NEWRELIC_AGENT, $ext_shared,, $(NEWRELIC_CFLAGS))
236236

237237
PHP_SUBST(NEWRELIC_CFLAGS)

‎agent/fw_hooks.h

+1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ extern void nr_guzzle4_enable(TSRMLS_D);
4646
extern void nr_guzzle6_enable(TSRMLS_D);
4747
extern void nr_laminas_http_enable(TSRMLS_D);
4848
extern void nr_mongodb_enable(TSRMLS_D);
49+
extern void nr_php_amqplib_enable();
4950
extern void nr_phpunit_enable(TSRMLS_D);
5051
extern void nr_predis_enable(TSRMLS_D);
5152
extern void nr_zend_http_enable(TSRMLS_D);

‎agent/lib_php_amqplib.c

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/*
2+
* Copyright 2024 New Relic Corporation. All rights reserved.
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
/*
7+
* Functions relating to instrumenting the AWS-SDK-PHP.
8+
* https://github.com/aws/aws-sdk-php
9+
*/
10+
#include "php_agent.h"
11+
#include "php_call.h"
12+
#include "php_hash.h"
13+
#include "php_wrapper.h"
14+
#include "fw_hooks.h"
15+
#include "fw_support.h"
16+
#include "util_logging.h"
17+
#include "lib_php_amqplib.h"
18+
19+
#define PHP_PACKAGE_NAME "php-amqplib/php-amqplib"
20+
21+
/*
22+
* nr_php_amqplib_handle_version will automatically load the class if it isn't
23+
* loaded yet and then evaluate the string. To avoid the VERY unlikely but not
24+
* impossible fatal error if the file/class isn't loaded yet, we need to wrap
25+
* the call in a try/catch block and make it a lambda so that we avoid fatal
26+
* errors.
27+
*/
28+
void nr_php_amqplib_handle_version() {
29+
char* version = NULL;
30+
zval retval;
31+
int result = FAILURE;
32+
33+
result = zend_eval_string(
34+
"(function() {"
35+
" $nr_php_amqplib_version = '';"
36+
" try {"
37+
" $nr_php_amqplib_version = PhpAmqpLib\\Package::VERSION;"
38+
" } catch (Throwable $e) {"
39+
" }"
40+
" return $nr_php_amqplib_version;"
41+
"})();",
42+
&retval, "Get nr_php_amqplib_version");
43+
44+
/* See if we got a non-empty/non-null string for version. */
45+
if (SUCCESS == result) {
46+
if (nr_php_is_zval_non_empty_string(&retval)) {
47+
version = Z_STRVAL(retval);
48+
}
49+
}
50+
51+
if (NRINI(vulnerability_management_package_detection_enabled)) {
52+
/* Add php package to transaction */
53+
nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
54+
}
55+
56+
nr_txn_suggest_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
57+
version);
58+
59+
zval_dtor(&retval);
60+
}
61+
62+
/*
63+
*
64+
* Version detection will be called directly from Aws\Sdk.php
65+
*/
66+
void nr_php_amqplib_enable() {
67+
/*
68+
* Set the UNKNOWN package first, so it doesn't overwrite what we find with
69+
* nr_lib_aws_sdk_php_handle_version.
70+
*/
71+
if (NRINI(vulnerability_management_package_detection_enabled)) {
72+
nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME,
73+
PHP_PACKAGE_VERSION_UNKNOWN);
74+
}
75+
76+
/* Extract the version for aws-sdk 3+ */
77+
nr_php_amqplib_handle_version();
78+
79+
/* Called when initializing all Clients */
80+
// nr_php_wrap_user_function(NR_PSTR("Aws\\AwsClient::parseClass"),
81+
// nr_create_aws_service_metric);
82+
}

‎agent/lib_php_amqplib.h

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
/*
2+
* Copyright 2024 New Relic Corporation. All rights reserved.
3+
* SPDX-License-Identifier: Apache-2.0
4+
*
5+
* Functions relating to instrumenting AWS-SDK-PHP.
6+
*/
7+
#ifndef LIB_PHP_AMQPLIB
8+
#define LIB_PHP_AMQPLIB
9+
10+
extern void nr_aws_php_amqplib_enable();
11+
extern void nr_php_amqplib_handle_version();
12+
13+
#endif /* LIB_PHP_AMQPLIB */

‎agent/php_execute.c

+4
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,10 @@ static nr_library_table_t libraries[] = {
491491

492492
{"MongoDB", NR_PSTR("mongodb/src/client.php"), nr_mongodb_enable},
493493

494+
/* php-amqplib RabbitMQ >= 3.7 */
495+
{"php-amqplib", NR_PSTR("phpamqplib/connection/abstractconnection.php"),
496+
nr_php_amqplib_enable},
497+
494498
/*
495499
* The first path is for Composer installs, the second is for
496500
* /usr/local/bin.

‎agent/tests/test_lib_php_amqplib.c

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
/*
2+
* Copyright 2024 New Relic Corporation. All rights reserved.
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
#include "tlib_php.h"
7+
8+
#include "php_agent.h"
9+
#include "lib_php_amqplib.h"
10+
#include "fw_support.h"
11+
12+
tlib_parallel_info_t parallel_info
13+
= {.suggested_nthreads = -1, .state_size = 0};
14+
15+
#if ZEND_MODULE_API_NO > ZEND_7_1_X_API_NO
16+
17+
static void declare_php_amqplib_package_class(const char* ns,
18+
const char* klass,
19+
const char* sdk_version) {
20+
char* source = nr_formatf(
21+
"namespace %s;"
22+
"class %s{"
23+
"const VERSION = '%s';"
24+
"}",
25+
ns, klass, sdk_version);
26+
27+
tlib_php_request_eval(source);
28+
29+
nr_free(source);
30+
}
31+
32+
static void test_nr_lib_php_amqplib_handle_version(void) {
33+
#define LIBRARY_NAME "php-amqplib/php-amqplib"
34+
const char* library_versions[]
35+
= {"7", "10", "100", "4.23", "55.34", "6123.45", "0.4.5"};
36+
nr_php_package_t* p = NULL;
37+
#define TEST_DESCRIPTION_FMT \
38+
"nr_lib_php_amqplib_handle_version with library_versions[%ld]=%s: package " \
39+
"major version metric - %s"
40+
char* test_description = NULL;
41+
size_t i = 0;
42+
43+
/*
44+
* If lib_php_amqplib_handle_version function is ever called, we have already
45+
* detected the php-amqplib library.
46+
*/
47+
48+
/*
49+
* PhpAmqpLib/Package class exists. Should create php-amqplib package metric
50+
* suggestion with version
51+
*/
52+
for (i = 0; i < sizeof(library_versions) / sizeof(library_versions[0]); i++) {
53+
tlib_php_request_start();
54+
55+
declare_php_amqplib_package_class("PhpAmqpLib", "Package",
56+
library_versions[i]);
57+
nr_lib_php_amqplib_handle_version();
58+
59+
p = nr_php_packages_get_package(
60+
NRPRG(txn)->php_package_major_version_metrics_suggestions,
61+
LIBRARY_NAME);
62+
63+
test_description = nr_formatf(TEST_DESCRIPTION_FMT, i, library_versions[i],
64+
"suggestion created");
65+
tlib_pass_if_not_null(test_description, p);
66+
nr_free(test_description);
67+
68+
test_description = nr_formatf(TEST_DESCRIPTION_FMT, i, library_versions[i],
69+
"suggested version set");
70+
tlib_pass_if_str_equal(test_description, library_versions[i],
71+
p->package_version);
72+
nr_free(test_description);
73+
74+
tlib_php_request_end();
75+
}
76+
77+
/*
78+
* PhpAmqpLib/Package class does not exist, should create package metric
79+
* suggestion with PHP_PACKAGE_VERSION_UNKNOWN version. This case should never
80+
* happen in real situations.
81+
*/
82+
tlib_php_request_start();
83+
84+
nr_lib_php_amqplib_handle_version();
85+
86+
p = nr_php_packages_get_package(
87+
NRPRG(txn)->php_package_major_version_metrics_suggestions, LIBRARY_NAME);
88+
89+
tlib_pass_if_not_null(
90+
"nr_lib_php_amqplib_handle_version when PhpAmqpLib\\Package class is not "
91+
"defined - "
92+
"suggestion created",
93+
p);
94+
tlib_pass_if_str_equal(
95+
"nr_lib_php_amqplib_handle_version when PhpAmqpLib\\Package class is not "
96+
"defined - "
97+
"suggested version set to PHP_PACKAGE_VERSION_UNKNOWN",
98+
PHP_PACKAGE_VERSION_UNKNOWN, p->package_version);
99+
100+
tlib_php_request_end();
101+
}
102+
103+
void test_main(void* p NRUNUSED) {
104+
tlib_php_engine_create("");
105+
test_nr_lib_php_amqplib_handle_version();
106+
tlib_php_engine_destroy();
107+
}
108+
#else
109+
void test_main(void* p NRUNUSED) {}
110+
#endif

0 commit comments

Comments
 (0)