Manage monitors
editManage monitors
editAfter you’ve created a synthetic monitor, you’ll need to manage that monitor over time. This might include updating or permanently deleting an existing monitor.
If you’re using Project Monitors, you should also set up a workflow that uses best practices for managing monitors effectively in a production environment.
Update a monitor
editYou can update a monitor’s configuration, for example, changing the interval at which the monitor runs a test.
You can also update the journey used in a browser monitor. For example, if you update the UI used in your application, you may want to update your journey’s selectors and assertions.
If you set up the monitor using Heartbeat, update the relevant options in the Heartbeat configuration file, and the changes will be reflected in the monitors.
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.
If you set up the monitor using Project Monitors,
you’ll update the monitor in the project source and then push changes.
For lightweight monitors, make changes to the YAML file.
For browser monitors, you can update the configuration of one or more monitors:
-
To update the configuration of an individual monitor, edit the journey directly in
the JavaScript or TypeScript files, specifically the options in
monitor.use. - To update the configuration of all monitors in a project, edit the global synthetics configuration file.
To update the journey a browser monitor runs, edit the journey code directly and test the updated journey locally to make sure it’s valid.
After making changes to the monitors, run the push command
to replace the existing monitors in Kibana with new monitors using the updated
configuration or journey code.
Updates are linked to a monitor’s id. To update a monitor you must keep its id the same.
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.
If you set up the monitor using the Uptime app UI, you can update the monitor configuration of both lightweight and browser monitors in the Uptime app’s UI:
- Go to Monitor Management.
- Click the pencil icon next to the monitor you want to edit.
-
Update the Monitor settings as needed.
- To update the journey used in a browser monitor, edit Inline script.
- Make sure to click Run test to validate the new journey before updating the monitor.
- Click Update monitor.
Delete a monitor
editEventually you might want to delete a monitor altogether. For example, if the user journey you were validating no longer exists.
If you set up the monitor using Heartbeat,
delete the monitor entry in the heartbeat.yml file.
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.
If you set up the monitor using Project Monitors, you’ll delete the monitor from the project source and push changes.
For lightweight monitors, delete the monitor from the YAML file.
For browser monitors, delete the full journey from the JavaScript or TypeScript file.
Then, run the push command.
The monitor associated with that journey that existed in Kibana will be deleted.
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.
If you set up the monitor using the Uptime app UI, you can delete a lightweight or browser monitor in the Uptime app’s UI:
- Go to Monitor Management.
- Click the trash can icon next to the monitor you want to delete.
Alternatively, you can temporarily disable a monitor by updating the monitor’s configuration in your journey’s code or on the Uptime app’s Monitor Management page using the Enabled toggle.
Implement best practices for projects
editThis is only relevant to monitors created using projects.
After you’ve set up a project, there are some best practices you can implement to manage Project Monitors effectively.
Use version control
editFirst, it’s recommended that you version control all files in Git. If your project is not already in a version controlled directory add it and push it to your Git host.
Set up recommended workflow
editWhile it can be convenient to run the push command directly from your workstation,
especially when setting up a new project, it is not recommended for production environments.
Instead, we recommended that you:
- Develop and test changes locally.
- Create a pull request for all config changes.
-
Have your CI service automatically verify the PR by running
npx @elastic/synthetics .Elastic’s synthetics runner can output results in a few different formats, including JSON and JUnit (the standard format supported by most CI platforms).
If any of your journeys fail, it will yield a non-zero exit code, which most CI systems pick up as a failure by default.
- Have a human approve the pull request.
- Merge the pull request.
-
Have your CI service automatically deploy the change by running
npx @elastic/synthetics pushafter changes are merged.
The exact implementation details will depend on the CI system and Git host you use.
You can reference the sample GitHub configuration file that is included in the .github
directory when you create a new project.