From c6e5add28a60ad83ec949fe9d6200b31bfc48d2a Mon Sep 17 00:00:00 2001 From: Tanmai Gopal Date: Mon, 28 Jan 2019 22:27:39 +0530 Subject: [PATCH] update telemetry docs (#1499) --- docs/graphql/manual/guides/telemetry.rst | 39 ++++++++++++------------ 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/graphql/manual/guides/telemetry.rst b/docs/graphql/manual/guides/telemetry.rst index e820b14b97b..b06807ac3ca 100644 --- a/docs/graphql/manual/guides/telemetry.rst +++ b/docs/graphql/manual/guides/telemetry.rst @@ -12,22 +12,20 @@ The Hasura GraphQL Engine collects anonymous telemetry data that helps the Hasura team in understanding how the product is being used and in deciding what to focus on next. -The data collected is minimal and, since there is no *sign-in* associated with -the GraphQL Engine, it **cannot be used to uniquely identify any user**. -Furthermore, data collected is strictly statistical in nature and -**no proprietary information is collected** (*please see the next section*). +The data collected is minimal, statistical in nature and +**cannot be used to uniquely identify a user**. Please see the +next section to see what data is collected and sent. Access to collected +data is strictly limited to the Hasura team and not shared with 3rd parties. -As a growing community, we greatly appreciate the telemetry data users -send to us, as it is very valuable in making GraphQL Engine a better product -for everyone. If you are worried about privacy, you can choose to disable -sending telemetry as described :ref:`here `. +As a growing community, we greatly appreciate the usage data users +send to us, as it is very valuable in helping us make the Hasura GraphQL +engine a better product for everyone! However, if you are concerned about +sending usage stats, you can choose to disable telemetry as +described :ref:`here `. -.. note:: - Access to collected data is strictly limited to the Hasura team and not shared with 3rd parties. - -What data are collected? ------------------------- +What data is collected? +----------------------- Server ~~~~~~ @@ -46,7 +44,7 @@ Here is a sample row from the telemetry database: "timestamp": "2019-01-21T19:43:33.63838+00:00", "db_uid": "dddff371-dab2-450f-9969-235bca66dab1", "instance_uid": "6799360d-a431-40c5-9f68-24592a9f07df", - "version": "v1.0.0-alpha35", + "version": "v1.0.0-alpha36", "metrics": { "views": 1, "tables": 2, @@ -71,8 +69,8 @@ Here is a sample row from the telemetry database: Console ~~~~~~~ -The console is a React-Redux UI. Redux action names along with anonymized -route names are sent without any identifiable information or payload. Console +The console is a React-Redux app. Redux action names along with anonymized +route names are sent without any identifiable information or payload. The console also records the UUID of the server/CLI that it is connected to. Here is a sample: @@ -86,10 +84,13 @@ Here is a sample: "event_type": "ModifyTable/RESET", "console_mode": "server", "server_uuid": "79485a57-fca5-40f3-a31b-78c0d211314b", - "server_version": "v1.0.0-alpha35", + "server_version": "v1.0.0-alpha36", "cli_uuid": null } +Please note, that ``TABLE_NAME`` and ``SCHEMA_NAME`` are not placeholders. +The actual names of the tables, schemas, remote-schemas and event-triggers that +are a part of the URL are not sent. CLI ~~~ @@ -116,7 +117,7 @@ Sample data: "os_platform": "linux", "os_arch": "amd64", "server_uuid": "a4d66fb2-f88d-457b-8db1-ea7a0b57921d", - "server_version": "v1.0.0-alpha35", + "server_version": "v1.0.0-alpha36", "payload": null } @@ -141,7 +142,7 @@ the flag ``--enable-telemetry=false``: In order to turn off telemetry on CLI and on the console served by CLI, you can set the same environment varibale on the machine running CLI. You can also set ``"enable_telemetry": false`` in the JSON file created -by the CLI at ``~/.hasura/.config.json`` to perisist the setting. +by the CLI at ``~/.hasura/config.json`` to perisist the setting. Privacy Policy --------------