tonyair/silverstripe-environmentcheck
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-environmentcheck synced 2024-10-22 17:05:40 +02:00
Code Issues Projects Releases Wiki Activity

MINOR: Fixed a few typos

Browse Source
This commit is contained in:
Sam Minnee 2012-01-10 19:31:03 +13:00
parent 9426ffb12e
commit 8b84150acd
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -4,7 +4,7 @@ Developed by Sam Minnée, thanks to Will Rossiter.
This module adds an API for running environment checks to your API. This module adds an API for running environment checks to your API.
* `dev/health`` - A public URL that performs a quick check that this environment is functioning. This could be tied to a load balancer, for example. * `dev/health` - A public URL that performs a quick check that this environment is functioning. This could be tied to a load balancer, for example.
* `dev/check` - An admin-only URL that performs a more comprehensive set of checks. This could be tied to a deployment system, for example. * `dev/check` - An admin-only URL that performs a more comprehensive set of checks. This could be tied to a deployment system, for example.
## Aren't these just unit tests? ## Aren't these just unit tests?
@ -24,10 +24,10 @@ To add more checks, you should put additional `EnvironmentCheckSuite::register`
The first argument is the name of the check suite. There are two built-in check suites, "health", and "check", corresponding to the `dev/health` and `dev/check` URLs. If you wish, you can create your own check suites and execute them on other URLs. The first argument is the name of the check suite. There are two built-in check suites, "health", and "check", corresponding to the `dev/health` and `dev/check` URLs. If you wish, you can create your own check suites and execute them on other URLs.
The module comes bundled with a few checks in DefaultHealthChecks.php. However, to test your own application, you probably want to write custom checks. The module comes bundled with a few checks in `DefaultHealthChecks.php`. However, to test your own application, you probably want to write custom checks.
* Implement the EnvironmentCheck interface * Implement the `EnvironmentCheck` interface
* Define the check() function, which returns a 2 element array: * Define the `check()` function, which returns a 2 element array:
* The first element is one of `EnvironmentCheck::OK`, `EnvironmentCheck::WARNING`, `EnvironmentCheck::ERROR`, depending on the status of the check * The first element is one of `EnvironmentCheck::OK`, `EnvironmentCheck::WARNING`, `EnvironmentCheck::ERROR`, depending on the status of the check
* The second element is a string describing the response. * The second element is a string describing the response.
@ -77,8 +77,8 @@ If you wish to embed an environment check suite in another, you can use the foll
`$result` will contain a `EnvironmentCheckSuiteResult` object `$result` will contain a `EnvironmentCheckSuiteResult` object
* **`$result->ShouldPass()`:** Return a boolean of whether or not the tests passed. * `$result->ShouldPass()`: Return a boolean of whether or not the tests passed.
* **`$result->Status()`:** The string "OK", "WARNING", or "ERROR", depending on the worst failure. * `$result->Status()`: The string "OK", "WARNING", or "ERROR", depending on the worst failure.
* **`$result->Details()`:** A `DataObjectSet` of details about the result of each check in the suite. * `$result->Details()`: A `DataObjectSet` of details about the result of each check in the suite.
See `EnvironmentChecker.ss` to see how these can be used to build a UI. See `EnvironmentChecker.ss` to see how these can be used to build a UI.