diff --git a/README.md b/README.md index 0df1e246..adcb523f 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,8 @@ For online communication, we invite you to chat with us and other users on [Syli ## License This plugin is released under the [MIT License](LICENSE). + +## 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 00000000..bbdd7968 --- /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 1b49ef19..072565a3 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,10 @@ { "name": "sylius/paypal-plugin", "type": "sylius-plugin", - "keywords": ["sylius", "sylius-plugin"], + "keywords": [ + "sylius", + "sylius-plugin" + ], "description": "PayPal plugin for Sylius.", "license": "MIT", "require": { @@ -13,6 +16,7 @@ "psr/http-client": "^1.0", "sylius-labs/doctrine-migrations-extra-bundle": "^0.2", "sylius/sylius": "^2.0.1", + "sylius/telemetry": "^1.0", "symfony/mailer": "^6.4 || ^7.1" }, "require-dev": { diff --git a/src/SyliusPayPalPlugin.php b/src/SyliusPayPalPlugin.php index c753c15a..2e5a3cbd 100644 --- a/src/SyliusPayPalPlugin.php +++ b/src/SyliusPayPalPlugin.php @@ -14,6 +14,8 @@ namespace Sylius\PayPalPlugin; use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait; +use Sylius\Telemetry\TelemetryCompilerPass; +use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\DependencyInjection\Extension\ExtensionInterface; use Symfony\Component\HttpKernel\Bundle\Bundle; @@ -31,4 +33,10 @@ public function getContainerExtension(): ?ExtensionInterface { return $this->createContainerExtension(); } + + public function build(ContainerBuilder $container): void + { + parent::build($container); + $container->addCompilerPass(new TelemetryCompilerPass()); + } }