Merge pull request #13 from bufferapp/task/check-dd-extensions

Check datadog if class exists

Author: erickhun

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bufferapp/php-bufflog",
     "description": "PHP log libraries for Buffer services",
-    "version": "0.1.2",
+    "version": "0.1.3",
     "require": {
         "php": "^7.1",
         "monolog/monolog": "^1.20",

src/BuffLog/BuffLog.php

@@ -36,6 +36,12 @@ static public function getLogger()
 
 	protected static function configureInstance()
 	{
+
+        if (!class_exists("\DDTrace\GlobalTracer")) {
+            error_log("Tip #1: Can't find \DDTrace\GlobalTracer class. Did you install the Datadog APM tracer extension? It will allow you to have logs enriched with traces making troubleshooting easier! :)");
+            error_log("Tip #2: If you run a cli mode service (such as a worker), did you set the DD_TRACE_CLI_ENABLED env variable?");
+        }
+
         // @TODO: We could potentially use the Kubernetes downward API to
         // define the logger name. This will make it easier for developers
         // to read and friendlier to identify where come the logs at a glance
@@ -82,7 +88,7 @@ public static function __callStatic($methodName, $args)
 
     private static function enrichLog()
     {
-        // This should probably implemented as a Monolog Processor
+        // We should probably implement this as a Monolog Processor
         // https://github.com/Seldaek/monolog/tree/master/src/Monolog/Processor
         self::getLogger()->pushProcessor(function ($record) {
 
@@ -96,12 +102,18 @@ private static function enrichLog()
             //     'profileID' => $user->getProfileID()
             // );
 
-            // Add traces information to be able to correlate logs with APM
-            $ddTraceSpan = \DDTrace\GlobalTracer::get()->getActiveSpan();
-            $record['context']['dd'] = [
-                "trace_id" => $ddTraceSpan->getTraceId(),
-                "span_id"  => $ddTraceSpan->getSpanId()
-            ];
+            try {
+                // Add traces information to be able to correlate logs with APM
+                $ddTraceSpan = \DDTrace\GlobalTracer::get()->getActiveSpan();
+                $record['context']['dd'] = [
+                    "trace_id" => $ddTraceSpan->getTraceId(),
+                    "span_id"  => $ddTraceSpan->getSpanId()
+                ];
+
+            } catch (Exception $e) {
+                error_log($e->getMessage() . " Can't add trace to logs. Have you setup the Datadog Tracer extension? If you run a worker have your added the DD_TRACE_CLI_ENABLED env variable?");
+            }
+
             return $record;
         });
     }