Merge pull request #106 from scoutapp/elasticsearch-8-support

Elasticsearch 8 support

Author: asgrim

.github/workflows/ci-build.yaml

@@ -9,9 +9,14 @@ jobs:
     name: "PHPT Tests"
     services:
       elasticsearch:
-        image: elasticsearch:7.13.1
+        image: elasticsearch:8.1.2
         env:
           discovery.type: single-node
+          # Disable TLS which is on by default now: https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html
+          xpack.security.enabled: false
+          xpack.security.enrollment.enabled: false
+          xpack.security.http.ssl.enabled: false
+          xpack.security.transport.ssl.enabled: false
         ports:
           - 9200:9200
       memcached:

package.xml

@@ -84,11 +84,12 @@
                 <file name="014-predis-support.phpt" role="test" />
                 <file name="015-phpredis-support.phpt" role="test" />
                 <file name="016-memcached-support.phpt" role="test" />
-                <file name="017-elastic-support.phpt" role="test" />
+                <file name="017-elastic-7-support.phpt" role="test" />
                 <file name="018-do-not-instrument-by-default.phpt" role="test" />
                 <file name="019-url-method-capture-fgc.phpt" role="test" />
                 <file name="020-url-method-capture-curl-post.phpt" role="test" />
                 <file name="021-url-method-capture-curl-customreq.phpt" role="test" />
+                <file name="022-elastic-8-support.phpt" role="test" />
                 <file name="bug-47.phpt" role="test" />
                 <file name="bug-49.phpt" role="test" />
                 <file name="bug-55.phpt" role="test" />

scout_execute_ex.c

@@ -42,6 +42,10 @@ int setup_functions_for_zend_execute_ex()
     ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elasticsearch\\Client->get");
     ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elasticsearch\\Client->search");
     ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elasticsearch\\Client->delete");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->index");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->get");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->search");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->delete");
 #endif
 
     return SUCCESS;

scout_observer.c

@@ -39,6 +39,10 @@ int setup_functions_for_observer_api()
     ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elasticsearch\\Client->get");
     ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elasticsearch\\Client->search");
     ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elasticsearch\\Client->delete");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->index");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->get");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->search");
+    ADD_FUNCTION_TO_INSTRUMENTATION_SAFE_CATCH("Elastic\\Elasticsearch\\Client->delete");
 #endif
 
     return SUCCESS;

tests/017-elastic-support.phpt renamed to tests/017-elastic-7-support.phpt

@@ -0,0 +1,89 @@
+--TEST--
+Elasticsearch userland functions are supported
+--SKIPIF--
+<?php
+if (!extension_loaded("scoutapm")) die("skip scoutapm extension required.");
+if (!extension_loaded("curl")) die("skip Elasticsearch needs the curl extension.");
+if (shell_exec("which composer") === null) die("skip composer not found in path.");
+
+$out = null;
+$result = null;
+exec("mkdir -p /tmp/scout_elastic_test && cd /tmp/scout_elastic_test && composer require -n elasticsearch/elasticsearch:^8.0", $out, $result);
+
+if ($result !== 0) {
+  die("skip composer failed: " . implode(", ", $out));
+}
+
+if (!getenv('CI')) {
+    require "/tmp/scout_elastic_test/vendor/autoload.php";
+
+    // Check Elasticsearch is running & can connect to it
+    /* Run with:
+docker run --rm --name elasticsearch \
+  -p 9200:9200 \
+  -e discovery.type=single-node \
+  -e xpack.security.enabled=false \
+  -e xpack.security.enrollment.enabled=false \
+  -e xpack.security.http.ssl.enabled=false \
+  -e xpack.security.transport.ssl.enabled=false \
+  elasticsearch:8.1.2
+    */
+    $client = \Elastic\Elasticsearch\ClientBuilder::create()
+        ->setHosts(['localhost:9200'])
+        ->build();
+    try {
+        $client->search([]);
+    } catch (\Elastic\Elasticsearch\Common\Exceptions\NoNodesAvailableException $e) {
+      die("skip " . $e->getMessage());
+    }
+}
+?>
+--FILE--
+<?php
+
+echo implode("\n", array_intersect(
+    [
+        'Elastic\Elasticsearch\Client->index',
+        'Elastic\Elasticsearch\Client->get',
+        'Elastic\Elasticsearch\Client->search',
+        'Elastic\Elasticsearch\Client->delete',
+    ],
+    scoutapm_list_instrumented_functions()
+)) . "\n";
+scoutapm_enable_instrumentation(true);
+
+require "/tmp/scout_elastic_test/vendor/autoload.php";
+
+$client = \Elastic\Elasticsearch\ClientBuilder::create()
+    ->setHosts(['localhost:9200'])
+    ->build();
+
+$client->index(['index' => 'my_index', 'id' => 'my_id', 'body' => ['testField' => 'abc']]);
+$client->get(['index' => 'my_index', 'id' => 'my_id']);
+$client->search(['index' => 'my_index', 'body' => ['query' => ['match' => ['testField' => 'abc']]]]);
+$client->delete(['index' => 'my_index', 'id' => 'my_id']);
+
+$calls = scoutapm_get_calls();
+
+var_dump(array_column($calls, 'function'));
+
+?>
+--CLEAN--
+<?php
+shell_exec("rm -Rf /tmp/scout_elastic_test");
+?>
+--EXPECTF--
+Elastic\Elasticsearch\Client->index
+Elastic\Elasticsearch\Client->get
+Elastic\Elasticsearch\Client->search
+Elastic\Elasticsearch\Client->delete
+array(%d) {
+  [%d]=>
+  string(%d) "Elastic\Elasticsearch\Client->index"
+  [%d]=>
+  string(%d) "Elastic\Elasticsearch\Client->get"
+  [%d]=>
+  string(%d) "Elastic\Elasticsearch\Client->search"
+  [%d]=>
+  string(%d) "Elastic\Elasticsearch\Client->delete"
+}