feat(agent): Add RabbitMQ instrumentation using the php-amqplib library #1009

zsistla · 2025-01-21T13:23:39Z

Initial commit does the following:

Detect library via magic file
Detect package and version information.
Basic unit tests

Subsequent commits:

Add attributes needed for rabbitMQ to message segment
Instrument basic_publish and basic_get
add unit tests, multiverse tests
added support for PHP 7.x

Remaining:

More testing
Add DT headers

Initial commit does the following: * Detect library via magic file * Detect package and version information. * Basic unit tests

newrelic-php-agent-bot · 2025-01-21T13:24:10Z

Test Suite	Status	Result
Multiverse	❌	4/8 passing
SOAK	✅	72/72 passing

Initial commit does the following: * Detect library via magic file * Detect package and version information. * Basic unit tests

…ewrelic-php-agent into feat/rabbitmq_instrumentation

agent/lib_php_amqplib.c

agent/tests/test_lib_php_amqplib.c

Test version detection when class exists but version const doesn't. Fixed typos.

codecov-commenter · 2025-01-23T20:47:21Z

Codecov Report

Attention: Patch coverage is 37.05882% with 107 lines in your changes missing coverage. Please review.

Project coverage is 77.76%. Comparing base (94a41f5) to head (2335634).

Files with missing lines	Patch %	Lines
agent/lib_php_amqplib.c	10.52%	85 Missing ⚠️
axiom/nr_span_event.c	56.25%	21 Missing ⚠️
axiom/nr_segment_traces.c	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #1009      +/-   ##
==========================================
- Coverage   78.02%   77.76%   -0.26%     
==========================================
  Files         197      198       +1     
  Lines       27418    27586     +168     
==========================================
+ Hits        21392    21453      +61     
- Misses       6026     6133     +107

Flag	Coverage Δ
agent-for-php-7.2	`77.89% <37.50%> (-0.26%)`	⬇️
agent-for-php-7.3	`77.91% <37.50%> (-0.26%)`	⬇️
agent-for-php-7.4	`77.62% <37.50%> (-0.26%)`	⬇️
agent-for-php-8.0	`77.01% <38.65%> (-0.24%)`	⬇️
agent-for-php-8.1	`77.52% <38.65%> (-0.24%)`	⬇️
agent-for-php-8.2	`77.13% <38.65%> (-0.24%)`	⬇️
agent-for-php-8.3	`77.13% <38.65%> (-0.24%)`	⬇️
agent-for-php-8.4	`77.14% <38.65%> (-0.24%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

* Creates message segment on basic_publish call.

* While the RabbitMQ tutorial for using with the dockerized RabbitMQ setup * correctly and loads the PhpAmqpLib\\Channel\\AMQPChannel class in time for * the agent to wrap the instrumented functions, there are AWS MQ_BROKER * specific but valid scenarios where the PhpAmqpLib\\Channel\\AMQPChannel class * file does not explicitly load or does not load in time, and the instrumented * functions are NEVER wrapped regardless of how many times they are called in * one txn. Specifically, this centered around the very slight but impactful * differences when using the PhpAmqpLib\Connection\AMQPStreamConnection which * causes an explicit load of the AMQPChannel class/file and * PhpAmqpLib\Connection\AMQPSSLConnection which does NOT cause an explicit load * of the AMQPChannelclass/file. The following method is thus the only way to * ensure the class is loaded in time for the functions to be wrapped.

mfulb · 2025-01-30T20:37:20Z

agent/lib_php_amqplib.c

+  result = zend_eval_string(
+      "(function() {"
+      "     $nr_php_amqplib_version = '';"
+      "     try {"


I believe PHP provides tools to make sure this constant exists so it would avoid triggering an exception in the first place.

That would be doing an PHP extra call when this call already verifies and retrieves the value and is future proofed against any future exceptions. Additionally, it will automatically load the class if it's not already loaded.

mfulb · 2025-01-30T20:41:56Z

agent/lib_php_amqplib.c

+      amqp_port
+          = nr_php_zend_hash_index_find(Z_ARRVAL_P(connect_constructor_params),
+                                        AMQP_CONSTRUCT_PARAMS_PORT_INDEX);
+      if (nr_php_is_zval_valid_scalar(amqp_port)) {


This checks if it is a bool, a valid string, long or double. Are these all valid values for the port?

Good point, only allow long:
095f82d

mfulb · 2025-01-30T20:42:42Z

agent/lib_php_amqplib.c

+          = nr_php_zend_hash_index_find(Z_ARRVAL_P(connect_constructor_params),
+                                        AMQP_CONSTRUCT_PARAMS_PORT_INDEX);
+      if (nr_php_is_zval_valid_scalar(amqp_port)) {
+        message_params->server_port = Z_LVAL_P(amqp_port);


The check above does not guarantee the value is a long.

verify long: 095f82d

mfulb · 2025-01-30T20:45:17Z

agent/lib_php_amqplib.c

+     */
+    message_params.destination_name
+        = ENSURE_PERSISTENCE(Z_STRVAL_P(amqp_exchange));
+  } else {


What if ampq_exchange is not a string at all?

The parameter list for the function call dictates that exchange is a string.

Additionally, the check here guarantees it is a valid non-empty string before we set it (and strdup for php 7.x) here.

mfulb · 2025-01-30T20:52:32Z

agent/lib_php_amqplib.c

+   * strdup server_address, destination_name, and
+   * messaging_destination_routing_key.
+   */
+  nr_free(message_params.server_address);


I think it could be cleaner to have a matching macro to ENSURE_PERSISTENCE that could be used to un-persist these values in the appropriate way for the PHP is use.

Great idea!
71e5e02

mfulb · 2025-01-30T20:54:12Z

agent/lib_php_amqplib.c

+       * Default in case of empty string. */
+      message_params.messaging_destination_publish_name
+          = Z_STRVAL_P(amqp_exchange);
+    } else {


What if ampq_exchange is not a string? (This applies to this pattern in any wrappers in this PR).

The function param list and/or class definition dictates strings or not.
nr_php_is_zval_non_empty_string verifies that the value is not null, is not empty, and is a zval string. Only after that do we do anything with it.

mfulb · 2025-01-30T21:03:06Z

agent/lib_php_amqplib.c

+
+  /* Extract the version for aws-sdk 3+ */
+  nr_php_amqplib_handle_version();
+  nr_php_amqplib_ensure_class();


I am concerned on how this all works - if the file used to trigger this enable function is, for example, in a sequence of PHP calls that was in response to autoloading the class we need, and inside this sequence we start another sequence to load this class - is composer setup to handle this?

Is there not a file we can use in the situations this class is not triggered (the AWS context I guess?).

No. None of the files (autoload files or files in general that get loaded through the course of the test case) can cause this class to be loaded in order to wrap the function properly during AWS test cases. This is different behavior from the rabbitmq server used with multiverse so the difference is either due to the slight variance in making an SSL connection or due to the older rabbitmq engine that is running in AWS. None of the files that loaded when running AWS tests worked to allow our instrumentation to be wrapped (different than the non-ssl, non-aws rabbitmq server which actually loaded the file as well as the class).

All this is doing is calling class_exists so pretty innocuous. This is a php function which other functions can call in the middle of their logic and have easily handled as well. It's analogous to function calls that make calls to other classes. If you turn the show_* on, classes get loaded inside classes all the time because unless the file is loaded previously, the class doesn't actually get loaded until it's used.

Yes composer can handle it. That change was enough to finally get the functions wrapped for AWS setups, and the segments were created and made it to the backend with appropriate attributes.

feat(agent): Add RabbitMQ instrumentation using the php-amqplib library

2df782f

Initial commit does the following: * Detect library via magic file * Detect package and version information. * Basic unit tests

feat(agent): Add RabbitMQ instrumentation using the php-amqplib library

0b184ca

Initial commit does the following: * Detect library via magic file * Detect package and version information. * Basic unit tests

zsistla force-pushed the feat/rabbitmq_instrumentation branch from 2df782f to 0b184ca Compare January 22, 2025 23:01

Merge branch 'feat/rabbitmq_instrumentation' of github.com:newrelic/n…

3e7dc66

…ewrelic-php-agent into feat/rabbitmq_instrumentation

mfulb reviewed Jan 23, 2025

View reviewed changes

agent/lib_php_amqplib.c Show resolved Hide resolved

mfulb reviewed Jan 23, 2025

View reviewed changes

agent/lib_php_amqplib.c Outdated Show resolved Hide resolved

fix(agent): Typo remove AWS references

feba725

mfulb reviewed Jan 23, 2025

View reviewed changes

agent/tests/test_lib_php_amqplib.c Show resolved Hide resolved

zsistla added 2 commits January 23, 2025 13:10

fix(agent): typo

feef4be

feat(agent): Add additional unit test

761de36

Test version detection when class exists but version const doesn't. Fixed typos.

zsistla added 2 commits January 23, 2025 13:49

chore(agent): Clarifying comment.

80be7a5

feat(axiom): Update message segment to handle rabbitmq

b50a5d2

zsistla added this to the next-release milestone Jan 27, 2025

zsistla added 5 commits January 28, 2025 18:37

feat(agent): Add php_amqplib basic_publish instrumentation.

075e297

* Creates message segment on basic_publish call.

fix(axiom): Handle final metrix/txn naming when publish_name exists.

f106a20

feat(agent): Add php_libamqp basic_get instrumentation.

631ae54

fix(tests): Update tests to understand the precedence of publish_name

f3502b5

mfulb reviewed Jan 30, 2025

View reviewed changes

zsistla added 3 commits January 30, 2025 17:43

fix(agent): check long not scalar

095f82d

fix(agent): add an unperist macro

71e5e02

Merge branch 'dev' into feat/rabbitmq_instrumentation

2335634

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(agent): Add RabbitMQ instrumentation using the php-amqplib library #1009

feat(agent): Add RabbitMQ instrumentation using the php-amqplib library #1009

zsistla commented Jan 21, 2025 •

edited

Loading

newrelic-php-agent-bot commented Jan 21, 2025 •

edited

Loading

codecov-commenter commented Jan 23, 2025 •

edited

Loading

mfulb Jan 30, 2025

zsistla Jan 31, 2025

mfulb Jan 30, 2025

zsistla Jan 31, 2025

mfulb Jan 30, 2025

zsistla Jan 31, 2025

mfulb Jan 30, 2025

zsistla Jan 31, 2025

mfulb Jan 30, 2025

zsistla Jan 31, 2025

mfulb Jan 30, 2025

zsistla Jan 31, 2025

mfulb Jan 30, 2025

zsistla Jan 31, 2025 •

edited

Loading

feat(agent): Add RabbitMQ instrumentation using the php-amqplib library #1009

Are you sure you want to change the base?

feat(agent): Add RabbitMQ instrumentation using the php-amqplib library #1009

Conversation

zsistla commented Jan 21, 2025 • edited Loading

newrelic-php-agent-bot commented Jan 21, 2025 • edited Loading

codecov-commenter commented Jan 23, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zsistla Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

zsistla commented Jan 21, 2025 •

edited

Loading

newrelic-php-agent-bot commented Jan 21, 2025 •

edited

Loading

codecov-commenter commented Jan 23, 2025 •

edited

Loading

zsistla Jan 31, 2025 •

edited

Loading