Catalog Telemetry logging added for all feed upload flows (#581)

* Telemetry logging added for all feed upload flows

* PR comments resolved

* Static errors resolved

* feed id moved to extras

Author: singhramanpreett

app/code/Meta/BusinessExtension/Helper/FBEHelper.php

@@ -40,6 +40,7 @@ class FBEHelper
     private const URL_TYPE_WEB = 'web';
 
     public const PERSIST_META_LOG_IMMEDIATELY = 'persist_meta_log_immediately';
+    public const PERSIST_META_TELEMETRY_LOGS = 'persist_meta_telemetry_logs';
 
     /**
      * @var GraphAPIConfig
@@ -309,6 +310,14 @@ public function logException(Throwable $e, array $context = [])
         $this->logExceptionDetails($exceptionCode, $errorMessage, $exceptionTrace, $context);
     }
 
+    /**
+     * Log exception details
+     *
+     * @param int $code
+     * @param string $message
+     * @param string $traceAsString
+     * @param array $context
+     */
     public function logExceptionDetails($code, $message, $traceAsString, array $context = [])
     {
         // If the log type is not set just log the error message and trace.
@@ -367,6 +376,18 @@ public function logExceptionDetailsImmediatelyToMeta($code, $message, $traceAsSt
         $this->logExceptionDetails($code, $message, $traceAsString, $context);
     }
 
+    /**
+     * Log telemetry and persist with Meta
+     *
+     * @param string $message
+     * @param array $context
+     */
+    public function logTelemetryToMeta(string $message, array $context = [])
+    {
+        $context['log_type'] = self::PERSIST_META_TELEMETRY_LOGS;
+        $this->log($message, $context);
+    }
+
     /**
      * Log pixel event
      *
@@ -474,4 +495,23 @@ public function checkAdminEndpointPermission()
         }
     }
 
+    /**
+     * Return unique trace id for telemetry flows
+     *
+     * @return string
+     */
+    public function genUniqueTraceID(): string
+    {
+        return uniqid("magento_");
+    }
+
+    /**
+     * Return current time in milliseconds
+     *
+     * @return int
+     */
+    public function getCurrentTimeInMS(): int
+    {
+        return (int)(microtime(true) * 1000);
+    }
 }

app/code/Meta/BusinessExtension/Logger/Handler.php

@@ -68,7 +68,7 @@ protected function write(array $record): void
         $logTypeIsSet = isset($record['context']['log_type']);
         if ($logTypeIsSet && $record['context']['log_type'] === FBEHelper::PERSIST_META_LOG_IMMEDIATELY) {
             $this->publisher->publish('persist.meta.log.immediately', json_encode($record['context']));
-        } elseif ($logTypeIsSet && $record['context']['log_type'] === 'persist_meta_telemetry_logs') {
+        } elseif ($logTypeIsSet && $record['context']['log_type'] === FBEHelper::PERSIST_META_TELEMETRY_LOGS) {
             $this->publisher->publish('persist.meta.telemetry.logs', json_encode($record['context']));
             return;
         }

app/code/Meta/BusinessExtension/Model/PersistMetaTelemetryLogsHandler.php

@@ -20,6 +20,8 @@
 
 namespace Meta\BusinessExtension\Model;
 
+use GuzzleHttp\Exception\GuzzleException;
+use Meta\BusinessExtension\Helper\FBEHelper;
 use Meta\BusinessExtension\Helper\GraphAPIAdapter;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 
@@ -54,6 +56,7 @@ public function __construct(
      * Consumer handler to persist telemetry logs from message queue to Meta
      *
      * @param string $messages
+     * @throws GuzzleException
      */
     public function persistMetaTelemetryLogs(string $messages)
     {
@@ -68,7 +71,7 @@ public function persistMetaTelemetryLogs(string $messages)
             }
         }
         $telemetryContext = [];
-        $telemetryContext['event'] = 'persist_meta_telemetry_logs';
+        $telemetryContext['event'] = FBEHelper::PERSIST_META_TELEMETRY_LOGS;
         $telemetryContext['extra_data'] = [];
         $telemetryContext['extra_data']['telemetry_logs'] = $messages;
         $this->graphApiAdapter->persistLogToMeta($telemetryContext, $accessToken);

app/code/Meta/BusinessExtension/Plugin/LoggingPluginBase.php

@@ -194,7 +194,7 @@ private function getTelemetryLogData(string $log_prefix, $subject, string $step)
         $storeId = $this->getMaybeStoreID();
         return [
             'flow_name' => $log_prefix . ': ' . $this->getClassnameForLogging($subject),
-            'log_type' => 'persist_meta_telemetry_logs',
+            'log_type' => FBEHelper::PERSIST_META_TELEMETRY_LOGS,
             'store_id' => $storeId,
             'flow_step' => $step,
         ];

app/code/Meta/Catalog/Controller/Adminhtml/Ajax/ProductFeedUpload.php

@@ -27,7 +27,6 @@
 use Meta\Catalog\Model\Product\Feed\Uploader;
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\Controller\Result\JsonFactory;
-use Magento\Framework\Exception\NoSuchEntityException;
 
 class ProductFeedUpload extends AbstractAjax
 {
@@ -72,7 +71,7 @@ public function __construct(
      * Execute for json
      *
      * @return array
-     * @throws NoSuchEntityException
+     * @throws \Throwable
      */
     public function executeForJson()
     {
@@ -100,8 +99,11 @@ public function executeForJson()
             return $response;
         }
 
+        $traceId = $this->fbeHelper->genUniqueTraceID();
+        $flowName = 'force_product_feed_upload';
+
         try {
-            $feedPushResponse = $this->uploader->uploadFullCatalog($storeId);
+            $feedPushResponse = $this->uploader->uploadFullCatalog($storeId, $flowName, $traceId);
             $response['success'] = true;
             $response['feed_push_response'] = $feedPushResponse;
         } catch (Exception $e) {

app/code/Meta/Catalog/Cron/UploadProductFeed.php

@@ -23,7 +23,6 @@
 use Exception;
 use Meta\Catalog\Model\Product\Feed\Uploader;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
-use Magento\Framework\Exception\LocalizedException;
 use Meta\BusinessExtension\Helper\FBEHelper;
 
 class UploadProductFeed
@@ -63,12 +62,14 @@ public function __construct(
      *
      * @param int $storeId
      * @return $this
-     * @throws LocalizedException
+     * @throws \Throwable
      */
     private function uploadForStore($storeId)
     {
         if ($this->isFeedUploadEnabled($storeId)) {
-            $this->uploader->uploadFullCatalog($storeId);
+            $traceId = $this->fbeHelper->genUniqueTraceID();
+            $flowName = 'daily_product_feed_upload';
+            $this->uploader->uploadFullCatalog($storeId, $flowName, $traceId);
         }
 
         return $this;

app/code/Meta/Catalog/Helper/CatalogSyncHelper.php

@@ -72,13 +72,15 @@ public function __construct(
      * Syncs all products and categories to Meta Catalog
      *
      * @param int $storeId
+     * @param string $flowName
+     * @param string $traceId
      * @return void
      */
-    public function syncFullCatalog(int $storeId)
+    public function syncFullCatalog(int $storeId, string $flowName, string $traceId)
     {
         try {
             if ($this->systemConfig->isCatalogSyncEnabled($storeId)) {
-                $this->uploader->uploadFullCatalog($storeId);
+                $this->uploader->uploadFullCatalog($storeId, $flowName, $traceId);
                 $this->categoryCollection->pushAllCategoriesToFbCollections($storeId);
             }
         } catch (\Throwable $e) {