@@ -6,20 +6,29 @@ slug: telemetry
66
77
88Starting with the 4.1.0 release, Node-RED gathers anonymous usage information once
9- a day and shares it with the Node-RED team.
9+ a day and shares it with the Node-RED team. In return, Node-RED will notify the user
10+ when there is a new version available.
1011
1112This information is only shared with the Node-RED team once the user has opted
1213into sharing their information. If the user declines to share their information,
1314nothing is sent back to the team.
1415
1516### Why?
1617
18+ As with all software, it is important to keep it up to date. With legislation
19+ such as the EU's [ Cyber Resilience Act] ( https://digital-strategy.ec.europa.eu/en/library/cyber-resilience-act )
20+ on the horizon, we want to take a proactive approach to help users keep their Node-RED
21+ environments up to date and secure.
22+
23+ The Usage Telemetry serves two purposes;
24+
25+ 1 . It allows us to notify users within the application when there are updates available,
26+ 2 . It allows us to get a better understanding of Node-RED usage; what versions are being used, what operating systems are favoured.
27+
1728Historically, the only measures we've had around the size and scale of the Node-RED
1829user-base have been secondary indicators, such as high-level statistics provided
19- by npm and docker, or the general level of activity on the community forum.
20-
21- This does not give us much useful information to help understand Node-RED usage;
22- such as what versions of Node.JS are being used, what operating systems are favoured.
30+ by npm and docker, or the general level of activity on the community forum. This does
31+ not give us much useful information to help understand Node-RED usage.
2332
2433
2534### What data is collected?
@@ -38,7 +47,7 @@ It does **not** contain:
3847
3948### How is the data collected?
4049
41- If the user has opted to share information , a task will run 30 minutes after
50+ If the user has opted to receive update notifications , a task will run 30 minutes after
4251Node-RED starts (or when they opt-in), and every 24 hours after that.
4352
4453The data is sent over HTTPS to an endpoint hosted by the Node-RED project.
@@ -59,21 +68,23 @@ this document will be updated to link to it and it will be publicised within the
5968
6069### How do I opt out?
6170
62- We hope you'll share your information to help us maintain the project. However,
63- if you want to opt out, there are a number of ways to do so.
71+ We hope you'll appreciate the value of knowing when there are updates available, and that
72+ by opting in, you'll help us maintain the project.
73+
74+ However, if you want to opt out, there are a number of ways to do so.
6475
6576#### Editor Settings
6677
6778The first time you open the editor for Node-RED 4.1 or later, if you have not
68- already opted in or out, you will be asked if you are willing to share your information .
79+ already opted in or out, you will be asked if you are willing to receive update notifications .
6980
7081You can change you made via the Editor Settings dialog at any time.
7182
7283#### ` settings.js ` file
7384
7485You can also enable/disable telemetry via your settings file.
7586
76- If you have a preexisting settings file, you will need to add a ` telemetry ` section.
87+ If you have a pre-existing settings file, you will need to add a ` telemetry ` section.
7788For new installs of Node-RED, the default settings file already has this section, but
7889with the ` enabled ` option commented out. Remove the ` // ` at the start of the line
7990and change the value to ` false ` :
@@ -82,8 +93,9 @@ and change the value to `false`:
8293 telemetry: {
8394 enabled: false,
8495 /**
85- * If telemetry is enabled, the editor will notify the user if a new version of Node-RED
86- * is available. Set the following property to false to disable this notification.
96+ * If telemetry is enabled, the runtime will log a message when an update is available.
97+ * The editor will also notify the user if a new version of Node-RED
98+ * is available. Set the following property to false to disable this editor notification.
8799 */
88100 updateNotification: true
89101 },
@@ -103,3 +115,5 @@ in the editor tp help you know when its time to upgrade.
103115This notification can be disabled via the ` telemetry.updateNotification ` setting in the
104116settings file; it cannot be disabled from within the editor.
105117
118+ The runtime will also log when an update is available; this cannot be disabled.
119+
0 commit comments