Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bamieh committed Jan 26, 2021
1 parent e8fb492 commit 7b61956
Showing 1 changed file with 10 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
The Usage Collector `stack_management` reports user changed settings.
All user changed UI Settings are automatically collected.

After adding a new setting you will be required -via our api_integration tests- to update the [schema](./schema.ts) of the management collector and the [UsageStats](./types.ts) interface.

If you forget our telemetry check will help you through the process! You can then run the checker with `--fix` flag to automatically fix the mappings

```
node scripts/telemetry_check --fix
```

## Sensitive fields

If the configured UI setting might contain user sensitive information simply add the property `sensitive: true` to the ui setting registration config.

```
Expand Down

0 comments on commit 7b61956

Please sign in to comment.