Skip to content

Commit 88f80b3

Browse files
committed
Add telemetry policy
1 parent a20b33a commit 88f80b3

File tree

3 files changed

+76
-1
lines changed

3 files changed

+76
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,8 @@ For online communication, we invite you to chat with us & other users on [Sylius
8888
## License
8989

9090
This plugin's source code is completely free and released under the terms of the MIT license.
91+
92+
## Telemetry
93+
94+
This plugin enforces telemetry data collection when used with Sylius.
95+
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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"php": "^8.2",
1313
"api-platform/state": "^4.0.3",
1414
"sylius/sylius": "^2.0",
15-
"league/csv": "^9.1"
15+
"league/csv": "^9.1",
16+
"sylius/telemetry-bundle": "^1.0"
1617
},
1718
"require-dev": {
1819
"behat/behat": "^3.14",

0 commit comments

Comments
 (0)