feat(agent): add supportability metric for laravel horizon and queue (#1132)

This PR does the following:

- Wrap `Laravel\Horizon\Console\WorkCommand` to check if Laravel Horizon
is being used and if it is, then set `is_horizon_used` global flag to
`true`.
- Check value of `is_horizon_used` flag which will determine what
supportability metric is sent.
(`Supportability/library/Laravel/Horizon/used` or
`Supportability/library/Laravel/Queue/used`)

Author: hahuja2

agent/fw_laravel.c

@@ -1221,6 +1221,17 @@ NR_PHP_WRAPPER(nr_laravel_queue_restart_transaction) {
 }
 NR_PHP_WRAPPER_END
 
+/*
+ * Set global flag that checks if Laravel Horizon is being used to true.
+ */
+NR_PHP_WRAPPER(nr_laravel_horizon_is_used) {
+  NR_UNUSED_SPECIALFN;
+  (void)wraprec;
+
+  NR_PHP_PROCESS_GLOBALS(laravel_horizon_worker_used) = true;
+}
+NR_PHP_WRAPPER_END
+
 void nr_laravel_enable(TSRMLS_D) {
   /*
    * We set the path to 'unknown' to prevent having to name routing errors.
@@ -1272,7 +1283,12 @@ void nr_laravel_enable(TSRMLS_D) {
   nr_php_wrap_user_function_before_after_clean(
       NR_PSTR("Laravel\\Horizon\\Console\\SupervisorCommand::handle"),
       nr_laravel_horizon_end_txn, NULL, NULL);
-
+  /*
+   * Check if Laravel Horizon is being used.
+   */
+  nr_php_wrap_user_function_before_after_clean(
+      NR_PSTR("Laravel\\Horizon\\Console\\WorkCommand::handle"),
+      nr_laravel_horizon_is_used, NULL, NULL);
   /*
    * The following function has been added to ensure idle laravel queue workers
    * are properly handled by ending the current transaction and starting a new

agent/fw_laravel_queue.c

@@ -6,6 +6,7 @@
 #include "php_api_distributed_trace.h"
 #include "php_call.h"
 #include "php_error.h"
+#include "php_globals.h"
 #include "php_hash.h"
 #include "php_user_instrument.h"
 #include "php_wrapper.h"
@@ -294,6 +295,13 @@ NR_PHP_WRAPPER(nr_laravel_queue_worker_raiseBeforeJobEvent_before) {
   nr_txn_set_path("Laravel", NRPRG(txn), txn_name, NR_PATH_TYPE_CUSTOM,
                   NR_OK_TO_OVERWRITE);
 
+  if (NR_PHP_PROCESS_GLOBALS(laravel_horizon_worker_used)) {
+    nrm_force_add(NRPRG(txn) ? NRPRG(txn)->unscoped_metrics : 0,
+                  "Supportability/library/Laravel/Horizon/used", 0);
+  } else {
+    nrm_force_add(NRPRG(txn) ? NRPRG(txn)->unscoped_metrics : 0,
+                  "Supportability/library/Laravel/Queue/used", 0);
+  }
   nr_free(txn_name);
   nr_php_arg_release(&job);
   NR_PHP_WRAPPER_CALL;

agent/php_globals.h

@@ -80,6 +80,7 @@ typedef struct _nrphpglobals_t {
                                               enabled */
   nr_composer_api_status_t composer_api_status; /* Composer API's status */
   char* docker_id; /* 64 byte hex docker ID parsed from /proc/self/mountinfo */
+  bool laravel_horizon_worker_used; /* Set to true if Laravel Horizon is used */
 
   /* Original PHP callback pointer contents */
   nrphperrfn_t orig_error_cb;