IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create a synthetic monitor Synthetics command reference »

› › ›

Manage synthetic monitors

edit

Manage synthetic monitors

edit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

After you’ve created a synthetic monitor, you can update the contents of the tests that they run, update the monitor’s configuration, and permanently delete monitors.

The way you manage browser monitors will depend on how you created the monitor:

If you used Project monitors, you’ll manage the monitors using the monitor API or in Kibana’s Monitor Management UI.
If you used Heartbeat, you’ll manage the monitors in the Heartbeat config file.
If you used Elastic Agent, you’ll manage the monitors in Kibana’s Integrations UI.

Update a journey

edit

After you create a monitor, you might want to update the journey it runs. If you update your UI, for example, you may want to update your journey’s selectors and assertions.

Update the tests in the directory specified in the source.zip_url you referenced in the Heartbeat configuration file, and the changes will be reflected in the monitors.

If you’re using inline monitors within your heartbeat.yml configuration file, update your monitors directly in that file.

If you’re using project monitors, you can update journeys directly through code. Then run the push command to replace any existing monitors from this project in Kibana with new monitors that use the updated test.

Updates are linked to a monitor’s id. To update a monitor you must keep its id the same.

Update a monitor’s configuration

edit

You might also want to update the monitor’s configuration. For example, you might want to change the interval at which the monitor runs a test.

Update the relevant options in the Heartbeat configuration file, and the changes will be reflected in the monitors.

Update the monitor configuration options used in individual journeys in the test code (or in the global synthetics configuration file). Then run the push command to replace the existing monitor in Kibana with a new monitor that uses the updated configuration options.

Delete a synthetic monitor

edit

Eventually you might want to delete a monitor altogether. For example, if the user journey you were validating no longer exists.

Alternatively, you can temporarily disable a monitor by updating the monitor’s configuration in your journey’s code.

To remove a monitor using Heartbeat, delete the monitor entry in the heartbeat.yml file.

Delete the journey in the test code and push the project using the push command. The monitor associated with that journey that existed in Kibana will be deleted.

« Create a synthetic monitor Synthetics command reference »