Skip to content

Commit d6934b2

Browse files
committed
docs: Added code annotation in analysis reference page
1 parent e03976d commit d6934b2

File tree

1 file changed

+60
-72
lines changed

1 file changed

+60
-72
lines changed

docs/docs/reference/crd-reference/analysis.md

Lines changed: 60 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -99,51 +99,51 @@ The overall evaluation has passed, and no warnings have been issued.
9999

100100
```json
101101
{
102-
"objectiveResults": [
102+
"objectiveResults"/*(1)!*/: [
103103
{
104-
"result": {
105-
"failResult": {
104+
"result"/*(2)!*/: {
105+
"failResult"/*(3)!*/: {
106106
"operator": {
107107
"greaterThan": {
108-
"fixedValue": "500m"
108+
"fixedValue": "500m"
109109
}
110110
},
111111
"fulfilled": false
112112
},
113-
"warnResult": {
113+
"warnResult"/*(4)!*/: {
114114
"operator": {
115115
"greaterThan": {
116116
"fixedValue": "300m"
117117
}
118118
},
119119
"fulfilled": false
120120
},
121-
"warning": false,
122-
"pass": true
121+
"warning"/*(5)!*/: false,
122+
"pass"/*(6)!*/: true
123123
},
124-
"objective": {
125-
"analysisValueTemplateRef": {
124+
"objective"/*(7)!*/: {
125+
"analysisValueTemplateRef"/*(8)!*/: {
126126
"name": "response-time-p95"
127127
},
128-
"target": {
128+
"target"/*(9)!*/: {
129129
"failure": {
130130
"greaterThan": {
131131
"fixedValue": "500m"
132132
}
133133
},
134-
"warning": {
134+
"warning" : {
135135
"greaterThan": {
136136
"fixedValue": "300m"
137137
}
138138
}
139139
},
140-
"weight": 1
140+
"weight"/*(10)!*/: 1
141141
},
142-
"value": 0.00475,
143-
"score": 1
142+
"value"/*(11)!*/: 0.00475,
143+
"score"/*(12)!*/: 1
144144
},
145145
{
146-
"result": {
146+
"result"/*(13)!*/: {
147147
"failResult": {
148148
"operator": {
149149
"greaterThan": {
@@ -161,77 +161,65 @@ The overall evaluation has passed, and no warnings have been issued.
161161
"warning": false,
162162
"pass": true
163163
},
164-
"objective": {
165-
"analysisValueTemplateRef": {
164+
"objective"/*(14)!*/: {
165+
"analysisValueTemplateRef"/*(15)!*/: {
166166
"name": "error-rate"
167167
},
168-
"target": {
168+
"target"/*(16)!*/: {
169169
"failure": {
170170
"greaterThan": {
171171
"fixedValue": "0"
172172
}
173173
}
174174
},
175-
"weight": 1,
176-
"keyObjective": true
175+
"weight"/*(17)!*/: 1,
176+
"keyObjective"/*(18)!*/: true
177177
},
178-
"value": 0,
179-
"score": 1
178+
"value"/*(19)!*/: 0,
179+
"score"/*(20)!*/: 1
180180
}
181181
],
182-
"totalScore": 2,
183-
"maximumScore": 2,
184-
"pass": true,
185-
"warning": false
182+
"totalScore"/*(21)!*/: 2,
183+
"maximumScore"/*(22)!*/: 2,
184+
"pass"/*(23)!*/: true,
185+
"warning"/*(24)!*/: false
186186
}
187187
```
188188

189-
The meaning of each of these properties is as follows:
190-
191-
**`objectiveResults`**: This is an array containing one or more objects,
192-
each representing the results of a specific objective or performance metric.
193-
194-
- The first item in the array:
195-
- **`result`** -- This object contains information about whether the objective has passed or failed.
196-
It has two sub-objects:
197-
- **`failResult`** -- Indicates whether the objective has failed.
198-
In this case, it checks if a value is greater than 500 milliseconds
199-
and it has not been fulfilled (`fulfilled: false`).
200-
- **`warnResult`** -- Indicates whether the objective has issued a warning.
201-
It checks if a value is greater than 300 milliseconds
202-
and it has not been fulfilled (`fulfilled: false`).
203-
- **`warning`** (false in this case).
204-
- **`pass`** -- Indicates whether the objective has passed (true in this case).
205-
- **`objective`** -- Describes the objective being evaluated.
206-
It includes:
207-
- **`analysisValueTemplateRef`** -- Refers to the template used for analysis (`response-time-p95`).
208-
- **`target`** -- Sets the target values for failure and warning conditions.
209-
In this case, failure occurs
210-
if the value is greater than 500 milliseconds
211-
and warning occurs if it's greater than 300 milliseconds.
212-
- **`weight`** -- Specifies the weight assigned to this objective (weight: 1).
213-
- **`value`** -- Indicates the actual value measured for this objective (value: 0.00475).
214-
- **`score`** -- Indicates the score assigned to this objective (score: 1).
215-
216-
- The second item in the array:
217-
- **`result`** -- Similar to the first objective,
218-
it checks whether a value is greater than 0 and has not been fulfilled (`fulfilled: false`).
219-
There are no warning conditions in this case.
220-
- **`objective`** -- Describes the objective related to error rate analysis.
221-
- **`analysisValueTemplateRef`** -- Refers to the template used for analysis (`error-rate`).
222-
- **`target`** -- Sets the target value for failure (failure occurs if the value is greater than 0).
223-
- **`weight`** -- Specifies the weight assigned to this objective (weight: 1).
224-
- **`keyObjective`** -- Indicates that this is a key objective (true).
225-
- **`value`** -- Indicates the actual value measured for this objective (value: 0).
226-
- **`score`** -- Indicates the score assigned to this objective (score: 1).
227-
228-
**`totalScore`** -- Represents the total score achieved based on the objectives evaluated (totalScore: 2).
229-
230-
**`maximumScore`** -- Indicates the maximum possible score (maximumScore: 2).
231-
232-
**`pass`** -- Indicates whether the overall evaluation has passed (true in this case).
233-
234-
**`warning`** -- Indicates whether any warnings have been issued during the evaluation (false in this case).
189+
1. **`objectiveResults`**: This is an array containing one or more objects,
190+
each representing the results of a specific objective or performance metric.
191+
2. **`result`** -- This object contains information about whether the objective has passed or failed.
192+
It has two sub-objects **`failResult`** & **`warnResult`**
193+
3. **`failResult`** -- Indicates whether the objective has failed.
194+
In this case, it checks if a value is greater than 500 milliseconds and it has not been fulfilled (`fulfilled: false`).
195+
4. **`warnResult`** -- Indicates whether the objective has issued a warning.
196+
It checks if a value is greater than 300 milliseconds
197+
5. **`warning`** (false in this case).
198+
6. **`pass`** -- Indicates whether the objective has passed (true in this case).
199+
7. **`objective`** -- Describes the objective being evaluated.
200+
It includes: **`analysisValueTemplateRef`** , **`target`** & **`weight`**
201+
8. **`analysisValueTemplateRef`** -- Refers to the template used for analysis (`response-time-p95`).
202+
9. **`target`** -- Sets the target value for failure (failure occurs if the value is greater than 0).
203+
In this case, failure occurs
204+
if the value is greater than 500 milliseconds and warning occurs if it's greater than 300 milliseconds.
205+
10. **`weight`** -- Specifies the weight assigned to this objective (weight: 1).
206+
11. **`value`** -- Indicates the actual value measured for this objective (value: 0.00475).
207+
12. **`score`** -- Indicates the score assigned to this objective (score: 1).
208+
13. **`result`** -- Similar to the first objective,
209+
it checks whether a value is greater than 0 and has not been fulfilled (`fulfilled: false`).
210+
There are no warning conditions in this case.
211+
14. **`objective`** -- Describes the objective related to error rate analysis.
212+
15. **`analysisValueTemplateRef`** -- Refers to the template used for analysis (`error-rate`).
213+
16. **`target`** -- Sets the target value for failure (failure occurs if the value is greater than 0).
214+
17. **`weight`** -- Specifies the weight assigned to this objective (weight: 1).
215+
18. **`keyObjective`** -- Indicates that this is a key objective (true).
216+
19. **`value`** -- Indicates the actual value measured for this objective (value: 0).
217+
20. **`score`** -- Indicates the score assigned to this objective (score: 1).
218+
21. **`totalScore`** -- Represents the total score achieved based on the objectives evaluated (totalScore: 2).
219+
22. **`maximumScore`** -- Indicates the maximum possible score (maximumScore: 2).
220+
23. **`pass`** -- Indicates whether the overall evaluation has passed (true in this case).
221+
24. **`warning`** -- Indicates whether any warnings have been issued during the evaluation (false in this case).
222+
235223

236224
## Usage
237225

0 commit comments

Comments
 (0)