This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Heartbeat uses the
npx @elastic/synthetics command to run and report synthetic tests.
It can also be used locally to help develop your tests.
npx @elastic/synthetics [options] [files] [dir]
You will not need to use most command line flags — they have been implemented purely to interact with Heartbeat. However, there are some you may find useful. They are documented below.
- Prints debug info.
- Filters journey with the name or a matching tag.
- Filters journey with the given tag(s)
json. Use the JUnit reporter to provide easily parsed output to CI servers like Jenkins.
- Runs with the browser in headful mode.
Instead of reading from a file,
catinline scripted journeys and pipe them through
stdin. For example,
cat path/to/file.js | npx @elastic/synthetics --inline
- Captures screenshots for every step in the journey.
Shows help for the