From 2f2d4a403985c2e7cffb715743a506cc13286ff3 Mon Sep 17 00:00:00 2001 From: Rafikooo Date: Tue, 3 Feb 2026 07:27:52 +0100 Subject: [PATCH] Add telemetry support --- README.md | 5 +++ TELEMETRY_POLICY.md | 69 ++++++++++++++++++++++++++++++++++++++ composer.json | 9 ++++- src/SyliusRefundPlugin.php | 8 +++++ 4 files changed, 90 insertions(+), 1 deletion(-) create mode 100644 TELEMETRY_POLICY.md diff --git a/README.md b/README.md index f87293910..9b5d6970a 100644 --- a/README.md +++ b/README.md @@ -143,3 +143,8 @@ Tagged services would be executed according to their priority (descending). If you think that you have found a security issue, please do not use the issue tracker and do not post it publicly. Instead, all security issues must be sent to `security@sylius.com`. + +## Telemetry + +This plugin enforces telemetry data collection when used with Sylius. +Details are described in [TELEMETRY_POLICY.md](./TELEMETRY_POLICY.md). diff --git a/TELEMETRY_POLICY.md b/TELEMETRY_POLICY.md new file mode 100644 index 000000000..bbdd79685 --- /dev/null +++ b/TELEMETRY_POLICY.md @@ -0,0 +1,69 @@ +# Telemetry Policy + +## Applicability + +This Telemetry Policy applies to the use of this plugin in combination with Sylius. + +By installing or using this plugin with Sylius, the user acknowledges that telemetry data is collected and transmitted as described in this document. + +--- + +## Mandatory telemetry + +Telemetry data collection is mandatory when this plugin is used. + +While this plugin is installed and active, Sylius telemetry operates under the conditions defined by this plugin and cannot be disabled independently. +Telemetry behavior outside of this scope follows the standard Sylius configuration. + +--- + +## Scope of collected data + +Telemetry is limited to non-identifying technical data, which may include: + +- Sylius version +- plugin version +- PHP version and selected dependency versions +- identifiers of installed and enabled plugins +- runtime environment classification (production or non-production) + +Telemetry does not include, and is not intended to include: + +- personal data +- customer data +- order data +- product data +- business, transactional, or confidential information +- authentication credentials or secrets + +A detailed description of the Sylius telemetry mechanism is available in the public issue: +https://github.com/Sylius/Sylius/issues/18588 + +--- + +## Purpose and use of telemetry data + +Telemetry data is collected for the purpose of: + +- understanding usage patterns within the Sylius ecosystem +- analyzing the adoption and frequency of plugin usage +- identifying commonly used versions of Sylius and plugins +- supporting maintenance, compatibility, and future development efforts + +Telemetry data is processed in aggregated form and is not used to identify individual users, installations, or businesses. + +--- + +## Licensing + +This plugin is distributed under the MIT license. + +Telemetry collection constitutes part of the technical operation of the software and does not alter, restrict, or supplement the rights granted under the license. + +--- + +## Changes to this policy + +This Telemetry Policy may be updated to reflect changes in telemetry implementation, legal requirements, or operational practices. + +Updated versions of this policy will be made available in the plugin repository. diff --git a/composer.json b/composer.json index f3bbaaf17..72b7fe1b3 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,13 @@ { "name": "sylius/refund-plugin", "type": "sylius-plugin", - "keywords": ["sylius", "sylius-plugin", "symfony", "e-commerce", "refunds"], + "keywords": [ + "sylius", + "sylius-plugin", + "symfony", + "e-commerce", + "refunds" + ], "description": "Plugin provides basic refunds functionality for Sylius application.", "license": "MIT", "authors": [ @@ -25,6 +31,7 @@ "php-http/message-factory": "^1.1", "sylius/resource-bundle": "^1.9", "sylius/sylius": "~1.12.0 || ~1.13.0", + "sylius/telemetry": "^1.0", "symfony/messenger": "^5.4.21 || ^6.4" }, "require-dev": { diff --git a/src/SyliusRefundPlugin.php b/src/SyliusRefundPlugin.php index 6b1a3b3de..3325d2335 100644 --- a/src/SyliusRefundPlugin.php +++ b/src/SyliusRefundPlugin.php @@ -14,9 +14,17 @@ namespace Sylius\RefundPlugin; use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait; +use Sylius\Telemetry\TelemetryCompilerPass; +use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\HttpKernel\Bundle\Bundle; final class SyliusRefundPlugin extends Bundle { use SyliusPluginTrait; + + public function build(ContainerBuilder $container): void + { + parent::build($container); + $container->addCompilerPass(new TelemetryCompilerPass()); + } }