Skip to content
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.

Sign up for GitHub

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

[8.6](backport #2755) [synthetics] Add lightweight to list of directories created on init #2779

Merged
merged 1 commit into from
Mar 21, 2023
Merged

[8.6](backport #2755) [synthetics] Add lightweight to list of directories created on init #2779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions docs/en/observability/synthetics-get-started-project.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,17 +95,17 @@ NOTE: If you are pushing to a <<synthetics-private-location,private location>>,

Then, take a look at key files and directories inside your project:

* `journeys` is where you'll add `.yaml`, `.ts`, and `.js` files defining your monitors. When you create a new project, this directory will contain files defining sample monitors.
* `journeys` is where you'll add `.ts` and `.js` files defining your browser monitors. When you create a new project, this directory will contain files defining sample monitors.
* `lightweight` is where you'll add `.yaml` files defining your lightweight monitors. When you create a new project, this directory will contain a file defining sample monitors.
* `synthetics.config.ts` contains settings for your project. When you create a new project, it will contain some basic configuration options that you can customize later.
* `package.json` contains NPM settings for your project. Learn more in the https://docs.npmjs.com/about-packages-and-modules[NPM documentation].
* `.github` contains sample workflow files to use with GitHub Actions.

[discrete]
= Examine the journey files
= Examine sample monitors

Inside the `journeys` directory you'll find examples of both browser and lightweight monitors.

Here's an example of a YAML file defining a *lightweight monitor*:
Inside the `lightweight` directory you'll find sample lightweight monitors.
Here's an example of a YAML file defining a lightweight monitor:

[source,yml]
----
Expand All @@ -121,7 +121,9 @@ heartbeat.monitors:
For more details on lightweight monitor configuration options,
refer to <<synthetics-lightweight>>.

Here's an example of a TypeScript file defining a *browser monitor*:

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

[source,ts]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/synthetics-lightweight.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Lightweight monitors can be configured using any of the following:

* *YAML files in Project Monitors*. beta[]
<<synthetics-get-started-project,Set up a project>> and configure monitors in YAML
files in the `journeys` directory.
files in the `lightweight` directory.
* *{uptime-app} UI*. beta[]
<<synthetics-get-started-ui,Go to the {uptime-app}>> in {kib} and configure monitors
using the Monitor Management UI.
Expand Down