-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add documentation to management collector
- Loading branch information
Showing
3 changed files
with
27 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
src/plugins/kibana_usage_collection/server/collectors/management/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# User-changed UI Settings - Management Collector | ||
|
||
The Usage Collector `stack_management` reports user changed settings. | ||
All user changed UI Settings are automatically collected. | ||
|
||
If the configured UI setting might contain user sensitive information simply add the property `sensitive: true` to the ui setting registration config. | ||
|
||
``` | ||
uiSettings.register({ | ||
[NEWS_FEED_URL_SETTING]: { | ||
name: i18n.translate('xpack.securitySolution.uiSettings.newsFeedUrl', { | ||
defaultMessage: 'News feed URL', | ||
}), | ||
value: NEWS_FEED_URL_SETTING_DEFAULT, | ||
sensitive: true, | ||
description: i18n.translate('xpack.securitySolution.uiSettings.newsFeedUrlDescription', { | ||
defaultMessage: '<p>News feed content will be retrieved from this URL</p>', | ||
}), | ||
category: [APP_ID], | ||
requiresPageReload: true, | ||
schema: schema.string(), | ||
}, | ||
}), | ||
``` | ||
|
||
The value of any UI setting marked as `sensitive` will be reported as a boolean `true` instead of the actual value. This hides the actual sensitive information while giving us some intelligence over which fields the users are interactive with the most. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters