Documentation

Health

Table of Contents

$failingStreak  : int|null
FailingStreak is the number of consecutive failures.
$log  : array<string|int, HealthcheckResult>|null
Log contains the last few results (oldest first).
$status  : string|null
Status is one of `none`, `starting`, `healthy` or `unhealthy`.
getFailingStreak()  : int|null
FailingStreak is the number of consecutive failures.
getLog()  : array<string|int, HealthcheckResult>|null
Log contains the last few results (oldest first).
getStatus()  : string|null
Status is one of `none`, `starting`, `healthy` or `unhealthy`.
setFailingStreak()  : self
FailingStreak is the number of consecutive failures.
setLog()  : self
Log contains the last few results (oldest first).
setStatus()  : self
Status is one of `none`, `starting`, `healthy` or `unhealthy`.

Properties

$failingStreak

FailingStreak is the number of consecutive failures.

protected int|null $failingStreak

$status

Status is one of `none`, `starting`, `healthy` or `unhealthy`.

protected string|null $status

Methods

getFailingStreak()

FailingStreak is the number of consecutive failures.

public getFailingStreak() : int|null
Return values
int|null

getStatus()

Status is one of `none`, `starting`, `healthy` or `unhealthy`.

public getStatus() : string|null
  • "unhealthy" Unhealthy indicates that the container has a problem
Return values
string|null

setFailingStreak()

FailingStreak is the number of consecutive failures.

public setFailingStreak(int|null $failingStreak) : self
Parameters
$failingStreak : int|null
Return values
self

setLog()

Log contains the last few results (oldest first).

public setLog(array<string|int, HealthcheckResult>|null $log) : self
Parameters
$log : array<string|int, HealthcheckResult>|null
Return values
self

setStatus()

Status is one of `none`, `starting`, `healthy` or `unhealthy`.

public setStatus(string|null $status) : self
  • "unhealthy" Unhealthy indicates that the container has a problem
Parameters
$status : string|null
Return values
self

Search results