Skip to content

Commit f17b81f

Browse files
eokoneyoeokoneyo
authored
Document cloud config for product intercept (#227688)
## Summary Add documentation of cloud config for product intercept. Configs will be added to cloud through the following PR elastic/cloud#141517 <!--### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [ ] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... -->
1 parent fedd325 commit f17b81f

4 files changed

Lines changed: 25 additions & 1 deletion

File tree

‎docs/reference/cloud/elastic-cloud-kibana-settings.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@ stack: ga 9.1
8282
`xpack.banners.linkColor`
8383
: The color for the banner link text. Defaults to `#0B64DD`.
8484

85+
`xpack.product_intercept.enabled`
86+
: Enable or disable Elastic product feedback prompts. Defaults to `true`.
87+
88+
`xpack.product_intercept.interval`:
89+
: Set the time that elapses between Elastic product feedback prompts. The time is formatted as a number and a time unit (d,h,m,s). For example, 20m, 24h, 7d. Defaults to `90d`.
90+
8591
### Version 8.18+ [ec_version_8_18]
8692

8793
`xpack.fleet.enableManagedLogsAndMetricsDataviews`

‎docs/reference/configuration-reference.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ The settings are grouped by feature or purpose, for example:
2929
- [Spaces](/reference/configuration-reference/spaces-settings.md)
3030
- [Task Manager](/reference/configuration-reference/task-manager-settings.md)
3131
- [Telemetry](/reference/configuration-reference/telemetry-settings.md)
32-
- [URL drilldown](/reference/configuration-reference/url-drilldown-settings.md)
32+
- [URL drilldown](/reference/configuration-reference/url-drilldown-settings.md)
33+
- [Product intercept](/reference/configuration-reference/product-intercept-settings.md)

‎docs/reference/configuration-reference/product-intercept-settings.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
navigation_title: "Product intercept settings"
3+
mapped_pages:
4+
- https://www.elastic.co/guide/en/kibana/current/product-intercept-settings-kb.html
5+
applies_to:
6+
deployment:
7+
self: ga 9.1
8+
---
9+
10+
# Product intercept settings in {{kib}} [product-intercept-settings-kb]
11+
12+
Configure the product intercept settings in your `kibana.yml` configuration file.
13+
A product intercept is a prompt for feedback about the Elastic product that appears periodically in the Kibana UI.
14+
15+
`xpack.product_intercept.enabled`
16+
: Enable or disable Elastic product feedback prompts. Defaults to `true`.

‎docs/reference/toc.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ toc:
2525
- file: configuration-reference/task-manager-settings.md
2626
- file: configuration-reference/telemetry-settings.md
2727
- file: configuration-reference/url-drilldown-settings.md
28+
- file: configuration-reference/product-intercept-settings.md
2829
- file: advanced-settings.md
2930
- file: kibana-audit-events.md
3031
- file: connectors-kibana.md

0 commit comments

Comments
 (0)