[Synthetics] Adjust private location docs to support base elastic-agent #3831

emilioalvap · 2025-11-05T19:58:32Z

Summary

Adjust synthetics docs to support elastic-agent base image for non-browser monitors.

Relates to https://github.com/elastic/synthetics-dev/issues/402.

github-actions · 2025-11-05T20:02:56Z

🔍 Preview links for changed docs

lucabelluccini

I've made some suggestions as I think being more explicit as possible is the best.
Also I would recommend, for the 'default' path, to show the complete option.

There are less chances someone will have to redo the download/tutorial because they blindly copy pasted the steps without reading the warnings and then they discover they would like to run a browser monitor.

reference/fleet/elastic-agent-container.md

solutions/observability/synthetics/monitor-resources-on-private-networks.md

solutions/observability/synthetics/migrate-from-elastic-synthetics-integration.md

solutions/observability/synthetics/support-matrix.md

Co-authored-by: Luca Belluccini <[email protected]>

…e-networks.md Co-authored-by: Luca Belluccini <[email protected]>

Co-authored-by: Luca Belluccini <[email protected]>

emilioalvap · 2025-11-06T16:53:04Z

Thanks for the suggestions @lucabelluccini, I still need to add a reference to alternative elastic-agent (basic) install methods, which we will also be supporting from now on. I'll update the default tab options to show the complete variant first as you suggested

mdbirnstiehl

I left a few suggestions. Let me know if you have any questions or comments.

mdbirnstiehl · 2025-11-06T21:18:18Z

reference/fleet/elastic-agent-container.md

 ### Complete flavor

-If you want to run Synthetics tests, run the docker pull command to fetch the elastic-agent-complete image:
+In case you need to run {{agent}} as a Synthetic Private Location and you'll use only Lightweight monitors, you can use the `elastic-agent` (and the `wolfi` variant).


Suggested change

In case you need to run {{agent}} as a Synthetic Private Location and you'll use only Lightweight monitors, you can use the `elastic-agent` (and the `wolfi` variant).

To run {{agent}} as a Synthetic Private Location using only lightweight monitors, use the `elastic-agent` (and the `wolfi` variant).

mdbirnstiehl · 2025-11-06T21:18:54Z

reference/fleet/elastic-agent-container.md

-If you want to run Synthetics tests, run the docker pull command to fetch the elastic-agent-complete image:
+In case you need to run {{agent}} as a Synthetic Private Location and you'll use only Lightweight monitors, you can use the `elastic-agent` (and the `wolfi` variant).
+
+ In case you need to run {{agent}} as a Synthetic Private Location and you'll use both Lightweight monitors and Synthetics Browser tests, run the docker pull command to fetch the `elastic-agent-complete` image:


Suggested change

In case you need to run {{agent}} as a Synthetic Private Location and you'll use both Lightweight monitors and Synthetics Browser tests, run the docker pull command to fetch the `elastic-agent-complete` image:

To run {{agent}} as a Synthetic Private Location using both lightweight monitors and Synthetics Browser tests, run the following docker pull command to fetch the `elastic-agent-complete` image:

mdbirnstiehl · 2025-11-06T21:21:54Z

solutions/observability/synthetics/migrate-from-elastic-synthetics-integration.md

 ## Where monitors run [synthetics-migrate-integration-location]

-If you want to continue hosting on your infrastructure, you will need to create a {{private-location}} before creating monitors. If you have already have an {{agent}} running using `elastic-agent-complete`, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}. To create a new {{private-location}} from scratch, follow all instructions in [Monitor resources on private networks](/solutions/observability/synthetics/monitor-resources-on-private-networks.md).
+If you want to continue hosting on your infrastructure, you will need to create a {{private-location}} before creating monitors. If you already have an {{agent}} running using `elastic-agent` or any of its variants, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}.


Suggested change

If you want to continue hosting on your infrastructure, you will need to create a {{private-location}} before creating monitors. If you already have an {{agent}} running using `elastic-agent` or any of its variants, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}.

If you want to continue hosting on your infrastructure, create a {{private-location}} before creating monitors. If you already have an {{agent}} running using `elastic-agent` or any of its variants, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}.

mdbirnstiehl · 2025-11-06T21:22:24Z

solutions/observability/synthetics/migrate-from-elastic-synthetics-integration.md

+If you want to continue hosting on your infrastructure, you will need to create a {{private-location}} before creating monitors. If you already have an {{agent}} running using `elastic-agent` or any of its variants, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}.
+
+::::{note}
+Only the `elastic-agent-complete` image (and its `wolfi` variant) allows to run Synthetic Browser tests.


Suggested change

Only the `elastic-agent-complete` image (and its `wolfi` variant) allows to run Synthetic Browser tests.

Only the `elastic-agent-complete` image (and its `wolfi` variant) allows you to run Synthetic Browser tests.

mdbirnstiehl · 2025-11-06T21:23:12Z

solutions/observability/synthetics/monitor-resources-on-private-networks.md

+Elastic provides Docker images that you can use to run {{fleet}} and an {{agent}} more easily. Additional installation methods can be found on the [{{agent}} installation guide](/reference/fleet/install-elastic-agents.md). 
 ::::{important}
-The `elastic-agent-complete` Docker image is the only way to have all available options that you see in the UI.
+For running browser monitors on {{private-location}}s, you *must* use one of the `elastic-agent-complete` Docker image variants in a containerized environment. The standard {{agent}} variant only supports TCP, ICMP and HTTP monitors.


Suggested change

For running browser monitors on {{private-location}}s, you *must* use one of the `elastic-agent-complete` Docker image variants in a containerized environment. The standard {{agent}} variant only supports TCP, ICMP and HTTP monitors.

For running browser monitors on {{private-location}}s, you *must* use one of the `elastic-agent-complete` Docker image variants in a containerized environment. The standard {{agent}} variant only supports TCP, ICMP, and HTTP monitors.

mdbirnstiehl · 2025-11-06T21:24:05Z

solutions/observability/synthetics/support-matrix.md

-    * Shipped as the `elastic-agent-complete` Docker image
+    * Shipped as multiple `elastic-agent` variants:
+
+        * `elastic-agent-complete`, exclusively provided as a Docker image which includes all dependencies required to run browser, TCP, HTTP and ICMP monitors.


Suggested change

* `elastic-agent-complete`, exclusively provided as a Docker image which includes all dependencies required to run browser, TCP, HTTP and ICMP monitors.

* `elastic-agent-complete`, exclusively provided as a Docker image which includes all dependencies required to run browser, TCP, HTTP, and ICMP monitors.

mdbirnstiehl · 2025-11-06T21:24:16Z

solutions/observability/synthetics/support-matrix.md

+    * Shipped as multiple `elastic-agent` variants:
+
+        * `elastic-agent-complete`, exclusively provided as a Docker image which includes all dependencies required to run browser, TCP, HTTP and ICMP monitors.
+        * `elastic-agent` which only supports TCP, HTTP and ICMP monitors. 


Suggested change

* `elastic-agent` which only supports TCP, HTTP and ICMP monitors.

* `elastic-agent` which only supports TCP, HTTP, and ICMP monitors.

mdbirnstiehl · 2025-11-06T21:28:57Z

solutions/observability/synthetics/migrate-from-elastic-synthetics-integration.md

+
+::::
+
+To create a new {{private-location}} from scratch, follow all instructions in [Monitor resources on private networks](/solutions/observability/synthetics/monitor-resources-on-private-networks.md).


Suggested change

To create a new {{private-location}} from scratch, follow all instructions in [Monitor resources on private networks](/solutions/observability/synthetics/monitor-resources-on-private-networks.md).

To create a new {{private-location}} from scratch, follow the instructions in [Monitor resources on private networks](/solutions/observability/synthetics/monitor-resources-on-private-networks.md).

Adjust private location docs to support base elastic-agent image

747b1a5

emilioalvap requested a review from lucabelluccini November 5, 2025 19:58

emilioalvap requested review from a team as code owners November 5, 2025 19:58

github-actions bot had a problem deploying to docs-preview November 5, 2025 19:59 Failure

Remove container reference

addaff9

github-actions bot deployed to docs-preview November 5, 2025 20:00 View deployment

emilioalvap changed the title ~~[Synthetics] Adjust private location docs to support base elastic-agent image~~ [Synthetics] Adjust private location docs to support base elastic-agent Nov 5, 2025

lucabelluccini reviewed Nov 5, 2025

View reviewed changes

Update solutions/observability/synthetics/support-matrix.md

683f2da

Co-authored-by: Luca Belluccini <[email protected]>

github-actions bot deployed to docs-preview November 6, 2025 12:03 View deployment

Update solutions/observability/synthetics/monitor-resources-on-privat…

b4019b7

…e-networks.md Co-authored-by: Luca Belluccini <[email protected]>

github-actions bot deployed to docs-preview November 6, 2025 12:05 View deployment

Update reference/fleet/elastic-agent-container.md

623f45d

Co-authored-by: Luca Belluccini <[email protected]>

github-actions bot had a problem deploying to docs-preview November 6, 2025 16:50 Failure

Apply suggestions from code review

315807a

Co-authored-by: Luca Belluccini <[email protected]>

github-actions bot deployed to docs-preview November 6, 2025 16:52 View deployment

reorg docs

9c819c9

github-actions bot deployed to docs-preview November 6, 2025 17:37 View deployment

Merge branch 'main' into synthetics-private-locations-update

c483757

github-actions bot deployed to docs-preview November 6, 2025 19:29 View deployment

Fix formatting

3f4668b

github-actions bot deployed to docs-preview November 6, 2025 19:49 View deployment

mdbirnstiehl reviewed Nov 6, 2025

View reviewed changes

	In case you need to run {{agent}} as a Synthetic Private Location and you'll use only Lightweight monitors, you can use the `elastic-agent` (and the `wolfi` variant).
	To run {{agent}} as a Synthetic Private Location using only lightweight monitors, use the `elastic-agent` (and the `wolfi` variant).

	If you want to continue hosting on your infrastructure, you will need to create a {{private-location}} before creating monitors. If you already have an {{agent}} running using `elastic-agent` or any of its variants, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}.
	If you want to continue hosting on your infrastructure, create a {{private-location}} before creating monitors. If you already have an {{agent}} running using `elastic-agent` or any of its variants, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}.

	Only the `elastic-agent-complete` image (and its `wolfi` variant) allows to run Synthetic Browser tests.
	Only the `elastic-agent-complete` image (and its `wolfi` variant) allows you to run Synthetic Browser tests.

	For running browser monitors on {{private-location}}s, you must use one of the `elastic-agent-complete` Docker image variants in a containerized environment. The standard {{agent}} variant only supports TCP, ICMP and HTTP monitors.
	For running browser monitors on {{private-location}}s, you must use one of the `elastic-agent-complete` Docker image variants in a containerized environment. The standard {{agent}} variant only supports TCP, ICMP, and HTTP monitors.

	* `elastic-agent-complete`, exclusively provided as a Docker image which includes all dependencies required to run browser, TCP, HTTP and ICMP monitors.
	* `elastic-agent-complete`, exclusively provided as a Docker image which includes all dependencies required to run browser, TCP, HTTP, and ICMP monitors.

	* `elastic-agent` which only supports TCP, HTTP and ICMP monitors.
	* `elastic-agent` which only supports TCP, HTTP, and ICMP monitors.


		::::

		To create a new {{private-location}} from scratch, follow all instructions in [Monitor resources on private networks](/solutions/observability/synthetics/monitor-resources-on-private-networks.md).

[Synthetics] Adjust private location docs to support base elastic-agent #3831

Are you sure you want to change the base?

[Synthetics] Adjust private location docs to support base elastic-agent #3831

Uh oh!

Conversation

emilioalvap commented Nov 5, 2025

Summary

Uh oh!

github-actions bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 Preview links for changed docs

Uh oh!

lucabelluccini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emilioalvap commented Nov 6, 2025

Uh oh!

mdbirnstiehl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Nov 5, 2025 •

edited

Loading