Skip to content

Also mention the net.devh:grpc-spring-boot-starter library #1213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 19, 2019
Merged

Also mention the net.devh:grpc-spring-boot-starter library #1213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc06931
Also mention net.devh:grpc-spring-boot-starter
ST-DDT Feb 16, 2019
5e287f9
No documentation, only links
ST-DDT Feb 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/src/main/asciidoc/spring-cloud-sleuth.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1223,7 +1223,9 @@ However, all the default instrumentation is still there.

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`.

==== Dependencies
==== Variant 1

===== Dependencies
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.

Maven:
Expand All @@ -1243,11 +1245,11 @@ Gradle:
compile("io.zipkin.brave:brave-instrumentation-grpc")
```

==== Server Instrumentation
===== Server Instrumentation

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

==== Client Instrumentation
===== Client Instrumentation

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.

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

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

==== Variant 2

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.

=== Asynchronous Communication

Expand Down