Update 0.31 release text around updater analytics

This commit is contained in:
Paulus Schoutsen 2016-10-23 17:19:34 -07:00
parent 7130abca26
commit f4d8ebba40
2 changed files with 42 additions and 28 deletions

View File

@ -62,35 +62,43 @@ Finally, you can also reset your unique identifier by deleting the `.uuid` file
Here is what my production Home Assistant instance looks like from the server side: Here is what my production Home Assistant instance looks like from the server side:
| Name | Description | Example | Data Source | | Name | Description | Example |
|-----------------------|--------------------------------------------|------------------------------------|----------------| |-----------------------|--------------------------------------------|------------------------------------|
| `arch` | CPU Architecture | `x86_64` | Local Instance | | `arch` | CPU Architecture | `x86_64` |
| `distribution` | Linux Distribution name (only Linux) | `Ubuntu` | Local Instance | | `distribution` | Linux Distribution name (only Linux) | `Ubuntu` |
| `docker` | True if running inside Docker | `false` | Local Instance | | `docker` | True if running inside Docker | `false` |
| `first_seen_datetime` | First time instance ID was submitted | `2016-10-22T19:56:03.542Z` | Update Server | | `os_name` | Operating system name | `Darwin` |
| `geo_city` | GeoIP determined city | `Oakland` | Update Server | | `os_version` | Operating system version | `10.12` |
| `geo_country_code` | GeoIP determined country code | `US` | Update Server | | `python_version` | Python version | `3.5.2` |
| `geo_country_name` | GeoIP determined country name | `United States` | Update Server | | `timezone` | Timezone | `America/Los_Angeles` |
| `geo_latitude` | GeoIP determined latitude | `37.8047` | Update Server | | `user_agent` | User agent used to submit analytics | `python-requests/2.11.1` |
| `geo_longitude` | GeoIP determined longitude | `-122.2124` | Update Server | | `uuid` | Unique identifier | `10321ee6094d4a2ebb5ed55c675d5f5e` |
| `geo_metro_code` | GeoIP determined metro code | `807` | Update Server | | `version` | Home Assistant version | `0.31.0` |
| `geo_region_code` | GeoIP determined region code | `CA` | Update Server | | `virtualenv` | True if running inside virtualenv | `true` |
| `geo_region_name` | GeoIP determined region name | `California` | Update Server |
| `geo_time_zone` | GeoIP determined time zone | `America/Los_Angeles` | Update Server |
| `geo_zip_code` | GeoIP determined zip code | `94602` | Update Server |
| `last_seen_datetime` | Most recent time instance ID was submitted | `2016-10-22T19:56:03.542Z` | Update Server |
| `os_name` | Operating system name | `Darwin` | Local Instance |
| `os_version` | Operating system version | `10.12` | Local Instance |
| `python_version` | Python version | `3.5.2` | Local Instance |
| `timezone` | Timezone | `America/Los_Angeles` | Local Instance |
| `user_agent` | User agent used to submit analytics | `python-requests/2.11.1` | Local Instance |
| `uuid` | Unique identifier | `10321ee6094d4a2ebb5ed55c675d5f5e` | Local Instance |
| `version` | Home Assistant version | `0.31.0` | Local Instance |
| `virtualenv` | True if running inside virtualenv | `true` | Local Instance |
In addition to the above collected data, the server will also use your IP address to do a geographic IP address lookup to determine a general geographic area that your address is located in. To be extremely, extremely clear about this bit: __The Home Assistant updater does not: store your IP address in a database and also does not submit the location information from your `configuration.yaml`.__ Our tests show that at best, we get 4 digits of accuracy on your IP address location which is a 5 mile radius of your actual IP location, assuming that it is even correct in the first place (geo IP look ups are very hit or miss). Here's what the accuracy looks like for my data above: ![Robbie's GeoIP accuracy level](/images/blog/2016-10-flash-briefing-updater-hacktoberfest/map.png) In addition to the above collected data, the server will also use your IP address to do a geographic IP address lookup to determine the city that you are from. To be extremely, extremely clear about this bit: __The Home Assistant updater does not: store your IP address in a database and also does not submit the location information from your `configuration.yaml`.__
The server also adds two timestamps to the data: the original date your instance UUID was first seen and the timestamp of the last time we have seen your instance. <p class='img'>
<img src='/images/blog/2016-10-flash-briefing-updater-hacktoberfest/map.png' />
Geo-lookup on my IP resolves to Oakland with latitude/longitude pointing at the geographical center of the city.
</p>
The server also adds two timestamps to the data: the original date your instance UUID was first seen and the timestamp of the last time we have seen your instance. This gives us the following extra data:
| Name | Description | Example |
|-----------------------|--------------------------------------------|------------------------------------|
| `first_seen_datetime` | First time instance ID was submitted | `2016-10-22T19:56:03.542Z` |
| `geo_city` | GeoIP determined city | `Oakland` |
| `geo_country_code` | GeoIP determined country code | `US` |
| `geo_country_name` | GeoIP determined country name | `United States` |
| `geo_latitude` | GeoIP determined latitude (of the city) | `37.8047` |
| `geo_longitude` | GeoIP determined longitude (of the city) | `-122.2124` |
| `geo_metro_code` | GeoIP determined metro code | `807` |
| `geo_region_code` | GeoIP determined region code | `CA` |
| `geo_region_name` | GeoIP determined region name | `California` |
| `geo_time_zone` | GeoIP determined time zone | `America/Los_Angeles` |
| `geo_zip_code` | GeoIP determined zip code | `94602` |
| `last_seen_datetime` | Most recent time instance ID was submitted | `2016-10-22T19:56:03.542Z` |
This data is held in the highest security. The update system runs in a secured Amazon Web Services account owned by me ([@robbiet480]). I personally have 5 years of experience with complex AWS deployments and have an extensive security background. I have audited the entire system and made sure to take every step to protect the data, including limiting who has access (just [@balloob] and myself). While not directly personally identifiable we absolutely understand some users hesistance to giving this information out. Please understand that we are only collecting this information to better understand our user base to provide better long term support and feature development then is currently possible. This data is held in the highest security. The update system runs in a secured Amazon Web Services account owned by me ([@robbiet480]). I personally have 5 years of experience with complex AWS deployments and have an extensive security background. I have audited the entire system and made sure to take every step to protect the data, including limiting who has access (just [@balloob] and myself). While not directly personally identifiable we absolutely understand some users hesistance to giving this information out. Please understand that we are only collecting this information to better understand our user base to provide better long term support and feature development then is currently possible.
@ -98,6 +106,8 @@ We currently have no plans to publicly expose any of this information. If we did
We thank you for understanding why we are collecting this data and hope that you leave the feature enabled but fully understand if you feel uncomfortable with this. We thank you for understanding why we are collecting this data and hope that you leave the feature enabled but fully understand if you feel uncomfortable with this.
_This section was updated on October 24 to be more clear about geo-lookups being on the city level. [See original version.][blog-orig]_
Now, back to the fun stuff... Now, back to the fun stuff...
## {% linkable_title Good evening. I'm Ron Burgundy and here's what happening in your world tonight. %} ## {% linkable_title Good evening. I'm Ron Burgundy and here's what happening in your world tonight. %}
@ -110,7 +120,10 @@ Home Assistant got a crazy idea recently that it couldn't do enough already and
Now I know how to best get to [my real job][runway] (no, Home Assistant is _not_ my real job, it does seem like it sometimes though) every morning. Obviously not the best home automation example, but I think you get the idea. I could see this being used to tell you any major events that happened in your home overnight or reading you your hyperlocal weather report. Thanks to the audio support you could even replace all of the default Alexa Flash Briefing sources with your own news feeds. Home Assistant supports both text and audio content as well as displaying data in the Alexa app. I also want to point out that unlike the existing Skill integration, the Flash Briefing API does _not_ require HTTPS (_but you should still be using HTTPS if possible_). For more information, check out the new [docs][flash-briefing-docs]. Now I know how to best get to [my real job][runway] (no, Home Assistant is _not_ my real job, it does seem like it sometimes though) every morning. Obviously not the best home automation example, but I think you get the idea. I could see this being used to tell you any major events that happened in your home overnight or reading you your hyperlocal weather report. Thanks to the audio support you could even replace all of the default Alexa Flash Briefing sources with your own news feeds. Home Assistant supports both text and audio content as well as displaying data in the Alexa app. I also want to point out that unlike the existing Skill integration, the Flash Briefing API does _not_ require HTTPS (_but you should still be using HTTPS if possible_). For more information, check out the new [docs][flash-briefing-docs].
![You stay classy, San Diego. (It's funny, because balloob lives in San Diego))](/images/blog/2016-10-flash-briefing-updater-hacktoberfest/stay-classy.jpg) <p class='img'>
<img src='/images/blog/2016-10-flash-briefing-updater-hacktoberfest/stay-classy.jpg'>
You stay classy, San Diego. (It's funny, because balloob lives in San Diego))
</p>
## {% linkable_title Major breaking Z-Wave changes ahead %} ## {% linkable_title Major breaking Z-Wave changes ahead %}
@ -279,3 +292,4 @@ Thanks for reading all of the above, especially since this week was a pretty lon
[zero-two-seven-release]: /blog/2016/08/28/notifications-hue-fake-unification/ [zero-two-seven-release]: /blog/2016/08/28/notifications-hue-fake-unification/
[twitter]: https://twitter.com/home_assistant [twitter]: https://twitter.com/home_assistant
[robbie-twitter]: https://twitter.com/robbie [robbie-twitter]: https://twitter.com/robbie
[blog-orig]: https://github.com/home-assistant/home-assistant.github.io/blob/c937242d154e509d2d84d10c51f654e20556fa21/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown

Binary file not shown.

Before

Width:  |  Height:  |  Size: 649 KiB

After

Width:  |  Height:  |  Size: 230 KiB