Skip to content

Commit 7b74928

Browse files
committed
docs: instructions for using OpenTelemetry tracing
Signed-off-by: chenhuan <[email protected]>
1 parent 450fce8 commit 7b74928

File tree

2 files changed

+66
-1
lines changed

2 files changed

+66
-1
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,38 @@ public class Main {
112112
}
113113
```
114114

115+
### Tracing with OpenTelemetry
116+
117+
To enable distributed tracing with OpenTelemetry in opengemini-client-java:
118+
119+
1.Add dependencies:
120+
121+
```xml
122+
<dependency>
123+
<groupId>io.opentelemetry</groupId>
124+
<artifactId>opentelemetry-api</artifactId>
125+
<version>${opentelemetry.version}</version>
126+
</dependency>
127+
<dependency>
128+
<groupId>io.opentelemetry</groupId>
129+
<artifactId>opentelemetry-exporter-jaeger-grpc</artifactId>
130+
<version>${opentelemetry.version}</version>
131+
</dependency>
132+
```
133+
134+
2.Configure tracer and register interceptor:
135+
136+
```java
137+
/// Configure Tracer
138+
JaegerGrpcSpanExporter exporter = JaegerGrpcSpanExporter.builder().setEndpoint("http://localhost:14250").build();
139+
SdkTracerProvider tracerProvider = SdkTracerProvider.builder().addSpanProcessor(BatchSpanProcessor.builder(exporter).build()).build();
140+
OpenTelemetry openTelemetry = OpenTelemetrySdk.builder().setTracerProvider(tracerProvider).build();
141+
Tracer tracer = openTelemetry.getTracer("opengemini-client-java");
142+
143+
// Register Interceptor
144+
OtelInterceptor otelInterceptor = new OtelInterceptor();
145+
```
146+
115147
## Contribution
116148

117149
Welcome to [join us](CONTRIBUTION.md)

README_CN.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,39 @@ public class Main {
111111
}
112112
}
113113
```
114+
115+
### 使用OpenTelemetry进行链路追踪
116+
117+
在opengemini-client-java中启用OpenTelemetry分布式追踪:
118+
119+
1.添加依赖(确保版本兼容):
120+
121+
```xml
122+
<dependency>
123+
<groupId>io.opentelemetry</groupId>
124+
<artifactId>opentelemetry-api</artifactId>
125+
<version>${opentelemetry.version}</version>
126+
</dependency>
127+
<dependency>
128+
<groupId>io.opentelemetry</groupId>
129+
<artifactId>opentelemetry-exporter-jaeger-grpc</artifactId>
130+
<version>${opentelemetry.version}</version>
131+
</dependency>
132+
```
133+
134+
2.配置追踪器并注册拦截器:
135+
136+
```java
137+
// Configure Tracer
138+
JaegerGrpcSpanExporter exporter = JaegerGrpcSpanExporter.builder().setEndpoint("http://localhost:14250").build();
139+
SdkTracerProvider tracerProvider = SdkTracerProvider.builder().addSpanProcessor(BatchSpanProcessor.builder(exporter).build()).build();
140+
OpenTelemetry openTelemetry = OpenTelemetrySdk.builder().setTracerProvider(tracerProvider).build();
141+
Tracer tracer = openTelemetry.getTracer("opengemini-client-java");
142+
143+
// Register Interceptor
144+
OtelInterceptor otelInterceptor = new OtelInterceptor();
145+
```
146+
114147
## 贡献
115148

116-
欢迎[加入我们](CONTRIBUTION_CN.md)
149+
欢迎[加入我们](CONTRIBUTION_CN.md)

0 commit comments

Comments
 (0)