Skip to content

Commit

Permalink
feat: send integration with telemetry data
Browse files Browse the repository at this point in the history
  • Loading branch information
@bmoxb
bmoxb authored Nov 19, 2021
1 parent 663b73d commit 7d03fbe
Show file tree
Hide file tree
Showing 3 changed files with 197 additions and 143 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ To compile from source, see the `Compiling from source` tab in the [docs](https:

## Running Tests

Synth has reasonable test coverage - and we are working on improving this
every day. We encourage PRs to come with tests. If you're not sure about
Synth has reasonable test coverage - and we are working on improving this
every day. We encourage PRs to come with tests. If you're not sure about
what a test should look like, feel free to get in touch.

To run the test suite - just run `cargo test` at the root of the repository.
Expand All @@ -22,7 +22,7 @@ We use the [Angular Commit Guidelines](https://github.com/angular/angular/blob/m

Furthermore, commits should be squashed before being merged to master.

Also, make sure your commits don't trigger any warnings from Clippy by running: `cargo clippy --tests --all-targets`. If you have a good reason to contradict Clippy, insert an #allow[] macro, so that it won't complain.
Also, make sure your commits don't trigger any warnings from Clippy by running: `cargo clippy --tests --all-targets --all-features`. If you have a good reason to contradict Clippy, insert an #allow[] macro, so that it won't complain.

Plus, make sure your commits are properly formatted. You can automate this
Plus, make sure your commits are properly formatted. You can automate this
process by copying over the `pre-commit` file in `tools/hooks/pre-commit` to `.git/hooks/pre-commit` which will make git automatically format your code before committing them.
290 changes: 157 additions & 133 deletions docs/docs/other/telemetry.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ contact `opensource@getsynth.com`.

## What does Synth collect?

Synth's telemetry collects 7 fields:
Synth's telemetry collects 8 fields:

- `distinct_id`: A randomly generated UUID stored
at `~/.config/synth/config.json`
Expand All @@ -76,150 +76,174 @@ Synth's telemetry collects 7 fields:
- `timestamp`: The time at which the command was issued. For
example `2021-05-06T16:13:40.084Z`.
- `generators`: A list of generators that were used by the `generate` command. For example `string::title, number::I32::Range`.
- `integration`: The integration used in a `generate` or `import` command. For example `json`, `postgres`, etc.

Below is the [Synth schema][synth-schema] of PostHog events posted by `synth`'s
activity:

```json synth
{
"type": "object",
"distinct_id": {
"type": "string",
"uuid": {}
},
"command": {
"type": "string",
"categorical": {
"import": 1,
"generate": 10,
"init": 1,
"telemetry::enabled": 10,
"telemetry::disabled": 1
}
},
"version": {
"type": "string",
"pattern": "v0\\.4\\.3"
},
"os": {
"type": "string",
"categorical": {
"linux": 10,
"macos": 10,
"windows": 10
}
},
"timestamp": {
"type": "date_time",
"format": "%Y-%m-%dT%H:%M:%S",
"subtype": "naive_date_time",
"begin": "2015-01-01T00:00:00",
"end": "2020-01-01T12:00:00"
},
"generators": {
"type": "object",
"distinct_id": {
"type": "string",
"uuid": {}
},
"command": {
"type": "string",
"serialized": {
"serializer": "json",
"categorical": {
"import": 1,
"generate": 10,
"init": 1,
"telemetry::enabled": 10,
"telemetry::disabled": 1
}
},
"version": {
"type": "string",
"pattern": "v0\\.4\\.3"
},
"os": {
"type": "string",
"categorical": {
"linux": 10,
"macos": 10,
"windows": 10
}
},
"timestamp": {
"type": "date_time",
"format": "%Y-%m-%dT%H:%M:%S",
"subtype": "naive_date_time",
"begin": "2015-01-01T00:00:00",
"end": "2020-01-01T12:00:00"
},
"generators": {
"type": "string",
"serialized": {
"serializer": "json",
"content": {
"type": "array",
"length": {
"type": "number",
"subtype": "u64",
"range": {
"low": 2,
"high": 20
}
},
"content": {
"type": "array",
"length": {
"type": "number",
"subtype": "u64",
"range": {
"low": 2,
"high": 20
}
},
"content": {
"type": "string",
"categorical": {
"string::first_name": 2,
"string::last_name": 2,
"string::title": 2,
"string::suffix": 2,
"string::name": 2,
"string::name_with_title": 2,
"string::credit_card": 2,
"string::free_email_provider": 2,
"string::domain_suffix": 2,
"string::free_email": 2,
"string::safe_email": 2,
"string::username": 2,
"string::ipv4": 2,
"string::ipv6": 2,
"string::ip": 2,
"string::mac_address": 2,
"string::color": 2,
"string::user_agent": 2,
"string::rfc_status_code": 2,
"string::valid_status_code": 2,
"string::company_suffix": 2,
"string::company_name": 2,
"string::buzzword": 2,
"string::buzzword_muddle": 2,
"string::buzzword_tail": 2,
"string::catch_phrase": 2,
"string::bs_verb": 2,
"string::bs_adj": 2,
"string::bs_noun": 2,
"string::bs": 2,
"string::profession": 2,
"string::industry": 2,
"string::city_prefix": 2,
"string::city_suffix": 2,
"string::city_name": 2,
"string::country_name": 2,
"string::country_code": 2,
"string::street_suffix": 2,
"string::street_name": 2,
"string::time_zone": 2,
"string::state_name": 2,
"string::state_abbr": 2,
"string::secondary_address_type": 2,
"string::secondary_address": 2,
"string::zip_code": 2,
"string::post_code": 2,
"string::building_number": 2,
"string::latitude": 2,
"string::longitude": 2,
"string::phone_number": 2,
"string::cell_number": 2,
"string::file_path": 2,
"string::file_name": 2,
"string::file_extension": 2,
"string::dir_path": 2,
"string::pattern": 2,
"string::categorical": 2,
"string::serialized": 2,
"string::uuid": 2,
"string::trancated": 2,
"string::format": 2,
"number::I32::Range": 10,
"number::U32::Range": 10,
"number::F32::Range": 10,
"number::I64::Range": 10,
"number::U64::Range": 10,
"number::F64::Range": 10,
"bool::constant": 3,
"bool::frequency": 3,
"bool::categorical": 3,
"series::cyclical": 1,
"series::poisson": 1,
"series::incrementing": 1,
"series::zip": 1,
"null": 1,
"date_time": 1,
"array": 1,
"object": 1,
"same_as": 1,
"one_of": 1,
"unique": 1,
"hidden": 1
}
"type": "string",
"categorical": {
"string::first_name": 2,
"string::last_name": 2,
"string::title": 2,
"string::suffix": 2,
"string::name": 2,
"string::name_with_title": 2,
"string::credit_card": 2,
"string::free_email_provider": 2,
"string::domain_suffix": 2,
"string::free_email": 2,
"string::safe_email": 2,
"string::username": 2,
"string::ipv4": 2,
"string::ipv6": 2,
"string::ip": 2,
"string::mac_address": 2,
"string::color": 2,
"string::user_agent": 2,
"string::rfc_status_code": 2,
"string::valid_status_code": 2,
"string::company_suffix": 2,
"string::company_name": 2,
"string::buzzword": 2,
"string::buzzword_muddle": 2,
"string::buzzword_tail": 2,
"string::catch_phrase": 2,
"string::bs_verb": 2,
"string::bs_adj": 2,
"string::bs_noun": 2,
"string::bs": 2,
"string::profession": 2,
"string::industry": 2,
"string::city_prefix": 2,
"string::city_suffix": 2,
"string::city_name": 2,
"string::country_name": 2,
"string::country_code": 2,
"string::street_suffix": 2,
"string::street_name": 2,
"string::time_zone": 2,
"string::state_name": 2,
"string::state_abbr": 2,
"string::secondary_address_type": 2,
"string::secondary_address": 2,
"string::zip_code": 2,
"string::post_code": 2,
"string::building_number": 2,
"string::latitude": 2,
"string::longitude": 2,
"string::phone_number": 2,
"string::cell_number": 2,
"string::file_path": 2,
"string::file_name": 2,
"string::file_extension": 2,
"string::dir_path": 2,
"string::pattern": 2,
"string::categorical": 2,
"string::serialized": 2,
"string::uuid": 2,
"string::trancated": 2,
"string::format": 2,
"number::I32::Range": 10,
"number::U32::Range": 10,
"number::F32::Range": 10,
"number::I64::Range": 10,
"number::U64::Range": 10,
"number::F64::Range": 10,
"bool::constant": 3,
"bool::frequency": 3,
"bool::categorical": 3,
"series::cyclical": 1,
"series::poisson": 1,
"series::incrementing": 1,
"series::zip": 1,
"null": 1,
"date_time": 1,
"array": 1,
"object": 1,
"same_as": 1,
"one_of": 1,
"unique": 1,
"hidden": 1
}
}
}
}
},
"integration": {
"type": "one_of",
"variants": [
{
"weight": 0.5,
"type": "string",
"categorical": {
"json": 1,
"jsonl": 1,
"csv": 1,
"postgres": 1,
"postgresql": 1,
"mongodb": 1,
"mysql": 1,
"mariadb": 1
}
},
{
"weight": 0.5,
"type": "null"
}
]
}
}
```

Expand Down
Loading

0 comments on commit 7d03fbe

Please sign in to comment.