Skip to content
This repository was archived by the owner on Dec 23, 2023. It is now read-only.

Commit 09d77ed

Browse files
authored
Exporter/OcAgent: Add a note about netty-tcnative-boringssl dependency. (#1898)
* Exporter/OcAgent: Add a note about netty-tcnative-boringssl dependency. * Add an FAQ. Update version in examples.
1 parent 8312f0e commit 09d77ed

3 files changed

Lines changed: 32 additions & 1 deletion

File tree

examples/build.gradle

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ def opencensusVersion = "0.22.0" // LATEST_OPENCENSUS_RELEASE_VERSION
3737
def grpcVersion = "1.19.0" // CURRENT_GRPC_VERSION
3838
def prometheusVersion = "0.6.0"
3939
def jettyVersion = "9.4.17.v20190418"
40+
def tcnativeVersion = "2.0.20.Final"
4041

4142
tasks.withType(JavaCompile) {
4243
sourceCompatibility = '1.8'
@@ -69,7 +70,7 @@ dependencies {
6970
"org.slf4j:slf4j-log4j12:1.7.25"
7071

7172
runtime "io.opencensus:opencensus-impl:${opencensusVersion}",
72-
"io.netty:netty-tcnative-boringssl-static:2.0.8.Final"
73+
"io.netty:netty-tcnative-boringssl-static:${tcnativeVersion}"
7374
}
7475

7576
googleJavaFormat {

exporters/metrics/ocagent/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ For Maven add to your `pom.xml`:
2626
<version>0.22.0</version>
2727
<scope>runtime</scope>
2828
</dependency>
29+
<dependency>
30+
<groupId>io.netty</groupId>
31+
<artifactId>netty-tcnative-boringssl-static</artifactId>
32+
<version>2.0.20.Final</version>
33+
<scope>runtime</scope>
34+
</dependency>
2935
</dependencies>
3036
```
3137

@@ -34,6 +40,7 @@ For Gradle add to your dependencies:
3440
compile 'io.opencensus:opencensus-api:0.22.0'
3541
compile 'io.opencensus:opencensus-exporter-metrics-ocagent:0.22.0'
3642
runtime 'io.opencensus:opencensus-impl:0.22.0'
43+
runtime 'io.netty:netty-tcnative-boringssl-static:2.0.20.Final'
3744
```
3845

3946
### Register the exporter
@@ -48,3 +55,11 @@ public class MyMainClass {
4855
}
4956
}
5057
```
58+
59+
## FAQ
60+
61+
### Why is `netty-tcnative-boringssl-static` needed? Which version should I use?
62+
63+
It's because this artifact depends on `grpc-netty` which requires a runtime dependency on `netty-tcnative-boringssl-static`
64+
for it to work. For more details and a table of known working version combinations, see
65+
https://github.com/grpc/grpc-java/blob/master/SECURITY.md#netty.

exporters/trace/ocagent/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ For Maven add to your `pom.xml`:
2626
<version>0.22.0</version>
2727
<scope>runtime</scope>
2828
</dependency>
29+
<dependency>
30+
<groupId>io.netty</groupId>
31+
<artifactId>netty-tcnative-boringssl-static</artifactId>
32+
<version>2.0.20.Final</version>
33+
<scope>runtime</scope>
34+
</dependency>
2935
</dependencies>
3036
```
3137

@@ -34,6 +40,7 @@ For Gradle add to your dependencies:
3440
compile 'io.opencensus:opencensus-api:0.22.0'
3541
compile 'io.opencensus:opencensus-exporter-trace-ocagent:0.22.0'
3642
runtime 'io.opencensus:opencensus-impl:0.22.0'
43+
runtime 'io.netty:netty-tcnative-boringssl-static:2.0.20.Final'
3744
```
3845

3946
### Register the exporter
@@ -46,3 +53,11 @@ public class MyMainClass {
4653
}
4754
}
4855
```
56+
57+
## FAQ
58+
59+
### Why is `netty-tcnative-boringssl-static` needed? Which version should I use?
60+
61+
It's because this artifact depends on `grpc-netty` which requires a runtime dependency on `netty-tcnative-boringssl-static`
62+
for it to work. For more details and a table of known working version combinations, see
63+
https://github.com/grpc/grpc-java/blob/master/SECURITY.md#netty.

0 commit comments

Comments
 (0)