-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS-11578] Adding Version History doc for Synthetics #30754
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
git-thuerk-done
merged 12 commits into
master
from
aliciascott/DOCS-11578-Synthetics-version-history
Aug 12, 2025
Merged
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3bbb226
Adding Version History doc for Synthetics
b8008e3
Adding version history to further reading and other pages
b014306
changing doc to guide
325d27d
fixing multistep
31b933b
cleaning up further reading links
99c0bbc
fix further reading links on getting started - synthetics - api tests
9617369
Merge branch 'master' into aliciascott/DOCS-11578-Synthetics-version-…
6b93a4c
remove references to run a previous version
6f3693c
removing multi-env testing bullet/replacing with clone test description
f12605e
Merge branch 'master' into aliciascott/DOCS-11578-Synthetics-version-…
07d7b9c
Apply suggestions from Michael's review
f8ef9e3
fix wording
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| title: Version History for Synthetic Monitoring | ||
|
|
||
| further_reading: | ||
| - link: '/getting_started/synthetics/' | ||
| tag: 'Documentation' | ||
| text: 'Getting Started with Synthetic Monitoring' | ||
| - link: "/account_management/audit_trail/" | ||
| tag: "documentation" | ||
| text: "Audit Trail Overview" | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| Version History automatically tracks changes made to your Synthetic Monitoring tests and saves previous versions so you can see exactly what was changed and by whom. You can run a previous version of a test, restore your test to any saved version, or clone a version to create a new Synthetic Monitoring test. | ||
|
|
||
| Version History allows you to: | ||
|
|
||
| - **Troubleshoot failing tests**: Determine whether a recent change introduced the failure. | ||
| - **Collaborate with teammates**: See who made changes and what was updated. | ||
| - **Roll back tests**: Restore a previous version after a deployment rollback or incorrect update. | ||
| - **Support multi-environment testing**: Deploy different test versions to match the code running in each environment, ensuring tests remain compatible with environment-specific deployments. | ||
git-thuerk-done marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| All Synthetic Monitoring tests retain 30 days worth of version history by default. In order to see any previous versions, an edit must be made within the last 30 days. | ||
|
|
||
| With [Audit Trail][1] enabled, the version history is extended from 30 days to 90 days. After enabling Audit Trail, you are able to see any edits made between 30 to 90 days ago on all existing Synthetic tests. | ||
|
|
||
| ## View versions | ||
|
|
||
| From an individual Synthetic Monitoring test, click the settings menu on the top right of the page and select Version History. If there are no edits within the retention period, Version History is disabled. | ||
|
|
||
| {{< img src="/synthetics/guide/version_history/synthetics_version_history.png" alt="Synthetic Monitoring Version history menu" style="width:70%;" >}} | ||
|
|
||
| The Version History side panel shows changes in chronological order. Each entry displays the fields that were modified, the values before and after, the user who made the change, and timestamp. Use the context menu to restore, clone, or run any version. | ||
|
|
||
| ## Restore a version | ||
|
|
||
| From the Version History side panel, after you choose the version to restore, click the kebab menu to the right of a user profile and select "Restore this test version". | ||
git-thuerk-done marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Restoring a version updates the test and creates a new version history entry documenting the restore action, displaying any steps that were added or removed to the test. Your existing change history remains intact, allowing you to restore any version within the retention period. | ||
|
|
||
| {{< img src="/synthetics/guide/version_history/synthetics_restore_version.png" alt="Synthetic Monitoring Version history menu" style="width:60%;" >}} | ||
|
|
||
| ## Clone a version | ||
|
|
||
| To create a new test based on a previous version without modifying your current test, you can clone any version from your history. In the Version History side panel, select the desired version, click the kebab menu next to the user profile, and choose "Clone to a new test." | ||
git-thuerk-done marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Version History retention | ||
| | | Retention Period | | ||
| | ----------------------- | ------- | | ||
| | Audit Trail **Disabled** | 30 days | | ||
| | Audit Trail **Enabled** | 90 days | | ||
|
|
||
| ## Further Reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: /account_management/audit_trail/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+228 KB
static/images/synthetics/guide/version_history/synthetics_restore_version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+53.6 KB
static/images/synthetics/guide/version_history/synthetics_version_history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.