From e7cc57d911bb34dcbaf218b8eacb0e5f58a053cd Mon Sep 17 00:00:00 2001 From: John Watson Date: Mon, 22 Mar 2021 19:40:53 -0700 Subject: [PATCH] Add a note to the TracerProvider javadoc about instrumentation name. (#3050) --- .../java/io/opentelemetry/api/trace/TracerProvider.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/api/all/src/main/java/io/opentelemetry/api/trace/TracerProvider.java b/api/all/src/main/java/io/opentelemetry/api/trace/TracerProvider.java index f30ed5245d..a47f9462ac 100644 --- a/api/all/src/main/java/io/opentelemetry/api/trace/TracerProvider.java +++ b/api/all/src/main/java/io/opentelemetry/api/trace/TracerProvider.java @@ -28,7 +28,9 @@ public interface TracerProvider { * Gets or creates a named tracer instance. * * @param instrumentationName The name of the instrumentation library, not the name of the - * instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null. + * instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null. If the + * instrumented library is providing its own instrumentation, this should match the library + * name. * @return a tracer instance. */ Tracer get(String instrumentationName); @@ -37,7 +39,9 @@ public interface TracerProvider { * Gets or creates a named and versioned tracer instance. * * @param instrumentationName The name of the instrumentation library, not the name of the - * instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null. + * instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null. If the + * instrumented library is providing its own instrumentation, this should match the library + * name. * @param instrumentationVersion The version of the instrumentation library (e.g., "1.0.0"). * @return a tracer instance. */