ServiceGrpcCheck

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

Graph

Reset zoomHide graphShow graph

Supertypes

trait Serializable

trait Product

trait Equals

trait ServiceCheck

class Object

trait Matchable

class Any

Show all