Skip to content

Commit

Permalink
Add docs for gRPC library instrumentation (open-telemetry#6981)
Browse files Browse the repository at this point in the history
  • Loading branch information
aaron-ai authored and LironKS committed Oct 31, 2022
1 parent b926c68 commit 5ccaac9
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions instrumentation/grpc-1.6/library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Library Instrumentation for gRPC 1.6.0+

Provides OpenTelemetry instrumentation for [gRPC](https://grpc.io/).

## Quickstart

### Add the following dependencies to your project:

Replace `OPENTELEMETRY_VERSION` with the [latest release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-grpc-1.6).

For Maven, add the following to your `pom.xml` dependencies:

```xml
<dependencies>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-grpc-1.6</artifactId>
<version>OPENTELEMETRY_VERSION</version>
</dependency>
</dependencies>
```

For Gradle, add the following to your dependencies:

```groovy
implementation("io.opentelemetry.instrumentation:opentelemetry-grpc-1.6:OPENTELEMETRY_VERSION")
```

### Usage

The instrumentation library provides the implementation of `ClientInterceptor` and `ServerInterceptor` to provide OpenTelemetry-based spans and context propagation.

```java
// For client-side, attach the interceptor to your channel builder.
void configureClientInterceptor(Opentelemetry opentelemetry, NettyChannelBuilder nettyChannelBuilder) {
GrpcTelemetry grpcTelemetry = GrpcTelemetry.create(opentelemetry);
nettyChannelBuilder.intercept(grpcTelemetry.newClientInterceptor());
}

// For server-side, attatch the interceptor to your service.
ServerServiceDefinition configureServerInterceptor(Opentelemetry opentelemetry, ServerServiceDefinition serviceDefinition) {
GrpcTelemetry grpcTelemetry = GrpcTelemetry.create(opentelemetry);
return ServiceInterceptors.intercept(serviceDefinition, grpcTelemetry.newServerInterceptor());
}
```

0 comments on commit 5ccaac9

Please sign in to comment.