Skip to content

Add operating system to analytics #17612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 2 commits into from
Apr 28, 2021
Merged

Add operating system to analytics #17612

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfa3887
Add operating system to analytics
ludeeus Apr 27, 2021
6317086
Apply suggestions from code review
ludeeus Apr 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions source/_integrations/analytics.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ ha_codeowners:
ha_domain: analytics
---

{% assign current_version = site.current_major_version | append: "." | append: site.current_minor_version | append: "." | append: site.current_patch_version %}
Copy link
Copy Markdown
Member

@frenck frenck Apr 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hehe nice detail :)


Home Assistant allows users to share their usage data via the analytics integration. The aggregated data is available at <https://analytics.home-assistant.io>. It is used to influence Home Assistant development priorities and to convince manufacturers to add local control and privacy-focused features.

## Data Collection
Expand All @@ -37,16 +39,25 @@ If your system includes the Supervisor, this will also contain:
- If your installation is supported
- If your installation is healthy

If you are running Home Assistant Operating System, this will also contain:

- The board type you are using
- The version of the Operating System

{% details Example payload %}

```json
{
"uuid": "12a3456bc78d90123ef4567g789012h3",
"version": "2021.4.0",
"version": "{{current_version}}",
"installation_type": "Home Assistant OS",
"supervisor": {
"healthy": true,
"supported": true
},
"operating_system": {
"board": "odroid-n2",
"version:": "{{site.data.version_data.hassos['odroid-n2']}}"
}
}
```
Expand Down Expand Up @@ -74,12 +85,16 @@ If your system includes the Supervisor, this will also contain:
```json
{
"uuid": "12a3456bc78d90123ef4567g789012h3",
"version": "2021.4.0",
"version": "{{current_version}}",
"installation_type": "Home Assistant OS",
"supervisor": {
"healthy": true,
"supported": true
},
"operating_system": {
"board": "odroid-n2",
"version:": "{{site.data.version_data.hassos['odroid-n2']}}"
},
"integrations": ["awesome_integration"],
"addons": [
{
Expand Down Expand Up @@ -114,12 +129,16 @@ If your system includes the Supervisor, this will also contain:
```json
{
"uuid": "12a3456bc78d90123ef4567g789012h3",
"version": "2021.4.0",
"version": "{{current_version}}",
"installation_type": "Home Assistant OS",
"supervisor": {
"healthy": true,
"supported": true
},
"operating_system": {
"board": "odroid-n2",
"version:": "{{site.data.version_data.hassos['odroid-n2']}}"
},
"state_count": 1,
"automation_count": 2,
"integration_count": 3,
Expand Down Expand Up @@ -147,6 +166,6 @@ Your data is securely stored in [CloudFlare's Key-Value store](https://www.cloud
This is an example of how the information is stored:
{% configuration_basic %}
"uuid:12a3456bc78d90123ef4567g789012h3":
description: "{'version': '2021.4.0', 'installation_type': 'Home Assistant OS', 'country': 'NO'}"
description: "{'version': '{{current_version}}', 'installation_type': 'Home Assistant OS', 'country': 'NO'}"

{% endconfiguration_basic %}