Skip to content

Commit 55294e6

Browse files
authored
Add telemetry (#307)
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 1b71caa + f759e44 commit 55294e6

File tree

4 files changed

+84
-2
lines changed

4 files changed

+84
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,3 +480,8 @@ Instead, all security issues must be sent to `security@sylius.com`
480480
## Community
481481

482482
For online communication, we invite you to chat with us & other users on [Sylius Slack](https://sylius-devs.slack.com/).
483+
484+
## Telemetry
485+
486+
This plugin enforces telemetry data collection when used with Sylius.
487+
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
@@ -12,6 +12,7 @@
1212
"sylius/admin-order-creation-plugin": "0.14 || 0.15",
1313
"sylius/refund-plugin": "^1.0",
1414
"sylius/sylius": "~1.11.0 || ~1.12.0 || ~1.13.0",
15+
"sylius/telemetry": "^1.0",
1516
"symfony/mailer": "^5.4 || ^6.4",
1617
"symfony/messenger": "^5.4 || ^6.4",
1718
"willdurand/js-translation-bundle": "^4.0 || ^5.0"
@@ -64,11 +65,16 @@
6465
"autoload": {
6566
"psr-4": {
6667
"SyliusMolliePlugin\\": "src/",
67-
"Tests\\SyliusMolliePlugin\\": ["tests/", "tests/Application/src"]
68+
"Tests\\SyliusMolliePlugin\\": [
69+
"tests/",
70+
"tests/Application/src"
71+
]
6872
}
6973
},
7074
"autoload-dev": {
71-
"classmap": ["tests/Application/Kernel.php"]
75+
"classmap": [
76+
"tests/Application/Kernel.php"
77+
]
7278
},
7379
"config": {
7480
"allow-plugins": {

src/SyliusMolliePlugin.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
use SyliusMolliePlugin\DependencyInjection\SyliusMessageBusPolyfillPass;
1717
use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
18+
use Sylius\Telemetry\TelemetryCompilerPass;
1819
use Symfony\Component\DependencyInjection\ContainerBuilder;
1920
use Symfony\Component\HttpKernel\Bundle\Bundle;
2021

@@ -31,5 +32,6 @@ public function build(ContainerBuilder $container): void
3132
parent::build($container);
3233

3334
$container->addCompilerPass(new SyliusMessageBusPolyfillPass());
35+
$container->addCompilerPass(new TelemetryCompilerPass());
3436
}
3537
}

0 commit comments

Comments
 (0)