Skip to content

Commit 8a9b1cb

Browse files
authored
Add telemetry (#426)
Adds telemetry policy and `sylius/telemetry-bundle` as a hard dependency. - `TELEMETRY_POLICY.md` — describes scope, purpose, and conditions of telemetry data collection - `composer.json` — requires `sylius/telemetry-bundle: ^1.0` - `README.md` — telemetry notice pointing to the policy file Related: Sylius/Sylius#18588
2 parents 137d5ad + 8b782d9 commit 8a9b1cb

File tree

4 files changed

+90
-2
lines changed

4 files changed

+90
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,8 @@ Sylius Core Team’s plugin for [PayPal Commerce Platform](https://www.paypal.co
5454
* `1.5` (v1.5.*) - security fixes
5555
* `1.6` (v1.6.*) - bug fixes, improvements
5656
* `1.7` (v1.7.*) - new features
57+
58+
## Telemetry
59+
60+
This plugin enforces telemetry data collection when used with Sylius.
61+
Details are described in [TELEMETRY_POLICY.md](./TELEMETRY_POLICY.md).

TELEMETRY_POLICY.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Telemetry Policy
2+
3+
## Applicability
4+
5+
This Telemetry Policy applies to the use of this plugin in combination with Sylius.
6+
7+
By installing or using this plugin with Sylius, the user acknowledges that telemetry data is collected and transmitted as described in this document.
8+
9+
---
10+
11+
## Mandatory telemetry
12+
13+
Telemetry data collection is mandatory when this plugin is used.
14+
15+
While this plugin is installed and active, Sylius telemetry operates under the conditions defined by this plugin and cannot be disabled independently.
16+
Telemetry behavior outside of this scope follows the standard Sylius configuration.
17+
18+
---
19+
20+
## Scope of collected data
21+
22+
Telemetry is limited to non-identifying technical data, which may include:
23+
24+
- Sylius version
25+
- plugin version
26+
- PHP version and selected dependency versions
27+
- identifiers of installed and enabled plugins
28+
- runtime environment classification (production or non-production)
29+
30+
Telemetry does not include, and is not intended to include:
31+
32+
- personal data
33+
- customer data
34+
- order data
35+
- product data
36+
- business, transactional, or confidential information
37+
- authentication credentials or secrets
38+
39+
A detailed description of the Sylius telemetry mechanism is available in the public issue:
40+
https://github.com/Sylius/Sylius/issues/18588
41+
42+
---
43+
44+
## Purpose and use of telemetry data
45+
46+
Telemetry data is collected for the purpose of:
47+
48+
- understanding usage patterns within the Sylius ecosystem
49+
- analyzing the adoption and frequency of plugin usage
50+
- identifying commonly used versions of Sylius and plugins
51+
- supporting maintenance, compatibility, and future development efforts
52+
53+
Telemetry data is processed in aggregated form and is not used to identify individual users, installations, or businesses.
54+
55+
---
56+
57+
## Licensing
58+
59+
This plugin is distributed under the MIT license.
60+
61+
Telemetry collection constitutes part of the technical operation of the software and does not alter, restrict, or supplement the rights granted under the license.
62+
63+
---
64+
65+
## Changes to this policy
66+
67+
This Telemetry Policy may be updated to reflect changes in telemetry implementation, legal requirements, or operational practices.
68+
69+
Updated versions of this policy will be made available in the plugin repository.

composer.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
{
22
"name": "sylius/paypal-plugin",
33
"type": "sylius-plugin",
4-
"keywords": ["sylius", "sylius-plugin"],
4+
"keywords": [
5+
"sylius",
6+
"sylius-plugin"
7+
],
58
"description": "PayPal plugin for Sylius.",
69
"license": "MIT",
710
"require": {
@@ -11,6 +14,7 @@
1114
"polishsymfonycommunity/symfony-mocker-container": "^1.0",
1215
"sylius-labs/doctrine-migrations-extra-bundle": "^0.1.4 || ^0.2",
1316
"sylius/sylius": "~1.12.0",
17+
"sylius/telemetry": "^1.0",
1418
"symfony/mailer": "^5.4 || ^6.0"
1519
},
1620
"require-dev": {
@@ -48,7 +52,9 @@
4852
}
4953
},
5054
"autoload-dev": {
51-
"classmap": ["tests/Application/Kernel.php"]
55+
"classmap": [
56+
"tests/Application/Kernel.php"
57+
]
5258
},
5359
"conflict": {
5460
"behat/mink-selenium2-driver": ">=1.7.0"

src/SyliusPayPalPlugin.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,17 @@
55
namespace Sylius\PayPalPlugin;
66

77
use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
8+
use Sylius\Telemetry\TelemetryCompilerPass;
9+
use Symfony\Component\DependencyInjection\ContainerBuilder;
810
use Symfony\Component\HttpKernel\Bundle\Bundle;
911

1012
final class SyliusPayPalPlugin extends Bundle
1113
{
1214
use SyliusPluginTrait;
15+
16+
public function build(ContainerBuilder $container): void
17+
{
18+
parent::build($container);
19+
$container->addCompilerPass(new TelemetryCompilerPass());
20+
}
1321
}

0 commit comments

Comments
 (0)