Get started with Elastic Synthetics!

Browse the directory structure here to see an example skeleton of an Elastic Synthetics project. Make sure to read the docs as well if you're unfamiliar with Elastic Synthetics.

This directory was created with the command npx @elastic/synthetics <target-directory>, with <target-directory> being the name of the directory you'd like it to make. You can always use this command to scafold new Synthetics projects.

Key places to look:

• The synthetics.config.ts file contains configuration for your project.
• The journeys directory contains both basic and more advanced examples of using synthetics. It tests a publicly hosted Todos List.
• The .github directory contains an example github action, demonstrating the use of a CI service for automatically running tests on merges and PR creation.

To run the tests locally, use the following command:

npm run test

Curious to learn more? Read the docs to learn about pushing configurations to an Elastic cloud stack and more.