IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create a new synthetic test Visualize synthetic monitoring »

› ›

Synthetics command reference

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Synthetics command reference

edit

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Have a question? Want to leave feedback? Visit the Synthetics discussion forum.

`elastic-synthetics`

edit

Heartbeat uses the npx @elastic/synthetics command to run and report synthetic tests. It can also be used locally to help develop your tests.

SYNOPSIS

npx @elastic/synthetics [options] [files] [dir]

FLAGS

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.

--debug: Prints debug info.
--environment: Sets the environment. For example, dev, staging, prod, etc..
-h, --help: Shows help for the npx @elastic/synthetics command.
--journey-name <name>: Filters by journey name.
--reporter: One of junit, default, or json. Use the JUnit reporter to provide easily parsed output to CI servers like Jenkins.
--no-headless: Runs with the browser in headful mode.
--inline: Instead of reading from a file, cat inline scripted journeys and pipe them through stdin. For example, cat path/to/file.js | npx @elastic/synthetics --inline

« Create a new synthetic test Visualize synthetic monitoring »