Skip to content

Commit a886a18

Browse files
author
rongzhus
committed
update README
1 parent a3007a1 commit a886a18

1 file changed

Lines changed: 55 additions & 40 deletions

File tree

README.md

Lines changed: 55 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -110,45 +110,36 @@ synctl get test <id> --show-json
110110
## Create a synthetic test
111111

112112
```
113-
synctl create test -t <type> --label <label> ...
113+
synctl create test [options]
114114
115115
options:
116-
-t <type>: synthetic type
117-
0 HTTPAction
118-
1 HTTPScript
119-
2 BrowserScript
120-
3 WebpageScript
121-
--label <label> test name
122-
--location [LOCATION ...] location id, support multiple locations id
123-
--description DESCRIPTION, -d DESCRIPTION
124-
description of synthetic test
125-
--frequency FREQUENCY The range is from 1 to 120min, default is 15
126-
--app-id, --application-id APP_ID
127-
set application id
128-
--url URL HTTP Request URL
129-
--operation OPERATION HTTP Request Method, GET, POST, HEAD, PUT, etc.
130-
--headers HEADERS HTTP Headers
131-
--body BODY HTTP Body
132-
--from-file FROM_FILE synthetic script, specify a file name
133-
--bundle BUNDLE synthetic script encoded with base64
134-
--script-file SCRIPT_FILE bundle script entry file, e.g, myscript.js
135-
--retries {0,1,2} retry times, value is from [0, 2]
136-
--retry-interval {1,2,3,4,5,6,7,8,9,10} retryInvertal
137-
--follow-redirect {true,false,True,False}
138-
followRedirect default True
139-
--expect-status EXPECT_STATUS
140-
expectStatus default 200
141-
--expect-json EXPECT_JSON
142-
expectJson
143-
--expect-match EXPECT_MATCH expectMatch
144-
--expect-exists EXPECT_EXISTS
145-
expectExists
146-
--expect-not-empty EXPECT_NOT_EMPTY
147-
expectNotEmpty
148-
--allow-insecure {false,true}
149-
allowInsecure
150-
--browser {chrome,firefox}
151-
set browser type
116+
-t int synthetic type
117+
0 HTTPAction
118+
1 HTTPScript
119+
2 BrowserScript
120+
3 WebpageScript
121+
--label <label> test name
122+
--location [id,...] location id, support multiple locations id
123+
--description string, -d string description of synthetic test
124+
--frequency int The range is [1, 120], unit is min, default is 15
125+
--app-id, --application-id <app-id> set application id
126+
--url URL HTTP Request URL
127+
--operation OPERATION HTTP Request Method, GET, POST, HEAD, PUT, etc.
128+
--headers HEADERS HTTP Headers
129+
--body BODY HTTP Body
130+
--from-file, -f <file> specify synthetic script file name
131+
--bundle <BASE64>, zip file synthetic script encoded with base64, or use a zip file instead
132+
--script-file <entry-name> bundle script entry file, e.g, myscript.js
133+
--retries {0,1,2} retry times, value is from [0, 2]
134+
--retry-interval [1, 10] retryInvertal
135+
--follow-redirect {true,false} followRedirect, default true
136+
--expect-status int expectStatus, expected status code, default 200
137+
--expect-json <json> expectJson
138+
--expect-match string expectMatch
139+
--expect-exists string expectExists
140+
--expect-not-empty string expectNotEmpty
141+
--allow-insecure {false,true} allowInsecure
142+
--browser {chrome,firefox} set browser type
152143
```
153144

154145
Examples:
@@ -171,6 +162,13 @@ synctl create test -t 0 --label "simple-ping" --url "https://httpbin.org/get" --
171162
# a simple API script
172163
synctl create test -t 1 --label "simple-api-script" --from-file http-scripts/http-get.js --location "$LOCATION" --frequency 5
173164
165+
# create bundle test with a zip file
166+
synctl create test -t 1 --label syn-bundle-zip-test \
167+
--bundle synthetic.zip \
168+
--script-file index.js \
169+
--location "$LOCATION" \
170+
--frequency 5
171+
174172
# create bundle test
175173
synctl create test -t 1 --label "syn-bundle-test" \
176174
--bundle "UEsDBAoAAAAAAOiGTFUAAAAAAAAAAAAAAAAOABwAYnVuZGxlLXRlc3QwMS9VVAkAA/SARmP1gEZjdXgLAAEE9QEAAAQUAAAAUEsDBBQAAAAIAOCmTFVLcg0lsQAAAGoBAAAWABwAYnVuZGxlLXRlc3QwMS9pbmRleC5qc1VUCQADJLlGYyS5RmN1eAsAAQT1AQAABBQAAAB9zs0KwjAMB/D7nqKHQStIh/OmyBBPgriLL7DO6Apdq23mx9u7FEF0slPT9PdPWjsbkJ0dztiKebh22oPgMjNaZdTlk2VSR9MgXvIhoisEzD9Qq3Y+dNQlk9BU0RdxHhX0QmeSVoheqw4hyAAoeAPGOD5l/O68OcY0rXAGpLYnJ7ipFJgepOFpsQHU9fsXY6SQsVdIW7Xw3zPrkMFDB1yMRn+yYG/fXu7KzfqwLfe9fQFQSwMECgAAAAAA1aZMVQAAAAAAAAAAAAAAABIAHABidW5kbGUtdGVzdDAxL2xpYi9VVAkAAxG5RmMSuUZjdXgLAAEE9QEAAAQUAAAAUEsDBBQAAAAIAMumTFX5mkDz8QAAAKcBAAAZABwAYnVuZGxlLXRlc3QwMS9saWIvaWJtMy5qc1VUCQAD/bhGYxO5RmN1eAsAAQT1AQAABBQAAABVUEFuwyAQvPOKPVQCSxaO2lutntKeesgbCKxbSzbrwiInqvL3gh27CqdlZnY0O5Z8ZDAxYmB4g4A/qQ+o5IrIqhVNA3YRFQ7jg+oOyUoU2YAMT9/M012SmVZ0yVvuyUMhXlQFvwJWlf5CVrJM8bVp5nnW/XnUlkZZZwnAtqkwhDobxinHwBrO5K6rTXl9B0XwD8ASlwbUGaawkO3OBeQU/Pa/iceN3nekPM7wbhhVVYOM6N1+uSOPcjdbK9KZM4Pa4unIhlM8kstJnw+HbPFxmdAyOjAFgNPnfsvmVWLk8SbESC6V5JeJAsfc49JaK/4AUEsDBBQAAAAIAMamTFUlcJfDtAAAAAQBAAAZABwAYnVuZGxlLXRlc3QwMS9saWIvZ290MS5qc1VUCQAD87hGY/S4RmN1eAsAAQT1AQAABBQAAAAtjkEOgyAQRfecYuIGTBqJW0x7F6pUaShjYYw1hrsXaDcMkP/fvBF9JJiR4ArBvDcbjOD5yduBMR0PP8Jj8yNZ9CXVixZOBjDW2jlp0ik39a5tpXQrRhJ8IVqjkrLMu/Udhllqf9Bi/cwvlQDwjOjV/w6wGOdQAd8xuInXz5TP1HYlJ4rOby060zmcq2WfnePmKDOLSg4BSHm9wdlUXqOgqcAmscTYC6ctt81nxUAxexfEwL5QSwMEFAAAAAgABKZMVfkY0sj6AAAAuwEAAB0AHABidW5kbGUtdGVzdDAxL2xpYi9yZXF1ZXN0Mi5qc1VUCQADiLdGYwm5RmN1eAsAAQT1AQAABBQAAABVUM1OxCAQvvMUczCBJg3d7NHGk+vJg89AYapNWqbCkK4x++5Cu63Kafj+8s1Y8pHBxIiB4QkCfqYhoJIbIqtWiKaBngKMZM0IjJELYldfkWfgr/EOyaqoRmR4+GCe74pM5MA+ecsDeSjMWVXwLWCT6XdkJcsUH5tmWRbdmcElbWmSdRYB7F6FIdQ5M865CNbQkfvagsobeiiCXwDWwjSizjCFlWwPLiCn4Pf/Tfx3DL4n5XGBi2FUVQ1y6KZjdUce5ZG1nU1nzoxqb6cjG07xmVwuej6dcsLLdUbL6MAUAN5ej1X2rNIijzchJnKpFL/OFDjmS65na8UPUEsBAh4DCgAAAAAA6IZMVQAAAAAAAAAAAAAAAA4AGAAAAAAAAAAQAO1BAAAAAGJ1bmRsZS10ZXN0MDEvVVQFAAP0gEZjdXgLAAEE9QEAAAQUAAAAUEsBAh4DFAAAAAgA4KZMVUtyDSWxAAAAagEAABYAGAAAAAAAAQAAAKSBSAAAAGJ1bmRsZS10ZXN0MDEvaW5kZXguanNVVAUAAyS5RmN1eAsAAQT1AQAABBQAAABQSwECHgMKAAAAAADVpkxVAAAAAAAAAAAAAAAAEgAYAAAAAAAAABAA7UFJAQAAYnVuZGxlLXRlc3QwMS9saWIvVVQFAAMRuUZjdXgLAAEE9QEAAAQUAAAAUEsBAh4DFAAAAAgAy6ZMVfmaQPPxAAAApwEAABkAGAAAAAAAAQAAAKSBlQEAAGJ1bmRsZS10ZXN0MDEvbGliL2libTMuanNVVAUAA/24RmN1eAsAAQT1AQAABBQAAABQSwECHgMUAAAACADGpkxVJXCXw7QAAAAEAQAAGQAYAAAAAAABAAAApIHZAgAAYnVuZGxlLXRlc3QwMS9saWIvZ290MS5qc1VUBQAD87hGY3V4CwABBPUBAAAEFAAAAFBLAQIeAxQAAAAIAASmTFX5GNLI+gAAALsBAAAdABgAAAAAAAEAAACkgeADAABidW5kbGUtdGVzdDAxL2xpYi9yZXF1ZXN0Mi5qc1VUBQADiLdGY3V4CwABBPUBAAAEFAAAAFBLBQYAAAAABgAGACkCAAAxBQAAAAA=" \
@@ -183,6 +181,23 @@ synctl create test -t 1 --label "syn-bundle-test" \
183181

184182

185183
```
184+
# create a browser script test
185+
synctl create test -t 2 \
186+
--label browser-script-test \
187+
--from-file browser.side \
188+
--location "$LOCATION" \
189+
--frequency 15
190+
191+
192+
# create browser bundle test using a zip file
193+
synctl create test -t 2 \
194+
--label browser-script-zip-test \
195+
--bundle browserscript.zip \
196+
--script-file mytest.js \
197+
--location "$LOCATION" \
198+
--frequency 15
199+
200+
# create browser bundle test using base64 string
186201
synctl create test -t 2 \
187202
--label "browserscript-test" \
188203
--location "$LOCATION" --frequency 15 \
@@ -209,7 +224,7 @@ synctl create test -t <type> --from-json payload-examples/api-script.json
209224
```
210225

211226

212-
**Note:** Support specify appliation id when create synthetic test, get an application id through command `synctl get app`.
227+
**Note:** Support specify application id when create synthetic test, get an application id through command `synctl get app`.
213228

214229

215230

@@ -288,9 +303,9 @@ synctl get app --name-filter <application-name>
288303
synctl create test -t 0 --app-id <application-id> ...
289304
```
290305

291-
## Query and Delete Synthetic Location
306+
## Manage Synthetic Locations
292307

293-
### Query synthetic location
308+
### Display synthetic location
294309

295310
```
296311
synctl get location

0 commit comments

Comments
 (0)