Micronaut GRPC Configuration Reference

Every documented configuration property of Micronaut GRPC, with types, descriptions, and defaults.

358 properties across 5 sections

Micronaut Grpc Client Runtime Config Properties

Configuration properties for NettyChannelBuilder

Property	Type	Description
`grpc.client.direct-executor`	boolean
`grpc.client.executor`	java.util.concurrent.Executor
`grpc.client.offload-executor`	java.util.concurrent.Executor
`grpc.client.intercept`	java.util.List
`grpc.client.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.client.r-agent`	java.lang.String
`grpc.client.override-authority`	java.lang.String
`grpc.client.default-load-balancing-policy`	java.lang.String
`grpc.client.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.client.compressor-registry`	io.grpc.CompressorRegistry
`grpc.client.idle-timeout`	java.time.Duration
`grpc.client.max-retry-attempts`	int
`grpc.client.max-hedged-attempts`	int
`grpc.client.retry-buffer-size`	long
`grpc.client.per-rpc-buffer-limit`	long
`grpc.client.disable-retry`	boolean
`grpc.client.enable-retry`	boolean
`grpc.client.set-binary-log`	io.grpc.BinaryLog
`grpc.client.max-trace-events`	int
`grpc.client.proxy-detector`	io.grpc.ProxyDetector
`grpc.client.default-service-config`	java.util.Map
`grpc.client.disable-service-config-look-up`	boolean
`grpc.client.build`	boolean
`grpc.client.to-string`	boolean
`grpc.client.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.client.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.client.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.client.initial-flow-control-window`	int
`grpc.client.flow-control-window`	int
`grpc.client.plaintext`	boolean
`grpc.client.transport-security`	boolean
`grpc.client.keep-alive-time`	java.time.Duration
`grpc.client.keep-alive-timeout`	java.time.Duration
`grpc.client.keep-alive-without-calls`	boolean
`grpc.client.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.client.max-inbound-message-size`	int
`grpc.channels.*.direct-executor`	boolean
`grpc.channels.*.executor`	java.util.concurrent.Executor
`grpc.channels.*.offload-executor`	java.util.concurrent.Executor
`grpc.channels.*.intercept`	java.util.List
`grpc.channels.*.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.channels.*.r-agent`	java.lang.String
`grpc.channels.*.override-authority`	java.lang.String
`grpc.channels.*.default-load-balancing-policy`	java.lang.String
`grpc.channels.*.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.channels.*.compressor-registry`	io.grpc.CompressorRegistry
`grpc.channels.*.idle-timeout`	java.time.Duration
`grpc.channels.*.max-retry-attempts`	int
`grpc.channels.*.max-hedged-attempts`	int
`grpc.channels.*.retry-buffer-size`	long
`grpc.channels.*.per-rpc-buffer-limit`	long
`grpc.channels.*.disable-retry`	boolean
`grpc.channels.*.enable-retry`	boolean
`grpc.channels.*.set-binary-log`	io.grpc.BinaryLog
`grpc.channels.*.max-trace-events`	int
`grpc.channels.*.proxy-detector`	io.grpc.ProxyDetector
`grpc.channels.*.default-service-config`	java.util.Map
`grpc.channels.*.disable-service-config-look-up`	boolean
`grpc.channels.*.build`	boolean
`grpc.channels.*.to-string`	boolean
`grpc.channels.*.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.channels.*.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.channels.*.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.channels.*.initial-flow-control-window`	int
`grpc.channels.*.flow-control-window`	int
`grpc.channels.*.plaintext`	boolean
`grpc.channels.*.transport-security`	boolean
`grpc.channels.*.keep-alive-time`	java.time.Duration
`grpc.channels.*.keep-alive-timeout`	java.time.Duration
`grpc.channels.*.keep-alive-without-calls`	boolean
`grpc.channels.*.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.channels.*.max-inbound-message-size`	int

Configuration properties for NettyChannelBuilder

Property	Type	Description
`grpc.client.direct-executor`	boolean
`grpc.client.executor`	java.util.concurrent.Executor
`grpc.client.offload-executor`	java.util.concurrent.Executor
`grpc.client.intercept`	java.util.List
`grpc.client.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.client.r-agent`	java.lang.String
`grpc.client.override-authority`	java.lang.String
`grpc.client.default-load-balancing-policy`	java.lang.String
`grpc.client.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.client.compressor-registry`	io.grpc.CompressorRegistry
`grpc.client.idle-timeout`	java.time.Duration
`grpc.client.max-retry-attempts`	int
`grpc.client.max-hedged-attempts`	int
`grpc.client.retry-buffer-size`	long
`grpc.client.per-rpc-buffer-limit`	long
`grpc.client.disable-retry`	boolean
`grpc.client.enable-retry`	boolean
`grpc.client.set-binary-log`	io.grpc.BinaryLog
`grpc.client.max-trace-events`	int
`grpc.client.proxy-detector`	io.grpc.ProxyDetector
`grpc.client.default-service-config`	java.util.Map
`grpc.client.disable-service-config-look-up`	boolean
`grpc.client.build`	boolean
`grpc.client.to-string`	boolean
`grpc.client.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.client.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.client.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.client.initial-flow-control-window`	int
`grpc.client.flow-control-window`	int
`grpc.client.plaintext`	boolean
`grpc.client.transport-security`	boolean
`grpc.client.keep-alive-time`	java.time.Duration
`grpc.client.keep-alive-timeout`	java.time.Duration
`grpc.client.keep-alive-without-calls`	boolean
`grpc.client.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.client.max-inbound-message-size`	int
`grpc.channels.*.direct-executor`	boolean
`grpc.channels.*.executor`	java.util.concurrent.Executor
`grpc.channels.*.offload-executor`	java.util.concurrent.Executor
`grpc.channels.*.intercept`	java.util.List
`grpc.channels.*.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.channels.*.r-agent`	java.lang.String
`grpc.channels.*.override-authority`	java.lang.String
`grpc.channels.*.default-load-balancing-policy`	java.lang.String
`grpc.channels.*.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.channels.*.compressor-registry`	io.grpc.CompressorRegistry
`grpc.channels.*.idle-timeout`	java.time.Duration
`grpc.channels.*.max-retry-attempts`	int
`grpc.channels.*.max-hedged-attempts`	int
`grpc.channels.*.retry-buffer-size`	long
`grpc.channels.*.per-rpc-buffer-limit`	long
`grpc.channels.*.disable-retry`	boolean
`grpc.channels.*.enable-retry`	boolean
`grpc.channels.*.set-binary-log`	io.grpc.BinaryLog
`grpc.channels.*.max-trace-events`	int
`grpc.channels.*.proxy-detector`	io.grpc.ProxyDetector
`grpc.channels.*.default-service-config`	java.util.Map
`grpc.channels.*.disable-service-config-look-up`	boolean
`grpc.channels.*.build`	boolean
`grpc.channels.*.to-string`	boolean
`grpc.channels.*.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.channels.*.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.channels.*.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.channels.*.initial-flow-control-window`	int
`grpc.channels.*.flow-control-window`	int
`grpc.channels.*.plaintext`	boolean
`grpc.channels.*.transport-security`	boolean
`grpc.channels.*.keep-alive-time`	java.time.Duration
`grpc.channels.*.keep-alive-timeout`	java.time.Duration
`grpc.channels.*.keep-alive-without-calls`	boolean
`grpc.channels.*.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.channels.*.max-inbound-message-size`	int

Configuration properties for NettyChannelBuilder

Property	Type	Description
`grpc.client.direct-executor`	boolean
`grpc.client.executor`	java.util.concurrent.Executor
`grpc.client.offload-executor`	java.util.concurrent.Executor
`grpc.client.intercept`	java.util.List
`grpc.client.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.client.r-agent`	java.lang.String
`grpc.client.override-authority`	java.lang.String
`grpc.client.default-load-balancing-policy`	java.lang.String
`grpc.client.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.client.compressor-registry`	io.grpc.CompressorRegistry
`grpc.client.idle-timeout`	java.time.Duration
`grpc.client.max-retry-attempts`	int
`grpc.client.max-hedged-attempts`	int
`grpc.client.retry-buffer-size`	long
`grpc.client.per-rpc-buffer-limit`	long
`grpc.client.disable-retry`	boolean
`grpc.client.enable-retry`	boolean
`grpc.client.set-binary-log`	io.grpc.BinaryLog
`grpc.client.max-trace-events`	int
`grpc.client.proxy-detector`	io.grpc.ProxyDetector
`grpc.client.default-service-config`	java.util.Map
`grpc.client.disable-service-config-look-up`	boolean
`grpc.client.build`	boolean
`grpc.client.to-string`	boolean
`grpc.client.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.client.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.client.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.client.initial-flow-control-window`	int
`grpc.client.flow-control-window`	int
`grpc.client.plaintext`	boolean
`grpc.client.transport-security`	boolean
`grpc.client.keep-alive-time`	java.time.Duration
`grpc.client.keep-alive-timeout`	java.time.Duration
`grpc.client.keep-alive-without-calls`	boolean
`grpc.client.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.client.max-inbound-message-size`	int
`grpc.channels.*.direct-executor`	boolean
`grpc.channels.*.executor`	java.util.concurrent.Executor
`grpc.channels.*.offload-executor`	java.util.concurrent.Executor
`grpc.channels.*.intercept`	java.util.List
`grpc.channels.*.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.channels.*.r-agent`	java.lang.String
`grpc.channels.*.override-authority`	java.lang.String
`grpc.channels.*.default-load-balancing-policy`	java.lang.String
`grpc.channels.*.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.channels.*.compressor-registry`	io.grpc.CompressorRegistry
`grpc.channels.*.idle-timeout`	java.time.Duration
`grpc.channels.*.max-retry-attempts`	int
`grpc.channels.*.max-hedged-attempts`	int
`grpc.channels.*.retry-buffer-size`	long
`grpc.channels.*.per-rpc-buffer-limit`	long
`grpc.channels.*.disable-retry`	boolean
`grpc.channels.*.enable-retry`	boolean
`grpc.channels.*.set-binary-log`	io.grpc.BinaryLog
`grpc.channels.*.max-trace-events`	int
`grpc.channels.*.proxy-detector`	io.grpc.ProxyDetector
`grpc.channels.*.default-service-config`	java.util.Map
`grpc.channels.*.disable-service-config-look-up`	boolean
`grpc.channels.*.build`	boolean
`grpc.channels.*.to-string`	boolean
`grpc.channels.*.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.channels.*.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.channels.*.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.channels.*.initial-flow-control-window`	int
`grpc.channels.*.flow-control-window`	int
`grpc.channels.*.plaintext`	boolean
`grpc.channels.*.transport-security`	boolean
`grpc.channels.*.keep-alive-time`	java.time.Duration
`grpc.channels.*.keep-alive-timeout`	java.time.Duration
`grpc.channels.*.keep-alive-without-calls`	boolean
`grpc.channels.*.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.channels.*.max-inbound-message-size`	int

Configuration properties for NettyChannelBuilder

Property	Type	Description
`grpc.client.direct-executor`	boolean
`grpc.client.executor`	java.util.concurrent.Executor
`grpc.client.offload-executor`	java.util.concurrent.Executor
`grpc.client.intercept`	java.util.List
`grpc.client.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.client.r-agent`	java.lang.String
`grpc.client.override-authority`	java.lang.String
`grpc.client.default-load-balancing-policy`	java.lang.String
`grpc.client.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.client.compressor-registry`	io.grpc.CompressorRegistry
`grpc.client.idle-timeout`	java.time.Duration
`grpc.client.max-retry-attempts`	int
`grpc.client.max-hedged-attempts`	int
`grpc.client.retry-buffer-size`	long
`grpc.client.per-rpc-buffer-limit`	long
`grpc.client.disable-retry`	boolean
`grpc.client.enable-retry`	boolean
`grpc.client.set-binary-log`	io.grpc.BinaryLog
`grpc.client.max-trace-events`	int
`grpc.client.proxy-detector`	io.grpc.ProxyDetector
`grpc.client.default-service-config`	java.util.Map
`grpc.client.disable-service-config-look-up`	boolean
`grpc.client.build`	boolean
`grpc.client.to-string`	boolean
`grpc.client.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.client.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.client.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.client.initial-flow-control-window`	int
`grpc.client.flow-control-window`	int
`grpc.client.plaintext`	boolean
`grpc.client.transport-security`	boolean
`grpc.client.keep-alive-time`	java.time.Duration
`grpc.client.keep-alive-timeout`	java.time.Duration
`grpc.client.keep-alive-without-calls`	boolean
`grpc.client.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.client.max-inbound-message-size`	int
`grpc.channels.*.direct-executor`	boolean
`grpc.channels.*.executor`	java.util.concurrent.Executor
`grpc.channels.*.offload-executor`	java.util.concurrent.Executor
`grpc.channels.*.intercept`	java.util.List
`grpc.channels.*.add-transport-filter`	io.grpc.ClientTransportFilter
`grpc.channels.*.r-agent`	java.lang.String
`grpc.channels.*.override-authority`	java.lang.String
`grpc.channels.*.default-load-balancing-policy`	java.lang.String
`grpc.channels.*.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.channels.*.compressor-registry`	io.grpc.CompressorRegistry
`grpc.channels.*.idle-timeout`	java.time.Duration
`grpc.channels.*.max-retry-attempts`	int
`grpc.channels.*.max-hedged-attempts`	int
`grpc.channels.*.retry-buffer-size`	long
`grpc.channels.*.per-rpc-buffer-limit`	long
`grpc.channels.*.disable-retry`	boolean
`grpc.channels.*.enable-retry`	boolean
`grpc.channels.*.set-binary-log`	io.grpc.BinaryLog
`grpc.channels.*.max-trace-events`	int
`grpc.channels.*.proxy-detector`	io.grpc.ProxyDetector
`grpc.channels.*.default-service-config`	java.util.Map
`grpc.channels.*.disable-service-config-look-up`	boolean
`grpc.channels.*.build`	boolean
`grpc.channels.*.to-string`	boolean
`grpc.channels.*.negotiation-type`	io.grpc.netty.NegotiationType
`grpc.channels.*.event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.channels.*.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.channels.*.initial-flow-control-window`	int
`grpc.channels.*.flow-control-window`	int
`grpc.channels.*.plaintext`	boolean
`grpc.channels.*.transport-security`	boolean
`grpc.channels.*.keep-alive-time`	java.time.Duration
`grpc.channels.*.keep-alive-timeout`	java.time.Duration
`grpc.channels.*.keep-alive-without-calls`	boolean
`grpc.channels.*.local-socket-picker`	io.grpc.netty.NettyChannelBuilder$LocalSocketPicker
`grpc.channels.*.max-inbound-message-size`	int

Micronaut Grpc Inprocess Config Properties

Configuration properties for GrpcInProcessServerConfiguration

Property	Type	Description
`grpc.server.in-process-name`	java.lang.String	Sets the in-process server name for test transports.

Micronaut Grpc Opentracing Config Properties

Configuration properties for TracingClientInterceptor$Builder

Property	Type	Description
`grpc.client.tracing.tracer`	io.opentracing.Tracer
`grpc.client.tracing.operation-name`	io.opentracing.contrib.grpc.OperationNameConstructor
`grpc.client.tracing.streaming`	boolean
`grpc.client.tracing.traced-attributes`	io.opentracing.contrib.grpc.TracingClientInterceptor$ClientRequestAttribute
`grpc.client.tracing.verbosity`	boolean
`grpc.client.tracing.active-span-source`	io.opentracing.contrib.grpc.ActiveSpanSource
`grpc.client.tracing.active-span-context-source`	io.opentracing.contrib.grpc.ActiveSpanContextSource
`grpc.client.tracing.client-span-decorator`	io.opentracing.contrib.grpc.ClientSpanDecorator
`grpc.client.tracing.client-close-decorator`	io.opentracing.contrib.grpc.ClientCloseDecorator

Configuration properties for TracingClientInterceptor$Builder

Property	Type	Description
`grpc.client.tracing.tracer`	io.opentracing.Tracer
`grpc.client.tracing.operation-name`	io.opentracing.contrib.grpc.OperationNameConstructor
`grpc.client.tracing.streaming`	boolean
`grpc.client.tracing.traced-attributes`	io.opentracing.contrib.grpc.TracingClientInterceptor$ClientRequestAttribute
`grpc.client.tracing.verbosity`	boolean
`grpc.client.tracing.active-span-source`	io.opentracing.contrib.grpc.ActiveSpanSource
`grpc.client.tracing.active-span-context-source`	io.opentracing.contrib.grpc.ActiveSpanContextSource
`grpc.client.tracing.client-span-decorator`	io.opentracing.contrib.grpc.ClientSpanDecorator
`grpc.client.tracing.client-close-decorator`	io.opentracing.contrib.grpc.ClientCloseDecorator

Configuration properties for TracingServerInterceptor$Builder

Property	Type	Description
`grpc.server.tracing.tracer`	io.opentracing.Tracer
`grpc.server.tracing.operation-name`	io.opentracing.contrib.grpc.OperationNameConstructor
`grpc.server.tracing.traced-attributes`	io.opentracing.contrib.grpc.TracingServerInterceptor$ServerRequestAttribute
`grpc.server.tracing.streaming`	boolean
`grpc.server.tracing.verbosity`	boolean
`grpc.server.tracing.server-span-decorator`	io.opentracing.contrib.grpc.ServerSpanDecorator
`grpc.server.tracing.server-close-decorator`	io.opentracing.contrib.grpc.ServerCloseDecorator

Configuration properties for TracingServerInterceptor$Builder

Property	Type	Description
`grpc.server.tracing.tracer`	io.opentracing.Tracer
`grpc.server.tracing.operation-name`	io.opentracing.contrib.grpc.OperationNameConstructor
`grpc.server.tracing.traced-attributes`	io.opentracing.contrib.grpc.TracingServerInterceptor$ServerRequestAttribute
`grpc.server.tracing.streaming`	boolean
`grpc.server.tracing.verbosity`	boolean
`grpc.server.tracing.server-span-decorator`	io.opentracing.contrib.grpc.ServerSpanDecorator
`grpc.server.tracing.server-close-decorator`	io.opentracing.contrib.grpc.ServerCloseDecorator

Micronaut Grpc Server Runtime Config Properties

Configuration properties for GrpcServerConfiguration

Property	Type	Description
`grpc.server.executor`	java.lang.String	Sets the executor bean name.
`grpc.server.instance-id`	java.lang.String	Sets the instance id name used for registering the GRPC service in Service Discovery. If this is not set, the application name will be used.
`grpc.server.await-termination`	java.time.Duration	Sets the maximum duration application will wait for the server to terminate and release all resources.

Configuration properties for ServerBuilder

Property	Type	Description
`grpc.server.call-executor`	io.grpc.ServerCallExecutorSupplier
`grpc.server.add-service`	io.grpc.ServerServiceDefinition
`grpc.server.add-services`	java.util.List
`grpc.server.intercept`	io.grpc.ServerInterceptor
`grpc.server.add-transport-filter`	io.grpc.ServerTransportFilter
`grpc.server.add-stream-tracer-factory`	io.grpc.ServerStreamTracer$Factory
`grpc.server.fallback-handler-registry`	io.grpc.HandlerRegistry
`grpc.server.decompressor-registry`	io.grpc.DecompressorRegistry
`grpc.server.compressor-registry`	io.grpc.CompressorRegistry
`grpc.server.handshake-timeout`	java.time.Duration
`grpc.server.keep-alive-time`	java.time.Duration
`grpc.server.keep-alive-timeout`	java.time.Duration
`grpc.server.max-connection-idle`	java.time.Duration
`grpc.server.max-connection-age`	java.time.Duration
`grpc.server.max-connection-age-grace`	java.time.Duration
`grpc.server.permit-keep-alive-time`	java.time.Duration
`grpc.server.permit-keep-alive-without-calls`	boolean
`grpc.server.max-inbound-message-size`	int
`grpc.server.max-inbound-metadata-size`	int
`grpc.server.set-binary-log`	io.grpc.BinaryLog
`grpc.server.add-metric-sink`	io.grpc.MetricSink

Configuration properties for NettyServerBuilder

Property	Type	Description
`grpc.server.add-listen-address`	java.net.SocketAddress
`grpc.server.channel-type`	java.lang.Class
`grpc.server.channel-factory`	io.netty.channel.ChannelFactory
`grpc.server.boss-event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.server.worker-event-loop-group`	io.netty.channel.EventLoopGroup
`grpc.server.ssl-context`	io.netty.handler.ssl.SslContext
`grpc.server.max-concurrent-calls-per-connection`	int
`grpc.server.initial-flow-control-window`	int
`grpc.server.flow-control-window`	int

Configuration properties for GrpcSslConfiguration

Property	Type	Description
`grpc.server.ssl.cert-chain`	java.lang.String	The cert chain
`grpc.server.ssl.private-key`	java.lang.String	The private key

Micronaut Protobuff Json Support Config Properties

Configuration properties for GrpcJsonConfiguration

Property	Type	Description
`micronaut.grpc.json.max-response-messages`	int	Sets the maximum number of messages collected from a streaming response.
`micronaut.grpc.json.max-response-bytes`	long	Sets the maximum estimated serialized response size in bytes.