Skip to content

Commit ebcd73e

Browse files
ST-DDTmarcingrzejszczak
authored andcommitted
Also mention the net.devh:grpc-spring-boot-starter library (#1213)
* Also mention net.devh:grpc-spring-boot-starter * No documentation, only links
1 parent f4e659a commit ebcd73e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/src/main/asciidoc/spring-cloud-sleuth.adoc

+8-3
Original file line numberDiff line numberDiff line change
@@ -1223,7 +1223,9 @@ However, all the default instrumentation is still there.
12231223

12241224
Spring Cloud Sleuth provides instrumentation for https://grpc.io/[gRPC] through `TraceGrpcAutoConfiguration`. You can disable it entirely by setting `spring.sleuth.grpc.enabled` to `false`.
12251225

1226-
==== Dependencies
1226+
==== Variant 1
1227+
1228+
===== Dependencies
12271229
IMPORTANT: The gRPC integration relies on two external libraries to instrument clients and servers and both of those libraries must be on the class path to enable the instrumentation.
12281230

12291231
Maven:
@@ -1243,11 +1245,11 @@ Gradle:
12431245
compile("io.zipkin.brave:brave-instrumentation-grpc")
12441246
```
12451247

1246-
==== Server Instrumentation
1248+
===== Server Instrumentation
12471249

12481250
Spring Cloud Sleuth leverages grpc-spring-boot-starter to register Brave's gRPC server interceptor with all services annotated with `@GRpcService`.
12491251

1250-
==== Client Instrumentation
1252+
===== Client Instrumentation
12511253

12521254
gRPC clients leverage a `ManagedChannelBuilder` to construct a `ManagedChannel` used to communicate to the gRPC server. The native `ManagedChannelBuilder` provides static methods as entry points for construction of `ManagedChannel` instances, however, this mechanism is outside the influence of the Spring application context.
12531255

@@ -1256,6 +1258,9 @@ IMPORTANT: Spring Cloud Sleuth provides a `SpringAwareManagedChannelBuilder` tha
12561258

12571259
Sleuth creates a `TracingManagedChannelBuilderCustomizer` which inject Brave's client interceptor into the `SpringAwareManagedChannelBuilder`.
12581260

1261+
==== Variant 2
1262+
1263+
https://github.com/yidongnan/grpc-spring-boot-starter[Grpc Spring Boot Starter] automatically detects the presence of Spring Cloud Sleuth and brave's instrumentation for gRPC and registers the necessary client and/or server tooling.
12591264

12601265
=== Asynchronous Communication
12611266

0 commit comments

Comments
 (0)