Skip to content
Permalink
Browse files

Update privacy.MD adding sample for results events.

  • Loading branch information
Arash Delijani
Arash Delijani committed Nov 9, 2019
1 parent e8fb21a commit d5f9656aaf642ac5889701150e95c0b83fac8790
Showing with 32 additions and 1 deletion.
  1. +32 −1 PRIVACY.md
@@ -57,7 +57,7 @@ The following items don't leave your computer and are not sent or shared with an

### Examples

This is a sample blob of data collected by Bento and sent to r2c:
This is a sample blob of usage data collected by Bento and sent to r2c:
```json
{
"X-R2C-Bento-Cli-Version": "0.3.1b2",
@@ -82,6 +82,37 @@ This is a sample blob of data collected by Bento and sent to r2c:
}
```

The following is a sample of the results data we collect:

```json
{
"X-R2C-Bento-Cli-Version": "0.3.1b2",
"X-R2C-Bento-User-Platform": "Linux-4.10.0-35-generic-x86_64-with-debian-9.11",
"X-R2C-Bento-User-Shell": "",
"check_id": "E999",
"client_ip": "35.231.49.0",
"hash_of_commit": "a6847d624cad44f9bb3ab40963842289e2fc5c6f",
"count": 1,
"filtered_count": 0,
"ignored_rules": [
"B009",
"B010",
"E101",
"E111",
"E114",
"E115",
"E116",
...
],
"path_hash": "c2d20e995af6b538c471ccfe0130a32ed950abcdcd4cd0c27e38160fab97c07f",
"repository_hash": "79d7408f2c194d95bc502660d46a7be8b838cab9ad24a09e32e29846f7a7d649",
"timestamp": "2019-11-08T23:56:59.251Z",
"tool": "r2c.flake8",
"ua": "python-requests/2.22.0"
}
```


### Description of fields

| Field | Description | Use case |

2 comments on commit d5f9656

@dmontagu

This comment has been minimized.

Copy link
Contributor

dmontagu replied Nov 9, 2019

@arashd super subtle nit -- looks like you guys also send the hash of the git email address to the metrics endpoint as a path parameter. Maybe I missed it but it doesn't look like that's documented anywhere. And technically I don't think it's equivalent in theory to any of the documented fields (maybe that's wrong though).

Practically speaking it probably doesn't matter, but given how otherwise thorough the PRIVACY.MD seems to be, figured I'd comment (no need to change anything just for me).

@arashd

This comment has been minimized.

Copy link
Collaborator

arashd replied Nov 11, 2019

Wow good eye for detail @dmontagu. Bento 0.4 will send telemetry to new endpoints. But we will still send that hash as part of the post body, only to keep our old telemetry dashboards from breaking while we wait for at least a few days of data to pour into our new tables. We'll be removing that as soon as that happens by EOW.

Please sign in to comment.
You can’t perform that action at this time.