Document Synthetics multispace CCS settings - #7571
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
| Alerting enables you to detect complex conditions using **rules** across Observability and send a notification using **connectors**. | ||
|
|
||
| When you create a new synthetic monitor, new default synthetics rules will be applied. To edit the default rules: | ||
| When you create a new synthetic monitor, Synthetics applies new default rules to the monitor. To edit the default rules: |
There was a problem hiding this comment.
| When you create a new synthetic monitor, Synthetics applies new default rules to the monitor. To edit the default rules: | |
| When you create a new synthetic monitor, Synthetics applies default rules to the monitor. To edit the default rules: |
| When you create a new synthetic monitor, Synthetics applies new default rules to the monitor. To edit the default rules: | ||
|
|
||
| 1. Click **Alerts** in the top bar. | ||
| 1. Click **Alerts** in the global header. |
There was a problem hiding this comment.
| 1. Click **Alerts** in the global header. | |
| 1. Click **Alerts** in the application menu. |
The global header is this
See https://www.elastic.co/docs/contribute-docs/style-guide/ui-writing#naming-kibana-ui-elements
There was a problem hiding this comment.
Oh ok, thanks!
| If you need specific alerting behavior, set up a different rule. To view all existing rules or create a new rule: | ||
|
|
||
| 1. Click **Alerts** in the top bar. | ||
| 1. Click **Alerts** in the global header. |
There was a problem hiding this comment.
| 1. Click **Alerts** in the global header. | |
| 1. Click **Alerts** in the application menu. |
|
|
||
| There are several Synthetics settings you can adjust in Observability. | ||
|
|
||
| ## Alerting [synthetics-settings-alerting] |
There was a problem hiding this comment.
This section is overall quite hard to read/understand and I think fails at explaining the core things clearly. It's not in the scope of your PR here, but I think it's worth creating an issue to rewrite at least the Alerting section, and/or see if it needs its own page.
If you update a rule, does the change apply to all monitors it's active on, or only new ones?
We say we can disable them for individual monitors but don't mention the option that controls it, etc.
|
|
||
| ## Remote clusters [synthetics-settings-remote-clusters] | ||
| ```{applies_to} | ||
| stack: ga 9.5+ |
There was a problem hiding this comment.
| stack: ga 9.5+ | |
| stack: ga 9.5+ | |
| serverless: unavailable |
|
|
||
| In the **Remote clusters** tab, you can configure {{ccs}} ({{ccs-init}}) settings so that Synthetics can include monitor data from remote {{es}} clusters alongside your local monitors. | ||
|
|
||
| These settings apply to one or more {{kib}} spaces. Changes you make here affect all spaces that have access to these settings. |
There was a problem hiding this comment.
I think this sentence relates to the last subsection here but it's not super clear to me what it means. Is it: "You can apply these settings to other {{kib}} spaces." or "These settings only apply to the default space by default, but you can specify other spaces to share that configuration across them"? or something else.
|
|
||
| ### Spaces with access [synthetics-settings-remote-clusters-spaces] | ||
|
|
||
| Use the **Spaces** combo box to control which {{kib}} spaces these {{ccs-init}} settings apply to. You can select individual spaces, multiple spaces, or **All spaces** to share the settings across your entire deployment. Removing a space from the selection hides these settings in that space. |
There was a problem hiding this comment.
"individual spaces" (plural) / "multiple spaces" means the same thing. From what I see you either pick spaces individually, or select All spaces.
I'm not clear about the "removing..." part. Are the settings actually hidden (for me hidden means you can't configure it there anymore)? Or does that space just get to keep its own individual ccs configuration, not shared?
|
|
||
| Use the **Spaces** combo box to control which {{kib}} spaces these {{ccs-init}} settings apply to. You can select individual spaces, multiple spaces, or **All spaces** to share the settings across your entire deployment. Removing a space from the selection hides these settings in that space. | ||
|
|
||
| If you leave the field empty, the current sharing configuration remains unchanged. |
There was a problem hiding this comment.
So we shouldn't even have the current space listed?
| In complex environments, it’s common to have multiple task-specific {{stack}} deployments with one centralized overview cluster using {{ccs}} or {{ccr}} to centralize {{kib}} dashboards and apps. **Do not use this pattern with the Synthetics UI**. Instead, configure your synthetic monitors directly on the {{kib}} instance where you want to view and manage them. | ||
|
|
||
| You may, however, use Dashboards and the Discover feature with CCS to view `synthetics-*` indices. | ||
| You may, however, use the Dashboards and the Discover app with {{ccs-init}} to view `synthetics-*` indices. |
There was a problem hiding this comment.
| You may, however, use the Dashboards and the Discover app with {{ccs-init}} to view `synthetics-*` indices. | |
| You may, however, use the Dashboards and the Discover apps with {{ccs-init}} to view `synthetics-*` indices. |
Those are 2 different apps, if you want to keep the "app" word.
| % Stateful only for do not use... section | ||
|
|
||
| ## Do not use the Synthetics UI with CCS/CCR [synthetics-no-ccs-ccr] | ||
| ## Do not use the Synthetics UI with {{ccs-init}}/{{ccr-init}} [synthetics-no-ccs-ccr] |
There was a problem hiding this comment.
You added another section below but the difference is not made super clear. Maybe it would help to also add a reference to the actual integrated feature in here. Like "Do not use this pattern xxx, but instead use yyy". Or maybe combine these 2 into a single section that makes sense of the overall remote cluster + Synthetics story and recommendations.
Summary
Resolves: https://github.com/elastic/docs-content-internal/issues/1492
Generative AI disclosure
Did you use a generative AI (GenAI) tool to assist in creating this contribution?
If you answered Yes to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).
Tool(s) and model(s) used: Claude Opus 4.8