Skip to content

Commit bfb5db3

Browse files
committed
edit pass: probes-codepackage
1 parent 8eed982 commit bfb5db3

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

articles/service-fabric/probes-codepackage.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,47 @@ title: Azure Service Fabric probes
33
description: How to model a liveness probe in Azure Service Fabric by using application and service manifest files.
44

55
ms.topic: conceptual
6+
author: tugup
7+
ms.author: tugup
68
ms.date: 3/12/2020
79
---
810
# Liveness probe
9-
Starting with version 7.1, Service Fabric supports a liveness probe mechanism for [containerized][containers-introduction-link] applications. A liveness probe helps to report the liveness of a containerized application, which will restart if it does not respond in a timely fashion.
11+
Starting with version 7.1, Azure Service Fabric supports a liveness probe mechanism for [containerized][containers-introduction-link] applications. A liveness probe helps to report the liveness of a containerized application, which will restart if it doesn't respond quickly.
1012
This article provides an overview of how to define a liveness probe by using manifest files.
1113

12-
Before proceeding with this article, you should become familiar with the [Service Fabric application model][application-model-link] and the [Service Fabric hosting model][hosting-model-link].
14+
Before you proceed with this article, become familiar with the [Service Fabric application model][application-model-link] and the [Service Fabric hosting model][hosting-model-link].
1315

1416
> [!NOTE]
15-
> Liveness probe is only supported for containers on in network address translation mode.
17+
> Liveness probe is supported only for containers in NAT networking mode.
1618
1719
## Semantics
1820
You can specify only one liveness probe per container and can control its behavior by using these fields:
1921

20-
* `initialDelaySeconds`: The initial delay in seconds to start executing the probe once the container has started. The supported value is int (default: 0; minimum: 0).
22+
* `initialDelaySeconds`: The initial delay in seconds to start executing the probe after the container has started. The supported value is **int**. The default is 0 and the minimum is 0.
2123

22-
* `timeoutSeconds`: The period in seconds after which the probe is considered to have failed, if it hasn't completed successfully. The supported value is int (default: 1; minimum: 1).
24+
* `timeoutSeconds`: The period in seconds after which we consider the probe as failed, if it hasn't finished successfully. The supported value is **int**. The default is 1 and the minimum is 1.
2325

24-
* `periodSeconds`: The period in seconds to specify the frequency of the probe. The supported value is int (default: 10; minimum: 1).
26+
* `periodSeconds`: The period in seconds to specify the frequency of the probe. The supported value is **int**. The default is 10 and the minimum is 1.
2527

26-
* `failureThreshold`: When this value is reached the container will restart. The supported value is int (default: 3; minimum: 1).
28+
* `failureThreshold`: When we hit this value, the container will restart. The supported value is **int**. The default is 3 and the minimum is 1.
2729

28-
* `successThreshold`: On failure, for the probe to be considered successful, it has to execute successfully for this value. The supported value is int (default: 1; minimum: 1).
30+
* `successThreshold`: On failure, for the probe to be considered successful, it has to run successfully for this value. The supported value is **int**. The default is 1 and the minimum is 1.
2931

30-
There can be, at most, one probe to one container at any moment in time. If the probe does not complete in the time set in **timeoutSeconds**, wait and count the time towards the **failureThreshold**.
32+
There can be, at most, one probe to one container at any moment. If the probe doesn't finish in the time set in **timeoutSeconds**, wait and count the time toward the **failureThreshold**.
3133

32-
Additionally, Service Fabric will raise the following probe [Health Reports][health-introduction-link] on **DeployedServicePackage**:
34+
Additionally, Service Fabric will raise the following probe [health reports][health-introduction-link] on **DeployedServicePackage**:
3335

3436
* `OK`: The probe succeeds for the value set in **successThreshold**.
3537

3638
* `Error`: The probe **failureCount** == **failureThreshold**, before the container restarts.
3739

3840
* `Warning`:
3941
* The probe fails and **failureCount** < **failureThreshold**. This health report stays until **failureCount** reaches the value set in **failureThreshold** or **successThreshold**.
40-
* On success post failure, the warning remains but with updated consecutive successes.
42+
* On success after failure, the warning remains but with updated consecutive successes.
4143

4244
## Specifying a liveness probe
4345

44-
You can specify a probe in the ApplicationManifest.xml file under **ServiceManifestImport**:
46+
You can specify a probe in the ApplicationManifest.xml file under **ServiceManifestImport**.
4547

4648
The probe can be for any of the following:
4749

@@ -51,7 +53,7 @@ The probe can be for any of the following:
5153

5254
### HTTP probe
5355

54-
For an HTTP probe, Service Fabric will send an HTTP request to the port and path that you specify. A return code that is greater than, or equal to, 200 and less than 400 indicates success.
56+
For an HTTP probe, Service Fabric will send an HTTP request to the port and path that you specify. A return code that is greater than or equal to 200, and less than 400, indicates success.
5557

5658
Here is an example of how to specify an HTTP probe:
5759

@@ -74,21 +76,21 @@ Here is an example of how to specify an HTTP probe:
7476
</ServiceManifestImport>
7577
```
7678

77-
The HTTP probe has additional properties you can set as follows:
79+
The HTTP probe has additional properties that you can set:
7880

7981
* `path`: The path to use in the HTTP request.
8082

81-
* `port`: The port to use for probes. The range is 1 to 65535 (mandatory).
83+
* `port`: The port to use for probes. This property is mandatory. The range is 1 to 65535.
8284

83-
* `scheme`: The scheme to use for connecting to the code package. If this is set to HTTPS, the certificate verification is skipped. The default setting is HTTP.
85+
* `scheme`: The scheme to use for connecting to the code package. If this property is set to HTTPS, the certificate verification is skipped. The default setting is HTTP.
8486

8587
* `httpHeader`: The headers to set in the request. You can specify multiple headers.
8688

8789
* `host`: The host IP address to connect to.
8890

8991
### TCP probe
9092

91-
For a TCP probe, Service Fabric will try to open a socket on the container by using the specified port. If it can establish a connection, the probe is considered successful. Here is an example of how to specify a probe that uses a TCP socket:
93+
For a TCP probe, Service Fabric will try to open a socket on the container by using the specified port. If it can establish a connection, the probe is considered successful. Here's an example of how to specify a probe that uses a TCP socket:
9294

9395
```xml
9496
<ServiceManifestImport>
@@ -108,11 +110,11 @@ For a TCP probe, Service Fabric will try to open a socket on the container by us
108110

109111
### Exec probe
110112

111-
This probe will issue an **exec** command into the container and wait for the command to complete.
113+
This probe will issue an **exec** command into the container and wait for the command to finish.
112114

113115
> [!NOTE]
114116
> **Exec** command takes a comma separated string. The command in the following example will work for a Linux container.
115-
> If you are trying to probe a Windows container, use **cmd**.
117+
> If you're trying to probe a Windows container, use **cmd**.
116118
117119
```xml
118120
<ServiceManifestImport>
@@ -133,8 +135,8 @@ This probe will issue an **exec** command into the container and wait for the co
133135
```
134136

135137
## Next steps
136-
See the following articles for related information.
137-
* [Service Fabric and containers.][containers-introduction-link]
138+
See the following article for related information:
139+
* [Service Fabric and containers][containers-introduction-link]
138140

139141
<!-- Links -->
140142
[containers-introduction-link]: service-fabric-containers-overview.md

0 commit comments

Comments
 (0)