open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc code snippets use methods that don't exist (#4140) 

* Replace OpenTelemetry with GlobalOpenTelemetry in javadoc code snippets

* use openTelemetry instread of GlobalOpenTelemetry

* replace one ome usage of GlobalOpenTelemetry
This commit is contained in:
Lauri Tulmin 2022-02-02 22:20:36 +02:00 committed by GitHub
parent a047632ad7
commit 9c6cc22fb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
api/all/src/main/java/io/opentelemetry/api/trace/SpanBuilder.java
View File

@ -23,9 +23,13 @@ import java.util.concurrent.TimeUnit;
*
* <pre>{@code
* class MyClass {
* private static final Tracer tracer = OpenTelemetry.get().getTracer("com.anyco.rpc");
* private final Tracer tracer;
*
* void doWork {
* MyClass(OpenTelemetry openTelemetry) {
* tracer = openTelemetry.getTracer("com.anyco.rpc");
* }
*
* void doWork() {
* // Create a Span as a child of the current Span.
* Span span = tracer.spanBuilder("MyChildSpan").startSpan();
* try (Scope ss = span.makeCurrent()) {
@ -44,10 +48,12 @@ import java.util.concurrent.TimeUnit;
*
* <pre>{@code
* class MyRpcServerInterceptorListener implements RpcServerInterceptor.Listener {
* private static final Tracer tracer = OpenTelemetry.get().getTracer("com.example.rpc");
* private final Tracer tracer;
* private Span mySpan;
*
* public MyRpcInterceptor() {}
* public MyRpcInterceptor(OpenTelemetry openTelemetry) {
* tracer = openTelemetry.getTracer("com.example.rpc");
* }
*
* public void onRequest(String rpcName, Metadata metadata) {
* // Create a Span as a child of the remote Span.
@ -84,7 +90,11 @@ import java.util.concurrent.TimeUnit;
*
* <pre>{@code
* class MyClass {
* private static final Tracer tracer = OpenTelemetry.get().getTracer("com.example.rpc");
* private final Tracer tracer;
*
* MyClass(OpenTelemetry openTelemetry) {
* tracer = openTelemetry.getTracer("com.example.rpc");
* }
*
* void doWork(Span parent) {
* Span childSpan = tracer.spanBuilder("MyChildSpan")
@ -305,7 +315,11 @@ public interface SpanBuilder {
*
* <pre>{@code
* class MyClass {
* private static final Tracer tracer = OpenTelemetry.get().getTracer("com.example.rpc");
* private final Tracer tracer;
*
* MyClass(OpenTelemetry openTelemetry) {
* tracer = openTelemetry.getTracer("com.example.rpc");
* }
*
* void doWork(Span parent) {
* Span childSpan = tracer.spanBuilder("MyChildSpan")

7
context/src/main/java/io/opentelemetry/context/propagation/ContextPropagators.java
View File

@ -22,10 +22,9 @@ import javax.annotation.concurrent.ThreadSafe;
* <p>Example of usage on the client:
*
* <pre>{@code
* private static final Tracer tracer = OpenTelemetry.getTracer();
* void onSendRequest() {
* try (Scope ignored = span.makeCurrent()) {
* ContextPropagators propagators = OpenTelemetry.getPropagators();
* ContextPropagators propagators = openTelemetry.getPropagators();
* TextMapPropagator textMapPropagator = propagators.getTextMapPropagator();
*
* // Inject the span's SpanContext and other available concerns (such as correlations)
@ -44,9 +43,9 @@ import javax.annotation.concurrent.ThreadSafe;
* <p>Example of usage in the server:
*
* <pre>{@code
* private static final Tracer tracer = OpenTelemetry.getTracer();
* private final Tracer tracer = openTelemetry.getTracer("com.example");
* void onRequestReceived() {
* ContextPropagators propagators = OpenTelemetry.getPropagators();
* ContextPropagators propagators = openTelemetry.getPropagators();
* TextMapPropagator textMapPropagator = propagators.getTextMapPropagator();
*
* // Extract and store the propagated span's SpanContext and other available concerns

4
sdk/all/src/main/java/io/opentelemetry/sdk/OpenTelemetrySdk.java
View File

@ -85,7 +85,7 @@ public final class OpenTelemetrySdk implements OpenTelemetry {
*
* <p>Static global providers are obfuscated when they are returned from the API to prevent users
* from casting them to their SDK specific implementation. For example, we do not want users to
* use patterns like {@code (SdkTracerProvider) OpenTelemetry.getGlobalTracerProvider()}.
* use patterns like {@code (SdkTracerProvider) openTelemetry.getTracerProvider()}.
*/
@ThreadSafe
// Visible for testing
@ -122,7 +122,7 @@ public final class OpenTelemetrySdk implements OpenTelemetry {
*
* <p>Static global providers are obfuscated when they are returned from the API to prevent users
* from casting them to their SDK specific implementation. For example, we do not want users to
* use patterns like {@code (SdkMeterProvider) GlobalOpenTelemetry.get().getMeterProvider()}.
* use patterns like {@code (SdkMeterProvider) openTelemetry.getMeterProvider()}.
*/
@ThreadSafe
// Visible for testing