Skip to content

Commit

Permalink
Merge pull request #1 from kennygrant/master
Browse files Browse the repository at this point in the history
Fixed trivial spelling/grammar errors in readme
  • Loading branch information
karthikmuralidharan authored Sep 18, 2017
2 parents 02620b0 + a91e029 commit 00e330d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

A simple and extensible RESTful Healthcheck API implementation for Go services.

Health provides an `http.Handlefunc` for use as a healthcheck endpoint used bu external services or loadbalancers
for determining the health of the application and to remove the application host or container out of rotation in case it is found to be unhealthy.
Health provides an `http.Handlefunc` for use as a healthcheck endpoint used by external services or load balancers
for determining the health of the application and to remove the application host or container from rotation if it is found to be unhealthy.

Instead of blindly return a `200` HTTP status code, a healthcheck endpoint should test all the mandatory dependencies that are essential for proper functioning of a web service.
Instead of blindly returning a `200` HTTP status code, a healthcheck endpoint should test all the mandatory dependencies that are essential for proper functioning of a web service.

By implementing the `Checker` interface and passing it on to healthcheck allows you to test the the dependencies such as a database connection, caches, files and even external services you rely on. You may choose to not fail the healthcheck on failure of certain dependencies such as external services that you are not always dependent on.
Implementing the `Checker` interface and passing it on to healthcheck allows you to test the the dependencies such as a database connection, caches, files and even external services you rely on. You may choose to not fail the healthcheck on failure of certain dependencies such as external services that you are not always dependent on.

## Example

Expand Down Expand Up @@ -46,7 +46,7 @@ By implementing the `Checker` interface and passing it on to healthcheck allows
}
```

Based on the example provided above, `curl localhost:8080/healthcheck | jq` should yield in a response in case of errors with an HTTP statusCode of `503`.
Based on the example provided above, `curl localhost:8080/healthcheck | jq` should yield on error a response with an HTTP statusCode of `503`.

``` JSON
{
Expand All @@ -56,4 +56,4 @@ Based on the example provided above, `curl localhost:8080/healthcheck | jq` shou
"heartbeat": "heartbeat not found. application should be out of rotation"
}
}
```
```

0 comments on commit 00e330d

Please sign in to comment.