ServiceTCPCheck
consul4s.model.agent.ServiceTCPCheck
final case class ServiceTCPCheck(Name: String, TCP: String, Interval: String, Timeout: String, CheckID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], SuccessBeforePassing: Int, FailuresBeforeCritical: Int, DeregisterCriticalServiceAfter: Option[String]) extends ServiceCheck
Value parameters
- CheckID
-
- Specifies a unique ID for this check on the node. This defaults to the "Name" parameter, but it may be necessary to provide an ID for uniqueness.
- DeregisterCriticalServiceAfter
-
- Specifies that checks associated with a service should deregister after this time. This is specified as a time duration with suffix like "10m". If a check is in the critical state for more than this configured value, then its associated service (and all of its associated checks) will automatically be deregistered. The minimum timeout is 1 minute, and the process that reaps critical services runs every 30 seconds, so it may take slightly longer than the configured timeout to trigger the deregistration. This should generally be configured with a timeout that's much, much longer than any expected recoverable outage for the given service.
- Interval
-
- Specifies the frequency at which to run this check. This is required for HTTP and TCP checks.
- Name
-
- Specifies the name of the check.
- Notes
-
- Specifies arbitrary information for humans. This is not used by Consul internally.
- ServiceID
-
- Specifies the ID of a service to associate the registered check with an existing service provided by the agent.
- Status
-
- Specifies the initial status of the health check.
- TCP
-
- Specifies a TCP to connect against the value of TCP (expected to be an IP or hostname plus port combination) every Interval. If the connection attempt is successful, the check is passing. If the connection attempt is unsuccessful, the check is critical. In the case of a hostname that resolves to both IPv4 and IPv6 addresses, an attempt will be made to both addresses, and the first successful connection attempt will result in a successful check.
- Timeout
-
- Specifies a timeout for outgoing connections in the case of a Script, HTTP, TCP, or gRPC check. Can be specified in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively).
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait ServiceCheckclass Objecttrait Matchableclass Any
Members list
In this article