Common application properties
Various properties can be specified inside your application.properties
file, inside your application.yml
file, or as command line switches.
This appendix provides a list of common Spring gRPC
properties.
Name | Default | Description |
---|---|---|
spring.grpc.client.channels |
||
spring.grpc.client.default-channel.address |
||
spring.grpc.client.default-channel.default-load-balancing-policy |
||
spring.grpc.client.default-channel.enable-keep-alive |
||
spring.grpc.client.default-channel.health.enabled |
Whether to enable client-side health check for the channel. |
|
spring.grpc.client.default-channel.health.service-name |
Name of the service to check health on. |
|
spring.grpc.client.default-channel.idle-timeout |
||
spring.grpc.client.default-channel.keep-alive-time |
||
spring.grpc.client.default-channel.keep-alive-timeout |
||
spring.grpc.client.default-channel.keep-alive-without-calls |
||
spring.grpc.client.default-channel.max-inbound-message-size |
||
spring.grpc.client.default-channel.max-inbound-metadata-size |
||
spring.grpc.client.default-channel.negotiation-type |
The negotiation type for the channel. Default is {@link NegotiationType#PLAINTEXT}. |
|
spring.grpc.client.default-channel.secure |
|
Flag to say that strict SSL checks are not enabled (so the remote certificate could be anonymous). |
spring.grpc.client.default-channel.ssl.bundle |
SSL bundle name. |
|
spring.grpc.client.default-channel.ssl.enabled |
Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |
|
spring.grpc.client.default-channel.user-agent |
||
spring.grpc.server.address |
The address to bind to. could be a host:port combination or a pseudo URL like static://host:port. Can not be set if host or port are set independently. |
|
spring.grpc.server.exception-handling.enabled |
|
Whether to enable user-defined global exception handling on the gRPC server. |
spring.grpc.server.health.actuator.enabled |
|
Whether to adapt Actuator health indicators into gRPC health checks. |
spring.grpc.server.health.actuator.health-indicator-paths |
List of Actuator health indicator paths to adapt into gRPC health checks. |
|
spring.grpc.server.health.actuator.update-initial-delay |
|
The initial delay before updating the health status the very first time. |
spring.grpc.server.health.actuator.update-overall-health |
|
Whether to update the overall gRPC server health (the '' service) with the aggregate status of the configured health indicators. |
spring.grpc.server.health.actuator.update-rate |
|
How often to update the health status. |
spring.grpc.server.health.enabled |
|
Whether to auto-configure Health feature on the gRPC server. |
spring.grpc.server.host |
|
Server address to bind to. The default is any IP address ('*'). |
spring.grpc.server.keep-alive.max-age |
Maximum time a connection may exist before being gracefully terminated (default infinite). |
|
spring.grpc.server.keep-alive.max-age-grace |
Maximum time for graceful connection termination (default infinite). |
|
spring.grpc.server.keep-alive.max-idle |
Maximum time a connection can remain idle before being gracefully terminated (default infinite). |
|
spring.grpc.server.keep-alive.permit-time |
|
Maximum keep-alive time clients are permitted to configure (default 5m). |
spring.grpc.server.keep-alive.permit-without-calls |
|
Whether clients are permitted to send keep alive pings when there are no outstanding RPCs on the connection (default false). |
spring.grpc.server.keep-alive.time |
|
Duration without read activity before sending a keep alive ping (default 2h). |
spring.grpc.server.keep-alive.timeout |
|
Maximum time to wait for read activity after sending a keep alive ping. If sender does not receive an acknowledgment within this time, it will close the connection (default 20s). |
spring.grpc.server.max-inbound-message-size |
|
Maximum message size allowed to be received by the server (default 4MiB). |
spring.grpc.server.max-inbound-metadata-size |
|
Maximum metadata size allowed to be received by the server (default 8KiB). |
spring.grpc.server.observations.enabled |
|
Whether to enable Observations on the server. |
spring.grpc.server.port |
|
Server port to listen on. When the value is 0, a random available port is selected. The default is 9090. |
spring.grpc.server.reflection.enabled |
|
Whether to enable Reflection on the gRPC server. |
spring.grpc.server.shutdown-grace-period |
|
Maximum time to wait for the server to gracefully shutdown. When the value is negative, the server waits forever. When the value is 0, the server will force shutdown immediately. The default is 30 seconds. |
spring.grpc.server.ssl.bundle |
SSL bundle name. |
|
spring.grpc.server.ssl.client-auth |
Client authentication mode. |
|
spring.grpc.server.ssl.enabled |
Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |
|
spring.grpc.server.ssl.secure |
|
Flag to indicate that client authentication is secure (i.e. certificates are checked). Do not set this to false in production. |