core
API
Generated with
core/consul4s/consul4s.model/consul4s.model.agent

consul4s.model.agent

package consul4s.model.agent

Members list

Type members

Classlikes

final case class AggregatedServiceStatus(AggregatedStatus: CheckStatus, Service: Service, Checks: List[HealthCheck])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class AliasCheck(ID: String, AliasNode: Option[String], AliasService: Option[String]) extends Check

Value parameters

AliasNode
  • Specifies the ID of the node for an alias check. If no service is specified, the check will alias the health of the node. If a service is specified, the check will alias the specified service on this particular node.
AliasService
  • Specifies the ID of a service for an alias check. If the service is not registered with the same agent, AliasNode must also be specified. Note this is the service ID and not the service name (though they are very often the same).
ID
  • 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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Check
class Object
trait Matchable
class Any
Show all
sealed trait Check

https://www.consul.io/docs/agent/checks

https://www.consul.io/docs/agent/checks

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AliasCheck
class DockerCheck
class GrpcCheck
class HttpCheck
class ScriptCheck
class TCPCheck
class TTLCheck
Show all
final case class CheckUpdate(Status: CheckStatus, Output: Option[String])

Value parameters

Output
  • Specifies a human-readable message. This will be passed through to the check's Output field.
Status
  • Specifies the status of the check. Valid values are "passing", "warning", and "critical".

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DockerCheck(Name: String, DockerContainerID: String, Shell: String, Args: List[String], Interval: Option[String], ID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], SuccessBeforePassing: Int, FailuresBeforeCritical: Int, DeregisterCriticalServiceAfter: Option[String]) extends Check

Value parameters

Args
  • Specifies command arguments to run to update the status of the check.
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.
DockerContainerID
  • Specifies that the check is a Docker check, and Consul will evaluate the script every Interval in the given container using the specified Shell. Note that Shell is currently only supported for Docker checks.
ID
  • 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.
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Check
class Object
trait Matchable
class Any
Show all
final case class GrpcCheck(Name: String, GRPC: String, GRPCUseTLS: Boolean, Interval: Option[String], ID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], SuccessBeforePassing: Int, FailuresBeforeCritical: Int, DeregisterCriticalServiceAfter: Option[String]) extends Check

Value parameters

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.
GRPC
  • Specifies a gRPC check's endpoint that supports the standard gRPC health checking protocol. The state of the check will be updated at the given Interval by probing the configured endpoint. Add the service identifier after the gRPC check's endpoint in the following format to check for a specific service instead of the whole gRPC server /:service_identifier.
GRPCUseTLS
  • Specifies whether to use TLS for this gRPC health check. If TLS is enabled, then by default, a valid TLS certificate is expected. Certificate verification can be turned off by setting TLSSkipVerify to true.
ID
  • 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.
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Check
class Object
trait Matchable
class Any
Show all
final case class HttpCheck(Name: String, HTTP: String, TLSSkipVerify: Boolean, Interval: String, Timeout: String, Header: Option[Map[String, List[String]]], Method: Option[String], Body: Option[String], ID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], SuccessBeforePassing: Int, FailuresBeforeCritical: Int, DeregisterCriticalServiceAfter: Option[String]) extends Check

Value parameters

Body
  • - 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).
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.
HTTP
  • Specifies an HTTP check to perform a GET request against the value of HTTP (expected to be a URL) every Interval. If the response is any 2xx code, the check is passing. If the response is 429 Too Many Requests, the check is warning. Otherwise, the check is critical. HTTP checks also support SSL. By default, a valid SSL certificate is expected. Certificate verification can be controlled using the TLSSkipVerify.
Header
  • Specifies a body that should be sent with HTTP checks.
ID
  • 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.
Interval
  • Specifies a different HTTP method to be used for an HTTP check. When no value is specified, GET is used.
Method
  • 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.
TLSSkipVerify
  • Specifies if the certificate for an HTTPS check should not be verified.
Timeout
  • Specifies a set of headers that should be set for HTTP checks. Each header can have multiple values.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Check
class Object
trait Matchable
class Any
Show all
final case class MemberInfo(Name: String, Addr: String, Port: Int, Tags: Option[Map[String, String]], Status: Int, ProtocolMin: Int, ProtocolMax: Int, ProtocolCur: Int, DelegateMin: Int, DelegateMax: Int, DelegateCur: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class NewService(Name: String, ID: Option[String], Tags: Option[List[String]], Address: Option[String], TaggedAddresses: Option[Map[String, TaggedAddress]], Meta: Option[Map[String, String]], Port: Option[Int], Check: Option[ServiceCheck], Checks: Option[List[ServiceCheck]], EnableTagOverride: Boolean, Weights: Option[Weights])

Value parameters

Address
  • Specifies the address of the service. If not provided, the agent's address is used as the address for the service during DNS queries.
Check
  • Specifies a list of service level checks. Please see the check documentation for more information about the accepted fields. If you don't provide a name or id for the check then they will be generated. To provide a custom id and/or name set the CheckID and/or Name field. The automatically generated Name and CheckID depend on the position of the check within the array, so even though the behavior is deterministic, it is recommended for all checks to either let consul set the CheckID by leaving the field empty/omitting it or to provide a unique value.
EnableTagOverride
  • Specifies to disable the anti-entropy feature for this service's tags. If EnableTagOverride is set to true then external agents can update this service in the catalog and modify the tags. Subsequent local sync operations by this agent will ignore the updated tags. For instance, if an external agent modified both the tags and the port for this service and EnableTagOverride was set to true then after the next sync cycle the service's port would revert to the original value but the tags would maintain the updated value. As a counter example, if an external agent modified both the tags and port for this service and EnableTagOverride was set to false then after the next sync cycle the service's port and the tags would revert to the original value and all modifications would be lost.
ID
  • Specifies a unique ID for this service. This must be unique per agent. This defaults to the Name parameter if not provided.
Meta
  • Specifies arbitrary KV metadata linked to the service instance.
Name
  • Specifies the logical name of the service. Many service instances may share the same logical service name. We recommend using valid DNS labels for compatibility with external DNS.
Port
  • Specifies the port of the service.
TaggedAddresses
  • Specifies a map of explicit LAN and WAN addresses for the service instance. Both the address and port can be specified within the map values.
Tags
  • Specifies a list of tags to assign to the service. These tags can be used for later filtering and are exposed via the APIs. We recommend using valid DNS labels for compatibility with external DNS
Weights
  • Specifies weights for the service. Please see the service documentation for more information about weights. If this field is not provided weights will default to {"Passing": 1, "Warning": 1}.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ScriptCheck(Name: String, Args: List[String], Timeout: Option[String], Interval: Option[String], ID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], DeregisterCriticalServiceAfter: Option[String]) extends Check

Value parameters

Args
  • Specifies command arguments to run to update the status of the check.
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.
ID
  • 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.
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.
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

Supertypes
trait Serializable
trait Product
trait Equals
trait Check
class Object
trait Matchable
class Any
Show all
final case class Service(Service: String, ID: String, Tags: Option[List[String]], Address: String, TaggedAddresses: Option[Map[String, TaggedAddress]], Meta: Option[Map[String, String]], Port: Int, EnableTagOverride: Boolean, Weights: Weights)

Value parameters

Address
  • Specifies the address of the service. If not provided, the agent's address is used as the address for the service during DNS queries.
EnableTagOverride
  • Specifies to disable the anti-entropy feature for this service's tags. If EnableTagOverride is set to true then external agents can update this service in the catalog and modify the tags. Subsequent local sync operations by this agent will ignore the updated tags. For instance, if an external agent modified both the tags and the port for this service and EnableTagOverride was set to true then after the next sync cycle the service's port would revert to the original value but the tags would maintain the updated value. As a counter example, if an external agent modified both the tags and port for this service and EnableTagOverride was set to false then after the next sync cycle the service's port and the tags would revert to the original value and all modifications would be lost.
ID
  • Specifies a unique ID for this service. This must be unique per agent. This defaults to the Name parameter if not provided.
Meta
  • Specifies arbitrary KV metadata linked to the service instance.
Port
  • Specifies the port of the service.
Service
  • Specifies the logical name of the service. Many service instances may share the same logical service name. We recommend using valid DNS labels for compatibility with external DNS.
TaggedAddresses
  • Specifies a map of explicit LAN and WAN addresses for the service instance. Both the address and port can be specified within the map values.
Tags
  • Specifies a list of tags to assign to the service. These tags can be used for later filtering and are exposed via the APIs. We recommend using valid DNS labels for compatibility with external DNS
Weights
  • Specifies weights for the service. Please see the service documentation for more information about weights. If this field is not provided weights will default to {"Passing": 1, "Warning": 1}.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ServiceAliasCheck(CheckID: String, AliasNode: Option[String], AliasService: Option[String]) extends ServiceCheck

Value parameters

AliasNode
  • Specifies the ID of the node for an alias check. If no service is specified, the check will alias the health of the node. If a service is specified, the check will alias the specified service on this particular node.
AliasService
  • Specifies the ID of a service for an alias check. If the service is not registered with the same agent, AliasNode must also be specified. Note this is the service ID and not the service name (though they are very often the same).
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ServiceCheck
class Object
trait Matchable
class Any
Show all
sealed trait ServiceCheck

https://www.consul.io/docs/agent/checks

https://www.consul.io/docs/agent/checks

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
final case class ServiceDockerCheck(Name: String, DockerContainerID: String, Shell: String, Args: List[String], Interval: Option[String], CheckID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], SuccessBeforePassing: Int, FailuresBeforeCritical: Int, DeregisterCriticalServiceAfter: Option[String]) extends ServiceCheck

Value parameters

Args
  • Specifies command arguments to run to update the status of the check.
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.
DockerContainerID
  • Specifies that the check is a Docker check, and Consul will evaluate the script every Interval in the given container using the specified Shell. Note that Shell is currently only supported for Docker checks.
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ServiceCheck
class Object
trait Matchable
class Any
Show all
final case class ServiceGrpcCheck(Name: String, GRPC: String, GRPCUseTLS: Boolean, Interval: Option[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.
GRPC
  • Specifies a gRPC check's endpoint that supports the standard gRPC health checking protocol. The state of the check will be updated at the given Interval by probing the configured endpoint. Add the service identifier after the gRPC check's endpoint in the following format to check for a specific service instead of the whole gRPC server /:service_identifier.
GRPCUseTLS
  • Specifies whether to use TLS for this gRPC health check. If TLS is enabled, then by default, a valid TLS certificate is expected. Certificate verification can be turned off by setting TLSSkipVerify to true.
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ServiceCheck
class Object
trait Matchable
class Any
Show all
final case class ServiceHttpCheck(Name: String, HTTP: String, TLSSkipVerify: Boolean, Interval: String, Timeout: String, Header: Option[Map[String, List[String]]], Method: Option[String], Body: Option[String], CheckID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], SuccessBeforePassing: Int, FailuresBeforeCritical: Int, DeregisterCriticalServiceAfter: Option[String]) extends ServiceCheck

Value parameters

Body
  • - 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).
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.
HTTP
  • Specifies an HTTP check to perform a GET request against the value of HTTP (expected to be a URL) every Interval. If the response is any 2xx code, the check is passing. If the response is 429 Too Many Requests, the check is warning. Otherwise, the check is critical. HTTP checks also support SSL. By default, a valid SSL certificate is expected. Certificate verification can be controlled using the TLSSkipVerify.
Header
  • Specifies a body that should be sent with HTTP checks.
Interval
  • Specifies a different HTTP method to be used for an HTTP check. When no value is specified, GET is used.
Method
  • 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.
TLSSkipVerify
  • Specifies if the certificate for an HTTPS check should not be verified.
Timeout
  • Specifies a set of headers that should be set for HTTP checks. Each header can have multiple values.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ServiceCheck
class Object
trait Matchable
class Any
Show all
final case class ServiceScriptCheck(Name: String, Args: List[String], Timeout: Option[String], Interval: Option[String], CheckID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], DeregisterCriticalServiceAfter: Option[String]) extends ServiceCheck

Value parameters

Args
  • Specifies command arguments to run to update the status of the check.
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 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).
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.
Timeout
  • Specifies the frequency at which to run this check. This is required for HTTP and TCP checks.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ServiceCheck
class Object
trait Matchable
class Any
Show all
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

Supertypes
trait Serializable
trait Product
trait Equals
trait ServiceCheck
class Object
trait Matchable
class Any
Show all
final case class ServiceTTLCheck(Name: String, TTL: String, CheckID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], 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.
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.
TTL
  • Specifies this is a TTL check, and the TTL endpoint must be used periodically to update the state of the check.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ServiceCheck
class Object
trait Matchable
class Any
Show all
final case class TCPCheck(Name: String, TCP: String, Interval: String, Timeout: String, ID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], SuccessBeforePassing: Int, FailuresBeforeCritical: Int, DeregisterCriticalServiceAfter: Option[String]) extends Check

Value parameters

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.
ID
  • 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.
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

Supertypes
trait Serializable
trait Product
trait Equals
trait Check
class Object
trait Matchable
class Any
Show all
final case class TTLCheck(Name: String, TTL: String, ID: Option[String], ServiceID: Option[String], Status: CheckStatus, Notes: Option[String], DeregisterCriticalServiceAfter: Option[String]) extends Check

Value parameters

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.
ID
  • 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.
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.
TTL
  • Specifies this is a TTL check, and the TTL endpoint must be used periodically to update the state of the check.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Check
class Object
trait Matchable
class Any
Show all
final case class TaggedAddress(Address: String, Port: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Token(Token: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract class UpstreamDestType(val value: String)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PreparedQuery.type
object Service.type
object UpstreamDestType

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Weights(Passing: Int, Warning: Int)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Weights

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Weights.type
Generated with