From 5f96860255e71e14e1277f3f49fd50f710e39a26 Mon Sep 17 00:00:00 2001 From: Adam Karpowich Date: Thu, 5 Jan 2017 16:57:17 -0500 Subject: [PATCH] Update README.md When I first read this guide, the order of the instructions led me to set up selenium and chromedriver locally, which led me to just create my own synthetic test file instead of using synthmanager to create one first. This order forces the user to create a synthetic and have it sent to NR before they start to put code in the generated file and test it locally (unless they read it out of order) --- README.md | 55 +++++++++++++++++++++++++++---------------------------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 1a15bad..6e57284 100644 --- a/README.md +++ b/README.md @@ -61,41 +61,15 @@ After, when the synthetics code has been completed, it can be uploaded to New Re $ synthmanager update --name "New Synthetic Name" ``` -## Running Synthetics locally - -### Prerequisites - -New Relic runs synthetics using the chrome web browser. So that is the recommended way to run them locally. In order to run them, the following need to be setup: - -* Chrome Web browser -* Selenium Server (http://www.seleniumhq.org/download/), should be running -* Chrome Driver (https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver), should be in the path - -### Running Synthetics - -Once the prerequisites are installed and a synthetic is created, it can be run locally. This can be done with an IDE or using node: - -``` -$ node synthetics/newSyntheticName.js -``` - ## Command Line Usage -### Global options - -These options can be used with any command: - -* --apikey - Specify API key to use to access New Relic. -* --verbose - Provide verbose logging output. -* --debug - Provide debug logging output. - ### Create a new synthetic ``` synthmanager create --name --file ``` -Create a synthetic in New Relic and a file to contain the synthetic code. +Create a synthetic in New Relic and a file to contain the synthetic code. The local file will be created in the directory the command was run. This is where you will put your test code. * --name - Name of synthetic. This is the name used in New Relic as well as how it should be refered to by other commands * --file - Filename where the synthethics code should go. This file will be created under the 'synthetics' directory. The file should not already exist. @@ -124,6 +98,13 @@ synthmanager import --name --id --file