HttpStatsHealthCheck.md

---

sidebar_position: 2 sidebar_label: 'Metrics (HTTP) Health Check'

HttpStatsHealthCheck

This health check monitors actual (live) HTTP calls to downstream systems to collect response status codes, and reports their outcomes. If the number of failed calls (StatusCode >= 400) is below WarnThreshold, results will have a status of Warn. If below FailThreshold, results will have a status of Fail.

In your Startup.cs file, add the following code to ConfigureServices:

builder.ConfigureRockLibHealthChecks();

The above is in addition to app.UseRockLibHealthChecks();, in the Configure method.

Parameter	Default Value	Description
warningThreshold	"0.9"	The lowest percentage of HTTP status codes >=400, below which results in a Warn status.
errorThreshold	"0.75"	The lowest percentage of HTTP status codes >=400, below which results in a Fail status.
samples	100	The number of sample data points to keep. Collection is done using a sliding window - e.g. "the 100 most recent".
minimumSamples	1	The minimum number of samples to collect before evaluating the health check. If the number of samples is less than this value, the health check will return Warn. This number must be smaller than samples.
collectors	"[]"	An explicit list of collector thresholds. If not provided, the default values (above) will be used.
collector->Name	""	The http host name of the downstream system (to bind the settings to).

Note: A collector is created for each http host name regardless. The above settings are only necessary if you want to override the default sample size or thresholds.

Example appsettings.json:

{
  "RockLib.HealthChecks": {
      "healthChecks": [
        {
          "type": "RockLib.HealthChecks.AspNetCore.Checks.HttpStatsHealthCheck, RockLib.HealthChecks.AspNetCore",
          "value": {
            "warningThreshold": ".98",
            "errorThreshold": ".95",
            "samples": 500,
            "minimumSamples": 10,
            "collectors": [
              {
                "Name": "www.google.com",
                "samples": 50,
                "warningThreshold": ".80",
                "errorThreshold": ".70"
              }
            ]
          }
        }
      ]
    }
}