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: website/docs/concepts/probes.md
+27-27Lines changed: 27 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -25,8 +25,8 @@ These probes can be used in isolation or in several combinations to achieve the
25
25
26
26
The probes can be set up to run in different modes:
27
27
28
-
-**SoT**: Executed at the Start of Test as a pre-chaos check
29
-
-**EoT**: Executed at the End of Test as a post-chaos check
28
+
-**SOT**: Executed at the Start of Test as a pre-chaos check
29
+
-**EOT**: Executed at the End of Test as a post-chaos check
30
30
-**Edge**: Executed both, before and after the chaos
31
31
-**Continuous**: The probe is executed continuously, with a specified polling interval during the chaos injection.
32
32
-**OnChaos**: The probe is executed continuously, with a specified polling interval strictly for chaos duration of chaos
@@ -37,7 +37,7 @@ Some common attributes shared between the Probes:
37
37
-**retry**: The number of times a check is re-run upon failure in the first attempt before declaring the probe status as failed.
38
38
-**interval**: The period between subsequent retries
39
39
-**probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration
40
-
-**initialDelaySeconds**: Represents the initial waiting time interval for the probes.
40
+
-**initialDelay**: Represents the initial waiting time interval for the probes.
41
41
-**stopOnFailure**: It can be set to true/false to stop or continue the fault execution after probe fails
42
42
43
43
:::note
@@ -73,10 +73,10 @@ probe:
73
73
responseCode: '<response code>'
74
74
mode: 'Continuous'
75
75
runProperties:
76
-
probeTimeout: 5
77
-
interval: 5
76
+
probeTimeout: 5s
77
+
interval: 5s
78
78
retry: 1
79
-
probePollingInterval: 2
79
+
probePollingInterval: 2s
80
80
```
81
81
82
82
The `httpProbe` is better used in the Continuous mode of operation as a parallel liveness indicator of a target or downstream application. It uses the `probePollingInterval` property to specify the polling interval for the access checks.
@@ -104,10 +104,10 @@ probe:
104
104
hostNetwork: false
105
105
mode: 'Edge'
106
106
runProperties:
107
-
probeTimeout: 5
108
-
interval: 5
107
+
probeTimeout: 5s
108
+
interval: 5s
109
109
retry: 1
110
-
initialDelaySeconds: 5
110
+
initialDelay: 5s
111
111
```
112
112
113
113
> `source.hostNetwork` can be set to `true` to allow access to the node network namespace for the pod executing the probe
@@ -137,8 +137,8 @@ probe:
137
137
operation: 'present' # it can be present, absent, create, delete
138
138
mode: 'EOT'
139
139
runProperties:
140
-
probeTimeout: 5
141
-
interval: 5
140
+
probeTimeout: 5s
141
+
interval: 5s
142
142
retry: 1
143
143
```
144
144
@@ -162,8 +162,8 @@ probe:
162
162
value: '<value-for-criteria-match>'
163
163
mode: 'Edge'
164
164
runProperties:
165
-
probeTimeout: 5
166
-
interval: 5
165
+
probeTimeout: 5s
166
+
interval: 5s
167
167
retry: 1
168
168
```
169
169
@@ -247,8 +247,8 @@ probe:
247
247
source: 'inline'
248
248
mode: 'SOT'
249
249
runProperties:
250
-
probeTimeout: 5
251
-
interval: 5
250
+
probeTimeout: 5s
251
+
interval: 5s
252
252
retry: 1
253
253
- name: 'probe2'
254
254
type: 'cmdProbe'
@@ -262,8 +262,8 @@ probe:
262
262
source: 'inline'
263
263
mode: 'SOT'
264
264
runProperties:
265
-
probeTimeout: 5
266
-
interval: 5
265
+
probeTimeout: 5s
266
+
interval: 5s
267
267
retry: 1
268
268
```
269
269
@@ -921,11 +921,11 @@ This section describes the different fields of the litmus probes and the possibl
921
921
</tr>
922
922
<tr>
923
923
<th>Range</th>
924
-
<td>n/a <code>type: integer</code></td>
924
+
<td>n/a <code>type: string</code></td>
925
925
</tr>
926
926
<tr>
927
927
<th>Notes</th>
928
-
<td>The <code>.runProperties.probeTimeout</code> represents the time limit for the probe to execute the specified check and return the expected data</td>
928
+
<td>The <code>.runProperties.probeTimeout</code> represents the time limit for the probe to execute the specified check and return the expected data. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
929
929
</tr>
930
930
</table>
931
931
@@ -967,11 +967,11 @@ This section describes the different fields of the litmus probes and the possibl
967
967
</tr>
968
968
<tr>
969
969
<th>Range</th>
970
-
<td>n/a <code>type: integer</code></td>
970
+
<td>n/a <code>type: string</code></td>
971
971
</tr>
972
972
<tr>
973
973
<th>Notes</th>
974
-
<td>The <code>.runProperties.interval</code> contains the interval for which probes waits between subsequent retries</td>
974
+
<td>The <code>.runProperties.interval</code> contains the interval for which probes waits between subsequent retries. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
975
975
</tr>
976
976
</table>
977
977
@@ -990,18 +990,18 @@ This section describes the different fields of the litmus probes and the possibl
990
990
</tr>
991
991
<tr>
992
992
<th>Range</th>
993
-
<td>n/a <code>type: integer</code></td>
993
+
<td>n/a <code>type: string</code></td>
994
994
</tr>
995
995
<tr>
996
996
<th>Notes</th>
997
-
<td>The <code>.runProperties.probePollingInterval</code> contains the time interval for which continuous probe should be sleep after each iteration</td>
997
+
<td>The <code>.runProperties.probePollingInterval</code> contains the time interval for which continuous probe should be sleep after each iteration. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
@@ -1013,11 +1013,11 @@ This section describes the different fields of the litmus probes and the possibl
1013
1013
</tr>
1014
1014
<tr>
1015
1015
<th>Range</th>
1016
-
<td>n/a <code>type: integer</code></td>
1016
+
<td>n/a <code>type: string</code></td>
1017
1017
</tr>
1018
1018
<tr>
1019
1019
<th>Notes</th>
1020
-
<td>The <code>.runProperties.initialDelaySeconds</code> represents the initial waiting time interval for the probes.</td>
1020
+
<td>The <code>.runProperties.initialDelaySeconds</code> represents the initial waiting time interval for the probes. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
1021
1021
</tr>
1022
1022
</table>
1023
1023
@@ -1119,7 +1119,7 @@ This section describes the different fields of the litmus probes and the possibl
1119
1119
1120
1120
Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. There are four kinds of probes `httpProbe` (allows developers to specify a URL which the fault uses to gauge health/service availability as part of the entry/exit criteria), `cmdProbe` (allows developers to run shell commands and match the resulting output as part of the entry/exit criteria), `k8sProbe` (addresses verification of the desired resource state by allowing users to define the Kubernetes GVR with appropriate filters) and `promProbe` (allows users to run Prometheus queries and match the resulting output against specific conditions).
1121
1121
1122
-
The different modes these probes can be used in are `SoT`, `EoT`, `Edge`, `Continuous` and `OnChaos`. The litmus chaos faults run the probes defined in the ChaosEngine and update their stage-wise success in the ChaosResult custom resource with `probeSuccessPercentage`. A `probeSuccessPercentage` is the ratio of successful checks v/s total probes.
1122
+
The different modes these probes can be used in are `SOT`, `EOT`, `Edge`, `Continuous` and `OnChaos`. The litmus chaos faults run the probes defined in the ChaosEngine and update their stage-wise success in the ChaosResult custom resource with `probeSuccessPercentage`. A `probeSuccessPercentage` is the ratio of successful checks v/s total probes.
1123
1123
1124
1124
Probes can be Chained, Probe chaining enables reuse of probe, the order of execution of probes in the fault depends purely on the order in which they are defined in the ChaosEngine.
0 commit comments