No ability to prevent logs sending from Meta Extension to meta

[ihor-sviziev]

I noticed that this extension sends a part of the logs to Meta. There is supposed to be an ability to enable/disable this functionality.

Related functionality:

• adding a log to meta flag

  meta-for-magento2/app/code/Meta/BusinessExtension/Helper/FBEHelper.php

  Lines 340 to 344 in c1a47c7

  	public function logExceptionImmediatelyToMeta(Throwable $e, array $context = [])
  	{
  	$context['log_type'] = self::PERSIST_META_LOG_IMMEDIATELY;
  	$this->logException($e, $context);
  	}

• adding log to the queue

  meta-for-magento2/app/code/Meta/BusinessExtension/Logger/Handler.php

  Lines 66 to 75 in c1a47c7

  	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') {
  	$this->publisher->publish('persist.meta.telemetry.logs', json_encode($record['context']));
  	return;
  	}
  	parent::write($record);

• message queue consumers

  meta-for-magento2/app/code/Meta/BusinessExtension/etc/queue_consumer.xml

  Lines 3 to 4 in c1a47c7

  	<consumer name="persist.meta.log.immediately.consumer" queue="persist_meta_log_immediately" connection="db" handler="Meta\BusinessExtension\Model\PersistMetaLogImmediatelyHandler::persistMetaLogImmediately" consumerInstance="Magento\Framework\MessageQueue\Consumer"/>
  	<consumer name="persist.meta.telemetry.logs.consumer" queue="persist_meta_telemetry_logs" connection="db" handler="Meta\BusinessExtension\Model\PersistMetaTelemetryLogsHandler::persistMetaTelemetryLogs" consumerInstance="Magento\Framework\MessageQueue\BatchConsumer" maxMessages="20" maxIdleTime="5"/>

• sending logs to meta from the queue
  

  meta-for-magento2/app/code/Meta/BusinessExtension/Helper/GraphAPIAdapter.php

  Lines 936 to 967 in c1a47c7

  	public function persistLogToMeta($context)
  	{
  	$extraData = $this->getContextData($context, 'extra_data', []);
  	$token = $this->accessToken;
  	if (!$token) {
  	$token = $this->clientAccessToken;
  	$extraData = array_merge($extraData, ['access_token_used' => 'client']);
  	}
  	$request = [
  	'access_token' => $token,
  	'event' => $this->getContextData($context, 'event'),
  	'event_type' => $this->getContextData($context, 'event_type'),
  	'commerce_merchant_settings_id' => $this->getContextData($context, 'commerce_merchant_settings_id'),
  	'exception_message' => $this->getContextData($context, 'exception_message'),
  	'exception_trace' => $this->getContextData($context, 'exception_trace'),
  	'exception_code' => $this->getContextData($context, 'exception_code'),
  	'exception_class' => $this->getContextData($context, 'exception_class'),
  	'catalog_id' => $this->getContextData($context, 'catalog_id'),
  	'order_id' => $this->getContextData($context, 'order_id'),
  	'promotion_id' => $this->getContextData($context, 'promotion_id'),
  	'flow_name' => $this->getContextData($context, 'flow_name'),
  	'flow_step' => $this->getContextData($context, 'flow_step'),
  	'incoming_params' => $this->getContextData($context, 'incoming_params'),
  	'seller_platform_app_version' => $this->getContextData($context, 'seller_platform_app_version'),
  	'extra_data' => $extraData,
  	];
  	$response = $this->callApi('POST', "commerce_seller_logs", $request);
  	$response = json_decode($response->getBody()->__toString(), true);
  	return $response;
  	}

Preconditions (*)

Steps to reproduce (*)

Expected result (*)

1. [Screenshots, logs or description]

Actual result (*)

1. [Screenshots, logs or description]

[zlik]

@nrostrow-meta

[nrostrow-meta]

@ihor-sviziev There currently is the ability to prevent the exception logs from being sent to Meta. Though it might not be adequate so please let me know if so. The logExceptionImmediatelyToMeta function just adds 'log_type' to the context and then calls the logException function. The logException function has a check for if sending logs to Meta is enabled and if it's not enabled then the log is just made locally and is not added to the queue to be persisted to Meta.

meta-for-magento2/app/code/Meta/BusinessExtension/Helper/FBEHelper.php

Lines 306 to 311 in 3ba5435

	// If the log type is not set or Meta extension logging is not enabled just log the error message and trace.
	if (!isset($context['log_type']) || !$this->systemConfig->isMetaExceptionLoggingEnabled()) {
	$this->logger->error($errorMessage);
	$this->logger->error($exceptionTrace);
	return;
	}

Enabling/disabling persisting exception logs to Meta can be controlled by updating the meta_exception_logging_enabled config value.

meta-for-magento2/app/code/Meta/BusinessExtension/etc/config.xml

Line 11 in 3ba5435

<meta_exception_logging_enabled>1</meta_exception_logging_enabled>

Currently this config value isn't shown in the UI though and can only be modified in code. By default the value is set to true to enable persisting exception logs to Meta. The reason for this is that the exception logging is pretty critical for us to be able to identify and diagnose issues with the extension so we were afraid that if we showed it in the UI that sellers would turn it off by default.

meta-for-magento2/app/code/Meta/BusinessExtension/etc/adminhtml/system.xml

Lines 48 to 53 in 3ba5435

	<field id="meta_exception_logging_enabled" type="select" sortOrder="40" showInDefault="1"
	showInWebsite="0" showInStore="1">
	<config_path>facebook/business_extension/meta_exception_logging_enabled</config_path>
	<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
	<frontend_model>Meta\BusinessExtension\Block\Adminhtml\System\Config\Field\Hidden</frontend_model>
	</field>

Is this acceptable or does disabling sending exception logs to Meta need to be prevalent in the UI? Thanks!