Skip to content

[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
merged 12 commits into from
Aug 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions content/en/getting_started/synthetics/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Getting Started with Synthetic Monitoring
further_reading:
- link: 'https://learn.datadoghq.com/courses/intro-to-synthetic-tests'
- link: 'https://learn.datadoghq.com/courses/getting-started-with-synthetic-browser-testing'
tag: 'Learning Center'
text: 'Introduction to Synthetic Tests'
text: 'Getting Started with Synthetic Browser Testing'
- link: '/synthetics/api_tests'
tag: 'Documentation'
text: 'Learn more about API tests'
Expand Down Expand Up @@ -55,6 +55,10 @@ To set up your first Synthetic test with Datadog, choose from the following opti
- [Create a mobile test][6] to start testing key business workflows on your Android and iOS applications.
- [Create a private location][5] to start monitoring internal applications using all Synthetic test types.

## Version History

Use [Version History in Synthetic Monitoring][8] to restore your test to any saved version, or clone a version to create a new Synthetic Monitoring test.

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}
Expand All @@ -66,3 +70,4 @@ To set up your first Synthetic test with Datadog, choose from the following opti
[5]: /getting_started/synthetics/private_location/
[6]: /getting_started/synthetics/mobile_app_testing/
[7]: /getting_started/continuous_testing/
[8]: /synthetics/guide/version_history/
6 changes: 0 additions & 6 deletions content/en/getting_started/synthetics/api_test.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
---
title: Getting Started with API Tests
further_reading:
- link: 'https://learn.datadoghq.com/courses/intro-to-synthetic-tests'
tag: 'Learning Center'
text: 'Introduction to Synthetic Tests'
- link: '/api/latest/synthetics/#create-an-api-test'
tag: 'API'
text: 'Create an API test programmatically'
- link: '/synthetics/api_tests'
tag: 'Documentation'
text: 'Learn more about single API tests'
- link: '/synthetics/multistep'
tag: 'Documentation'
text: 'Learn more about multistep API tests'
- link: '/getting_started/synthetics/private_location'
tag: 'Documentation'
text: 'Learn about private locations'
Expand Down
4 changes: 2 additions & 2 deletions content/en/getting_started/synthetics/browser_test.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Getting Started with Browser Tests
further_reading:
- link: 'https://learn.datadoghq.com/courses/intro-to-synthetic-tests'
- link: 'https://learn.datadoghq.com/courses/getting-started-with-synthetic-browser-testing'
tag: 'Learning Center'
text: 'Introduction to Synthetic Tests'
text: 'Getting Started with Synthetic Browser Testing'
- link: '/synthetics/browser_tests'
tag: 'Documentation'
text: 'Learn more about browser tests'
Expand Down
16 changes: 6 additions & 10 deletions content/en/synthetics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ further_reading:
- link: "https://app.datadoghq.com/release-notes?category=Synthetic%20Monitoring"
tag: "Release Notes"
text: "Check out the latest Datadog Synthetic Monitoring releases! (App login required)"
- link: "https://www.datadoghq.com/blog/introducing-synthetic-monitoring/"
tag: "Blog"
text: "Introduction to Datadog Synthetic Monitoring"
- link: "https://www.datadoghq.com/blog/monitor-cdn-performance-with-synthetic-testing/"
tag: "Blog"
text: "Monitor CDN performance within your Synthetic tests"
- link: "https://www.datadoghq.com/blog/static-web-application-monitoring-best-practices/"
tag: "Blog"
text: "Best practices for monitoring static web applications"
- link: "https://www.datadoghq.com/blog/api-test-coverage-monitoring-datadog-synthetics/"
tag: "Blog"
text: "Improve your API test coverage with Datadog Synthetic Monitoring"
Expand Down Expand Up @@ -114,6 +105,10 @@ Optimize your test suite by [ensuring that your application's most critical work

{{< img src="synthetics/test_coverage/test_coverage.png" alt="Continuous Testing Explorer" style="width:100%;">}}

## Version History

Use [Version History in Synthetic Monitoring][23] to run a previous version of a test, or clone a version to create a new Synthetic Monitoring test.

## Ready to start?

See [Getting Started with Synthetic Monitoring][18] for instructions on creating your first Synthetic test and monitoring your web applications. Then, explore [Getting Started with Private Locations][19] for instructions on creating your private location and running Synthetic tests with your private location.
Expand Down Expand Up @@ -144,4 +139,5 @@ See [Getting Started with Synthetic Monitoring][18] for instructions on creating
[19]: /getting_started/synthetics/private_location
[20]: /continuous_testing/explorer/
[21]: /mobile_testing
[22]: /synthetics/test_coverage
[22]: /synthetics/test_coverage
[23]: /synthetics/guide/version_history/
9 changes: 3 additions & 6 deletions content/en/synthetics/api_tests/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,15 @@ aliases:
- /synthetics/uptime_check
- /synthetics/api_test
further_reading:
- link: 'https://www.datadoghq.com/blog/introducing-synthetic-monitoring/'
tag: 'Blog'
text: 'Introducing Datadog Synthetic Monitoring'
- link: "/synthetics/guide/version_history/"
tag: "Guide"
text: "Version History for Synthetic Monitoring"
- link: 'https://www.datadoghq.com/blog/api-test-coverage-monitoring-datadog-synthetics/'
tag: 'Blog'
text: 'Improve your API test coverage with Datadog Synthetic Monitoring'
- link: 'https://www.datadoghq.com/blog/monitor-apis-with-datadog'
tag: 'Blog'
text: 'Monitor your workflows with Datadog SSL, TLS, and Multistep API tests'
- link: 'https://learn.datadoghq.com/courses/intro-to-synthetic-tests'
tag: 'Learning Center'
text: 'Introduction to Synthetic Tests'
- link: '/getting_started/synthetics/api_test'
tag: 'Documentation'
text: 'Get started with API tests'
Expand Down
8 changes: 4 additions & 4 deletions content/en/synthetics/browser_tests/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ aliases:
- /synthetics/browser_check
- /synthetics/browser_test
further_reading:
- link: "https://www.datadoghq.com/blog/browser-tests/"
tag: "Blog"
text: "User experience monitoring with browser tests"
- link: "/synthetics/guide/version_history/"
tag: "Guide"
text: "Version History for Synthetic Monitoring"
- link: "https://www.datadoghq.com/blog/test-creation-best-practices/"
tag: "Blog"
text: "Best practices for creating end-to-end tests"
Expand All @@ -16,7 +16,7 @@ further_reading:
text: 'Datadog Learning Center: Getting started with Synthetic Browser Testing'
- link: "/getting_started/synthetics/browser_test"
tag: "Documentation"
text: "Getting started with browser tests"
text: "Getting started with Browser Tests"
- link: "/synthetics/guide/synthetic-test-monitors"
tag: "Documentation"
text: "Learn about Synthetic test monitors"
Expand Down
1 change: 1 addition & 0 deletions content/en/synthetics/guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ cascade:
{{< nextlink href="synthetics/guide/identify_synthetics_bots/" >}}Identify Synthetic bots{{< /nextlink >}}
{{< nextlink href="synthetics/guide/clone-test" >}}Clone your Synthetic tests{{< /nextlink >}}
{{< nextlink href="synthetics/guide/otp-email-synthetics-test" >}}Extract a one-time passcode from an email body using Synthetic Browser Tests{{< /nextlink >}}
{{< nextlink href="synthetics/guide/version_history" >}}Version History for Synthetic Monitoring{{< /nextlink >}}
{{< /whatsnext >}}

{{< whatsnext desc="Alerting:" >}}
Expand Down
60 changes: 60 additions & 0 deletions content/en/synthetics/guide/version_history.md
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 changed and who made the update. You can 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.
- **Clone tests**: Create a new test based on a previous version, without changing the current test.

## 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 or clone a previous version of a test.

## 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**.

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**.

## 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/
3 changes: 3 additions & 0 deletions content/en/synthetics/mobile_app_testing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ further_reading:
- link: "https://www.datadoghq.com/blog/test-creation-best-practices/"
tag: "Blog"
text: "Best practices for creating end-to-end tests"
- link: "/synthetics/guide/version_history/"
tag: "Guide"
text: "Version History for Synthetic Monitoring"
- link: "https://www.datadoghq.com/blog/mobile-apps-synthetic-tests/"
tag: "Blog"
text: "How to build reliable and accurate synthetic tests for your mobile apps"
Expand Down
9 changes: 3 additions & 6 deletions content/en/synthetics/multistep.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,9 @@ further_reading:
- link: "https://www.datadoghq.com/blog/monitor-apis-with-datadog/"
tag: "Blog"
text: "Monitor your workflows with Datadog multistep API tests"
- link: 'https://learn.datadoghq.com/courses/intro-to-synthetic-tests'
tag: 'Learning Center'
text: 'Introduction to Synthetic Tests'
- link: "/getting_started/synthetics/api_test"
tag: "Documentation"
text: "Get started with API tests"
- link: "/synthetics/guide/version_history/"
tag: "Guide"
text: "Version History for Synthetic Monitoring"
- link: "/synthetics/private_locations"
tag: "Documentation"
text: "Run Multistep API tests on internal endpoints"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading