Skip to content

Commit 4f5513b

Browse files
committed
add synthetics get started
1 parent a0e44d3 commit 4f5513b

File tree

2 files changed

+45
-16
lines changed

2 files changed

+45
-16
lines changed

solutions/observability/apps/get-started.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,46 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/serverless/current/observability-synthetics-get-started.html
55
---
66

7-
# Get started
7+
# Get started [observability-synthetics-get-started]
88

9-
% What needs to be done: Align serverless/stateful
9+
To set up a synthetic monitor, you need to configure the monitor, run it, and send data back to Elastic. After setup is complete, the data will be available in your serverless Observability project or in {{kib}} to view, analyze, and alert on.
1010

11-
% Use migrated content from existing pages that map to this page:
11+
There are two ways to set up a synthetic monitor:
1212

13-
% - [ ] ./raw-migrated-files/observability-docs/observability/synthetics-get-started.md
14-
% - [ ] ./raw-migrated-files/docs-content/serverless/observability-synthetics-get-started.md
13+
* Synthetics project
14+
* The Synthetics UI
1515

16-
% Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc):
16+
Read more about each option below, and choose the approach that works best for you.
1717

18-
$$$choose-projects$$$
1918

20-
$$$observability-synthetics-get-started-synthetics-project$$$
19+
## Synthetics project [observability-synthetics-get-started-synthetics-project]
20+
21+
With a Synthetics project, you write tests in an external version-controlled Node.js project using YAML for lightweight monitors and JavaScript or TypeScript for browser monitors. Then, you use the `@elastic/synthetics` NPM library’s `push` command to create monitors.
22+
23+
This approach works well if you want to create both browser monitors and lightweight monitors. It also allows you to configure and update monitors using a GitOps workflow.
24+
25+
Get started in [Create monitors in a Synthetics project](../../../solutions/observability/apps/create-monitors-with-project-monitors.md).
26+
27+
:::{image} ../../../images/observability-synthetics-get-started-projects.png
28+
:alt: Diagram showing which pieces of software are used to configure monitors
29+
:::
30+
31+
32+
## Synthetics UI [observability-synthetics-get-started-synthetics-ui]
33+
34+
You can create monitors directly in the user interface. This approach works well if you want to create and manage your monitors in the browser.
35+
36+
Get started in [Create monitors in the Synthetics UI](../../../solutions/observability/apps/create-monitors-in-synthetics-app.md).
37+
38+
:::{image} ../../../images/observability-synthetics-get-started-ui.png
39+
:alt: Diagram showing which pieces of software are used to configure monitors
40+
:::
41+
42+
::::{note}
43+
The Elastic Synthetics integration is a method for creating synthetic monitors that is no longer recommended. **Do not use the Elastic Synthetics integration to set up new monitors.**
44+
45+
For details on how to migrate from Elastic Synthetics integration to {{project-monitors}} or the {{synthetics-app}}, refer to [Migrate from the Elastic Synthetics integration](../../../solutions/observability/apps/migrate-from-elastic-synthetics-integration.md).
46+
47+
If you’ve used the Elastic Synthetics integration to create monitors in the past and need to reference documentation about the integration, go to the [8.3 documentation](https://www.elastic.co/guide/en/observability/8.3/uptime-set-up.html#uptime-set-up-choose-agent).
48+
49+
::::

solutions/observability/apps/writer-role.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mapped_pages:
55

66
# Writer role [synthetics-role-write]
77

8-
::::{important}
8+
::::{important}
99
To minimize the privileges required by the writer role, use the [setup role](setup-role.md) to enable Monitor Management. This section assumes another user has already enabled Monitor Management.
1010
::::
1111

@@ -16,13 +16,13 @@ For users who need to create, modify, and delete monitors, provide write access.
1616
* **Limited write access**: If you want to limit write access to the {{synthetics-app}} only, you can use [Limited write access](#synthetics-write-privileges-limited), which requires additional configuration.
1717

1818

19-
## General write access [synthetics-write-privileges-general]
19+
## General write access [synthetics-write-privileges-general]
2020

2121
Create a **writer role**, called something like `synthetics_writer`:
2222

2323
1. Start with the `editor` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md). This role grants full access to all features in {{kib}} (including the {{observability}} solution) and read-only access to data indices.
2424

25-
::::{note}
25+
::::{note}
2626
The `editor` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md) will grant write access to *all* {{kib}} apps. If you want to limit write access to the {{synthetics-app}} only, refer to [Limited write access](#synthetics-write-privileges-limited).
2727
::::
2828

@@ -36,7 +36,7 @@ Create a **writer role**, called something like `synthetics_writer`:
3636

3737

3838

39-
## Limited write access [synthetics-write-privileges-limited]
39+
## Limited write access [synthetics-write-privileges-limited]
4040

4141
If you want to limit write access to the {{synthetics-app}} only, do *not* use the `editor` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md).
4242

@@ -51,7 +51,7 @@ Instead to you can create a writer role, called something like `synthetics_write
5151
Additional privileges will depend on the factors below.
5252

5353

54-
### To restrict using Elastic’s global managed infrastructure [disable-managed-locations]
54+
### To restrict using Elastic’s global managed infrastructure [disable-managed-locations]
5555

5656
To restrict users assigned this role from using monitors hosted on Elastic’s global managed infrastructure:
5757

@@ -60,7 +60,7 @@ To restrict users assigned this role from using monitors hosted on Elastic’s g
6060
3. Uncheck *Elastic managed locations enabled*.
6161

6262

63-
### If using Private Locations [synthetics-role-write-private-locations]
63+
### If using Private Locations [synthetics-role-write-private-locations]
6464

6565
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.
6666

@@ -72,9 +72,9 @@ The user who is setting up a new Private Location will need the following privil
7272
| [Kibana](../../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md) | `Integrations`: `read` | Access to Integrations in {{kib}}. |
7373

7474

75-
### If using projects [_if_using_projects]
75+
### If using projects [_if_using_projects]
7676

77-
If the user should be able to create and update monitors using [projects](get-started.md#choose-projects), add *at least one* of following privileges:
77+
If the user should be able to create and update monitors using [projects](get-started.md#observability-synthetics-get-started-synthetics-project), add *at least one* of following privileges:
7878

7979
| Type | Privilege | Purpose |
8080
| --- | --- | --- |

0 commit comments

Comments
 (0)