Merge pull request #287 from scoutapp/fix-mongo-db-ignoring-monitorin…

…g-disabled-config Only enable MongoDB collector if monitoring is enabled
scoutapp · Sep 26, 2022 · b6c96e1 · b6c96e1
2 parents 0bdd3ab + e147cbb
commit b6c96e1
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 16 deletions.
diff --git a/known-issues.xml b/known-issues.xml
@@ -150,6 +150,12 @@
     </MixedInferredReturnType>
     <MixedReturnStatement occurrences="1"/>
   </file>
+  <file src="tests/Integration/AgentTest.php">
+    <DeprecatedMethod occurrences="2">
+      <code>getEvents</code>
+      <code>getRequest</code>
+    </DeprecatedMethod>
+  </file>
   <file src="tests/Integration/CheckScoutApmKeyListener.php">
     <DeprecatedInterface occurrences="1">
       <code>CheckScoutApmKeyListener</code>

diff --git a/src/Agent.php b/src/Agent.php
@@ -118,10 +118,10 @@ private function __construct(
         if ($this->config->get(ConfigKey::MONITORING_ENABLED)) {
             $this->warnIfConfigValueIsNotSet(ConfigKey::APPLICATION_NAME);
             $this->warnIfConfigValueIsNotSet(ConfigKey::APPLICATION_KEY);
-        }
 
-        if (extension_loaded('mongodb')) {
-            QueryTimeCollector::register($this);
+            if (extension_loaded('mongodb')) {
+                QueryTimeCollector::register($this);
+            }
         }
 
         $this->startNewRequest();

diff --git a/src/MongoDB/QueryTimeCollector.php b/src/MongoDB/QueryTimeCollector.php
@@ -47,12 +47,13 @@ public function commandStarted(CommandStartedEvent $event): void
     {
         $activeSpan = $this->agent->startSpan('Mongo/Query/' . $event->getCommandName());
 
-        if ($activeSpan !== null) {
-            $activeSpan->tag('db', $event->getDatabaseName());
-            $activeSpan->tag('operationId', $event->getOperationId());
-            $activeSpan->tag('requestId', $event->getRequestId());
+        if ($activeSpan === null) {
+            return;
         }
-//        echo serialize($event);
+
+        $activeSpan->tag('db', $event->getDatabaseName());
+        $activeSpan->tag('operationId', $event->getOperationId());
+        $activeSpan->tag('requestId', $event->getRequestId());
     }
 
     public function commandSucceeded(CommandSucceededEvent $event): void

diff --git a/tests/Integration/AgentTest.php b/tests/Integration/AgentTest.php
@@ -122,15 +122,17 @@ private function setUpWithConfiguration(Config $config): void
 
         $this->agent = Agent::fromConfig($config, $this->logger, null, $this->connector);
 
-        $retryCount = 0;
-        while ($retryCount < 5 && ! $this->connector->connected()) {
-            $this->agent->connect();
-            sleep(1);
-            $retryCount++;
-        }
+        if ($config->get(ConfigKey::MONITORING_ENABLED)) {
+            $retryCount = 0;
+            while ($retryCount < 5 && ! $this->connector->connected()) {
+                $this->agent->connect();
+                sleep(1);
+                $retryCount++;
+            }
 
-        if (! $this->connector->connected()) {
-            self::fail('Could not connect to core agent in test harness. ' . $this->formatCapturedLogMessages());
+            if (! $this->connector->connected()) {
+                self::fail('Could not connect to core agent in test harness. ' . $this->formatCapturedLogMessages());
+            }
         }
 
         (new PotentiallyAvailableExtensionCapabilities())->clearRecordedCalls();
@@ -426,6 +428,53 @@ static function (array $commands): bool {
         );
     }
 
+    /**
+     * Run Mongo with:
+     *
+     * ```
+     * docker run --rm --name some-mongo -p 27017:27017 -d mongo:latest
+     * ```
+     *
+     * @group mongo
+     */
+    public function testMongoDbDoesNotStartSpansWhenMonitoringIsDisabled(): void
+    {
+        if (! extension_loaded('mongodb')) {
+            self::markTestSkipped('MongoDB extension required for this test - mongodb is not loaded');
+        }
+
+        $this->setUpWithConfiguration(Config::fromArray([
+            ConfigKey::APPLICATION_NAME => self::APPLICATION_NAME,
+            ConfigKey::MONITORING_ENABLED => false,
+        ]));
+
+        $mongo = new Manager('mongodb://localhost:27017');
+
+        try {
+            $mongo->startSession();
+        } catch (ConnectionTimeoutException $timeoutException) {
+            self::markTestSkipped('Could not connect to mongodb server, is it running?');
+        }
+
+        $db         = 'scout-apm-test-db';
+        $collection = uniqid('scout-apm-test-', true);
+
+        $mongo->executeCommand($db, new Command(['create' => $collection]));
+
+        $request = $this->agent->getRequest();
+        self::assertNotNull($request);
+        self::assertEmpty($request->getEvents());
+    }
+
+    /**
+     * Run Mongo with:
+     *
+     * ```
+     * docker run --rm --name some-mongo -p 27017:27017 -d mongo:latest
+     * ```
+     *
+     * @group mongo
+     */
     public function testMongoDbInstrumentation(): void
     {
         if (! extension_loaded('mongodb')) {