feat: support multi space monitors !! by shahzad31 · Pull Request #1052 · elastic/synthetics

shahzad31 · 2025-07-18T04:08:57Z

To test the PR

You can create a dummy project and point it to the source of the directory like this

"@elastic/synthetics": "file:../../",

then you can specify spaces as an option in config or individula monitors using monitor.use

    monitor: {
      schedule: 10,
      locations: ['us_central'],
      spaces: ['test', 'default'],
    },

spaces in lightweight are also supported

heartbeat.monitors:
  - type: http
    name: Todos Lightweight Test 0
    id: todos-lightweight-test-0
    enabled: true
    urls: 'https://elastic.github.io/synthetics-demo'
    schedule: '@every 60m'
    timeout: 18s
    alert.status.enabled: true
    service.name: todos-lightweight-test
    namespace: food
    spaces:
      - '*'

Notes

Kibana API will throw an error if user is trying to create a monitor in non existent space
Kibana API will throw an error if user doesn't have permission to create monitors in a space
KIbana API will throw error if user is trying to use spaces option before prev 8.19, or 9.1.0 version
Project space Id is always appended, that means monitor is always created in a project space, besides user can also choose other spaces
monitor.use option will take precedent over project.monitor option

## Summary Follow up to #221568 This PR allows specifying spaces param in project monitors. Following use-cases have been supported User will be able to supports `spaces: ["defautl", "test"] ` Proper API tests have been added to provide additional coverage for the use-case. ### Validations - [ ] The route to which project api is being called should always be part of spaces if defined. - [ ] Non existent space will throw error - [ ] User must have permission to all specified spaces for CRUDS - [ ] User can also specify * to create monitors in all spaces ### PR Testing You can use following project monitors PR to test this PR elastic/synthetics#1052 First create few project monitors before this branch and then switch and specify multi spaces as part of the options and verify in UI that editing , adding and deletion works as expected on push command.

## Summary Follow up to elastic#221568 This PR allows specifying spaces param in project monitors. Following use-cases have been supported User will be able to supports `spaces: ["defautl", "test"] ` Proper API tests have been added to provide additional coverage for the use-case. ### Validations - [ ] The route to which project api is being called should always be part of spaces if defined. - [ ] Non existent space will throw error - [ ] User must have permission to all specified spaces for CRUDS - [ ] User can also specify * to create monitors in all spaces ### PR Testing You can use following project monitors PR to test this PR elastic/synthetics#1052 First create few project monitors before this branch and then switch and specify multi spaces as part of the options and verify in UI that editing , adding and deletion works as expected on push command. (cherry picked from commit 39d87d0)

# Backport This will backport the following commits from `main` to `9.1`: - [[Synthetics] Support projects multi spaces !! (#227674)](#227674)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Shahzad <shahzad31comp@gmail.com>

src/push/kibana_api.ts

vigneshshanmugam

I am bit confused as we use space specific URL format when pushing the monitors to Kibana -

synthetics/src/push/utils.ts

Line 149 in 1e444dc

    
           return `${url}/s/${options.space}/api/synthetics/project/${options.id}/monitors`;

But now, with this change how its a bit awkward, What happens to the URL format- would it be pushed to /default/ kibana endpoint?

vigneshshanmugam · 2025-07-21T17:50:21Z

src/core/runner.ts

      (journey.cb ?? journey.callback)({ params: options.params } as any);
      const monitor = journey.monitor ?? journey?._getMonitor();
      monitor.update(this.#monitor?.config);
+      monitor.setSpaces(


This should not be required as the .update call should handle the changes from the config. Please check once.

i will refactor

…nto multi-space

# Backport This will backport the following commits from `main` to `8.19`: - [[Synthetics] Support projects multi spaces !! (#227674)](#227674)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

## Summary Follow up to elastic#221568 This PR allows specifying spaces param in project monitors. Following use-cases have been supported User will be able to supports `spaces: ["defautl", "test"] ` Proper API tests have been added to provide additional coverage for the use-case. ### Validations - [ ] The route to which project api is being called should always be part of spaces if defined. - [ ] Non existent space will throw error - [ ] User must have permission to all specified spaces for CRUDS - [ ] User can also specify * to create monitors in all spaces ### PR Testing You can use following project monitors PR to test this PR elastic/synthetics#1052 First create few project monitors before this branch and then switch and specify multi spaces as part of the options and verify in UI that editing , adding and deletion works as expected on push command.

shahzad31 mentioned this pull request Jul 18, 2025

[Synthetics] Support projects multi spaces !! elastic/kibana#227674

Merged

4 tasks

handle multi spaces

4a0515c

shahzad31 force-pushed the multi-space branch from 96c3c96 to 4a0515c Compare July 21, 2025 12:08

shahzad31 marked this pull request as ready for review July 21, 2025 12:15

shahzad31 commented Jul 21, 2025

View reviewed changes

src/push/kibana_api.ts Outdated Show resolved Hide resolved

Update src/push/kibana_api.ts

0a40cd0

shahzad31 requested review from emilioalvap and vigneshshanmugam July 21, 2025 12:38

vigneshshanmugam reviewed Jul 21, 2025

View reviewed changes

shahzad31 added 3 commits July 21, 2025 20:00

PR feedback

cfc5d82

Merge branch 'multi-space' of https://github.com/elastic/synthetics i…

a569ce0

…nto multi-space

update tests

ced4443

shahzad31 added 3 commits July 23, 2025 15:03

update to emit empty spaces

7da7819

update tests

fd9195b

add unit tests

1edebf6

Merge branch 'main' into multi-space

ece38da

emilioalvap approved these changes Jul 28, 2025

View reviewed changes

shahzad31 merged commit 9f7f6fc into main Jul 28, 2025
8 checks passed

This was referenced Aug 20, 2025

[Synthetics UI] Add the ability to specify more spaces for a monitor #965

Closed

[Meta] [Synthetics] Cross-space monitors elastic/kibana#209139

Closed

shahzad31 deleted the multi-space branch August 20, 2025 13:11

shahzad31 mentioned this pull request Aug 20, 2025

[Internal]: Document multi space monitors elastic/docs-content#2635

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support multi space monitors !!#1052

feat: support multi space monitors !!#1052
shahzad31 merged 9 commits intomainfrom
multi-space

shahzad31 commented Jul 18, 2025 •

edited

Loading

Uh oh!

Uh oh!

vigneshshanmugam left a comment

Uh oh!

vigneshshanmugam Jul 21, 2025

Uh oh!

shahzad31 Jul 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

shahzad31 commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes

Uh oh!

Uh oh!

vigneshshanmugam left a comment

Choose a reason for hiding this comment

Uh oh!

vigneshshanmugam Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

shahzad31 Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shahzad31 commented Jul 18, 2025 •

edited

Loading