From 7b619569b0a28f7c0ae561abf7fa2fcc61577700 Mon Sep 17 00:00:00 2001 From: Ahmad Bamieh Date: Tue, 26 Jan 2021 13:50:40 +0200 Subject: [PATCH] update docs --- .../server/collectors/management/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/README.md b/src/plugins/kibana_usage_collection/server/collectors/management/README.md index 87a3834184b57..38f45dc802c2b 100644 --- a/src/plugins/kibana_usage_collection/server/collectors/management/README.md +++ b/src/plugins/kibana_usage_collection/server/collectors/management/README.md @@ -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. ```