Cimfu.Suave.Healthcheck
A pluggable healthcheck endpoint for the Suave functional web server. Based on the healthcheck.spec specification, with a modification that allows a message to be recorded on health checks that pass.
PM> Install-Package Cimfu.Suave.Healthcheck
Example
This example demonstrates attaching the main server switch healthcheck to a Suave WebPart
.
1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: |
|
Samples & documentation
For additional documentation, see our tutorial and API reference. The source is also well-documented.
Tutorial contains a few examples of how you can use the healthcheck features provided by this library.
API Reference contains automatically generated documentation for all types, modules and functions in the library. This includes additional brief samples on using most of the functions.
Versioning
This project is versioned following SemVer v2.0 conventions. The library is currently in a pre-version-1.0 state, which means that minor version increments may contain breaking changes. Once version 1.0 is released, the package will be versioned such that breaking changes are only introduced with a major version increment. Minor version increments indicate new functionality, and patch increments indicate bug fixes or minor internal changes.
Contributing and copyright
The project is hosted on GitHub where you can report issues, fork the project and submit pull requests. If you're adding a new public API, please also consider adding samples that can be turned into a documentation. You might also want to read the library design notes to understand how it works.
The library is available under the Apache v2 license, which allows modification and redistribution for both commercial and non-commercial purposes. For more information see the License file in the GitHub repository.
Build status
This project is automatically built by Travis CI and AppVeyor. The current status of the master branch:
from Suave
from Cimfu.Suave
Full name: Index.myApp
Full name: Index.hcMap
module Map
from Microsoft.FSharp.Collections
--------------------
type Map<'Key,'Value (requires comparison)> =
interface IEnumerable
interface IComparable
interface IEnumerable<KeyValuePair<'Key,'Value>>
interface ICollection<KeyValuePair<'Key,'Value>>
interface IDictionary<'Key,'Value>
new : elements:seq<'Key * 'Value> -> Map<'Key,'Value>
member Add : key:'Key * value:'Value -> Map<'Key,'Value>
member ContainsKey : key:'Key -> bool
override Equals : obj -> bool
member Remove : key:'Key -> Map<'Key,'Value>
...
Full name: Microsoft.FSharp.Collections.Map<_,_>
--------------------
new : elements:seq<'Key * 'Value> -> Map<'Key,'Value>
Full name: Microsoft.FSharp.Collections.Map.ofList
from Cimfu.Suave.Healthcheck
Full name: Cimfu.Suave.Healthcheck.Checks.serverMain
Full name: Index.app
Full name: Cimfu.Suave.Healthcheck.prefixWithHealthcheck