Skip to content

Commit

Permalink
more context
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Oct 23, 2023
1 parent 59e570d commit d32f8da
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 13 deletions.
19 changes: 13 additions & 6 deletions docs/en/observability/synthetics-get-started-project.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,6 @@ npm install -g @elastic/synthetics
npx @elastic/synthetics -h
----

// Should we mention the possibility of not being able to run monitors on public locations
// here or is disabling public locations rare enough that it's not worth adding more complexity
// to the getting started guide? If they see an error or warning, they should be able to
// diagnose the issue by viewing the troubleshooting doc.

You should also decide where you want to run the monitors before getting started.
You can run {project-monitors} on one or both of the following:

Expand All @@ -52,6 +47,17 @@ You can run {project-monitors} on one or both of the following:
To use {private-location}s you must create a {private-location} before continuing.
For step-by-step instructions, refer to <<synthetics-private-location>>.

// Should we mention the possibility of not being able to run monitors on public locations
// here or is disabling public locations rare enough that it's not worth adding more complexity
// to the getting started guide? If they see an error or warning, they should be able to
// diagnose the issue by viewing the troubleshooting doc.

[NOTE]
====
Administrators can restrict access to Elastic's global managed testing infrastructure.
Read more in <<disable-managed-locations>>.
====

[NOTE]
====
If you are setting up Synthetics for a deployment configured with
Expand Down Expand Up @@ -85,6 +91,8 @@ for authentication with your {stack}:
+
IMPORTANT: To generate a Project API key, you must be logged in as a user with the privileges
described in <<synthetics-role-write>>.
To use an API key to push to Elastic's global managed testing infrastructure,
the _Elastic managed locations enabled_ toggle must be on when generating the API key.
+
[role="screenshot"]
image::images/synthetics-monitor-management-api-key.png[Project API Keys tab in Synthetics settings]
Expand Down Expand Up @@ -123,7 +131,6 @@ heartbeat.monitors:
For more details on lightweight monitor configuration options,
refer to <<synthetics-lightweight>>.


Inside the `journeys` directory you'll find sample browser monitors.
Here's an example of a TypeScript file defining a browser monitor:

Expand Down
16 changes: 11 additions & 5 deletions docs/en/observability/synthetics-get-started-ui.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@ This is one of <<synthetics-get-started,two approaches>> you can use to set up a
You must be signed into {kib} as a user with at least <<synthetics-role-write,synthetics write permissions>>,
and Monitor Management must be enabled by an administrator as described in <<synthetics-role-setup>>.

// Should we mention the possibility of not being able to run monitors on public locations
// here or is disabling public locations rare enough that it's not worth adding more complexity
// to the getting started guide? If they see an error or warning, they should be able to
// diagnose the issue by viewing the troubleshooting doc.

[[private-locations]]
You should decide where you want to run the monitors before getting started.
You can run monitors on one or both of the following:
Expand All @@ -37,6 +32,17 @@ You can run monitors on one or both of the following:
To use {private-location}s you must create a {private-location} before continuing.
For step-by-step instructions, refer to <<synthetics-private-location>>.

// Should we mention the possibility of not being able to run monitors on public locations
// here or is disabling public locations rare enough that it's not worth adding more complexity
// to the getting started guide? If they see an error or warning, they should be able to
// diagnose the issue by viewing the troubleshooting doc.

[NOTE]
====
Administrators can restrict access to Elastic's global managed testing infrastructure.
Read more in <<disable-managed-locations>>.
====

[NOTE]
====
If you are setting up Synthetics for a deployment configured with
Expand Down
3 changes: 2 additions & 1 deletion docs/en/observability/synthetics-role-write.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[synthetics-role-write]]
= Writer role
= Writer role

IMPORTANT: To minimize the privileges required by the writer role, use the
<<synthetics-role-setup,setup role>> to enable Monitor Management.
Expand Down Expand Up @@ -91,6 +91,7 @@ To restrict users assigned this role from using monitors hosted on Elastic's glo
. Uncheck _Elastic managed locations enabled_.

[discrete]
[[synthetics-role-write-private-locations]]
== If using Private Locations

The user who initially sets up a new Private Location needs additional privileges. Users who create or update monitors hosted on that Private Location do not need any additional permissions.
Expand Down
20 changes: 19 additions & 1 deletion docs/en/observability/synthetics-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,33 @@ To fix this issue, you can either:
* Increase the number of concurrent browser monitors allowed (as described in <<synthetics-private-location-scaling,Scaling Private Locations>>), paying attention to the scaling and hardware requirements documented.
* Create multiple {private-location}s and spread your browser monitors across them more evenly (effectively horizontally scaling your {private-location}s).

[discrete]
[[synthetics-troubleshooting-no-locations]]
== No locations are available

If there are no options available in the _Locations_ dropdown when you try to create a monitor in the Synthetics app
or if no locations are listed when using the <<elastic-synthetics-locations-command,`location` command>>,
you might not have permission to use Elastic managed locations and there might not be any
<<monitor-via-private-agent,Private Locations>> available yet.

There are a few ways to fix this:

* If you have <<synthetics-role-write,write access>> including the privileges for <<synthetics-role-write-private-locations,creating new Private Locations>>, you can <<monitor-via-private-agent,create a new Private Location>>. Then try creating the monitor again.
* If you do _not_ have the right privileges to create a Private Location, you can ask someone with the <<synthetics-role-write-private-locations,necessary privileges>> to create a Private Location or ask an administrator with a <<synthetics-role-setup,setup role>> to give you the necessary privileges and <<monitor-via-private-agent,create a new Private Location>>. Then try creating the monitor again.
* If you want to create a monitor to run on Elastic's global managed infrastructure, ask an administrator with a <<synthetics-role-setup,setup role>> to update <<disable-managed-locations,`Synthetics and Uptime` sub-feature privileges>> for the role you're currently assigned. Then try creating the monitor again.

[discrete]
[[synthetics-troubleshooting-public-locations-disabled]]
== You do not have permission to use Elastic managed locations

If you try to create or edit a monitor hosted on Elastic's global managed infrastructure but see a note that you do not have permission to use Elastic managed locations, an administrator has restricted the use of public locations.

To fix this, ask an administrator with a <<synthetics-role-setup,setup role>> to update
To fix this you can either:

* Ask an administrator with a <<synthetics-role-setup,setup role>> to update
<<disable-managed-locations,`Synthetics and Uptime` sub-feature privileges>> for the role you're
currently assigned or assign you a role that allows using Elastic's global managed infrastructure.
* Use a <<monitor-via-private-agent,Private Location>>.

[discrete]
[[synthetics-troubleshooting-get-help]]
Expand Down

0 comments on commit d32f8da

Please sign in to comment.