Skip to content

Commit c37ee63

Browse files
authored
Add telemetry (#420)
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 73386fa + 9065b7d commit c37ee63

File tree

4 files changed

+91
-2
lines changed

4 files changed

+91
-2
lines changed

README.md

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

3838
This plugin is released under the [MIT License](LICENSE).
39+
40+
## Telemetry
41+
42+
This plugin enforces telemetry data collection when used with Sylius.
43+
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: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
{
22
"name": "sylius/invoicing-plugin",
33
"type": "sylius-plugin",
4-
"keywords": ["sylius", "sylius-plugin", "symfony", "e-commerce", "invoicing"],
4+
"keywords": [
5+
"sylius",
6+
"sylius-plugin",
7+
"symfony",
8+
"e-commerce",
9+
"invoicing"
10+
],
511
"description": "Invoicing plugin for Sylius.",
612
"license": "MIT",
713
"require": {
@@ -11,6 +17,7 @@
1117
"sylius/grid-bundle": "^1.13",
1218
"sylius/resource-bundle": "^1.12",
1319
"sylius/sylius": "^2.0",
20+
"sylius/telemetry": "^1.0",
1421
"symfony/clock": "^6.4 || ^7.4",
1522
"symfony/config": "^6.4 || ^7.4",
1623
"symfony/console": "^6.4 || ^7.4",
@@ -92,7 +99,7 @@
9299
"require": "~7.4.0"
93100
},
94101
"branch-alias": {
95-
"dev-2.0": "2.0-dev"
102+
"dev-2.1": "2.1-dev"
96103
},
97104
"public-dir": "vendor/sylius/test-application/public"
98105
},

src/SyliusInvoicingPlugin.php

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

1616
use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
17+
use Sylius\Telemetry\TelemetryCompilerPass;
18+
use Symfony\Component\DependencyInjection\ContainerBuilder;
1719
use Symfony\Component\HttpKernel\Bundle\Bundle;
1820

1921
final class SyliusInvoicingPlugin extends Bundle
@@ -24,4 +26,10 @@ public function getPath(): string
2426
{
2527
return \dirname(__DIR__);
2628
}
29+
30+
public function build(ContainerBuilder $container): void
31+
{
32+
parent::build($container);
33+
$container->addCompilerPass(new TelemetryCompilerPass());
34+
}
2735
}

0 commit comments

Comments
 (0)