You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: terraform/README.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ specify below config in the tfvars file
41
41
6.[optional] aoc_image_repo, if you have an aoc image you just built with the new component, then set its repo name here
42
42
7.[optional] aoc_version, if you have an aoc image you just built with the new component, then set it as its tag name.
43
43
44
-
### 1.4 you can use placeholders in your config files.
44
+
### 1.4 how to write the configurations?
45
45
46
46
#### 1.4.1 otconfig
47
47
@@ -237,7 +237,33 @@ sample_app:
237
237
args: []
238
238
```
239
239
240
-
#### 1.4.5 expected data pattern in the Validation config
240
+
#### 1.4.5 Validation config.
241
+
242
+
An example for validation config.
243
+
244
+
```yaml
245
+
-
246
+
validationType: "trace"
247
+
httpPath: "/span0"
248
+
httpMethod: "get"
249
+
callingType: "http"
250
+
expectedTraceTemplate: "DEFAULT_EXPECTED_TRACE"
251
+
-
252
+
validationType: "metric"
253
+
httpPath: "/span0"
254
+
httpMethod: "get"
255
+
callingType: "http"
256
+
expectedMetricTemplate: "DEFAULT_EXPECTED_METRIC"
257
+
```
258
+
259
+
the validation config is a list of validation, below are the explanation for each field.
260
+
261
+
* validationType, possible value: `metric` which validates metric from Cloudwatch, `trace` which validates traces from Xray.
262
+
* callingType, possible value: `http` which will ask validator to call the sample app with http protocol. `none`, which tell the validator the metric or trace will be automatically generated from the sample app/AOC.
263
+
* httpPath: the path to call, only apply when callingType is `http`
264
+
* httpMethod: the http method to call, only apply when callingType is `http`
265
+
* expectedTraceTemplate: the trace validation pattern, only apply when validationType is `trace`
266
+
* expectedMetricTemplate: the metric validation pattern, only apply when validationType is `metric`
241
267
242
268
Below are the placeholders you can use in the expected data pattern.
0 commit comments