Skip to content

Commit 2ad0a56

Browse files
authored
Add telemetry (#45)
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 bdd6229 + 8f94d1f commit 2ad0a56

File tree

4 files changed

+78
-0
lines changed

4 files changed

+78
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,8 @@ For online communication, we invite you to chat with us and other users on [Syli
3737
## License
3838

3939
This plugin is released under the [MIT License](LICENSE).
40+
41+
## Telemetry
42+
43+
This plugin enforces telemetry data collection when used with Sylius.
44+
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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"require": {
77
"php": "^8.2",
88
"sylius/sylius": "^2.0.7",
9+
"sylius/telemetry": "^1.0",
910
"dompdf/dompdf": "^2.0"
1011
},
1112
"require-dev": {

src/SyliusWishlistPlugin.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
namespace Sylius\WishlistPlugin;
1515

1616
use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
17+
use Sylius\Telemetry\TelemetryCompilerPass;
1718
use Sylius\WishlistPlugin\DependencyInjection\SyliusMessageBusPolyfillPass;
1819
use Sylius\WishlistPlugin\DependencyInjection\TwigHooksProfilerPass;
1920
use Symfony\Component\DependencyInjection\Compiler\PassConfig;
@@ -46,5 +47,7 @@ public function build(ContainerBuilder $container): void
4647
);
4748

4849
$container->addCompilerPass(new TwigHooksProfilerPass());
50+
51+
$container->addCompilerPass(new TelemetryCompilerPass());
4952
}
5053
}

0 commit comments

Comments
 (0)