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

Add a note to the TracerProvider javadoc about instrumentation name. (#3050)

This commit is contained in:
John Watson 2021-03-22 19:40:53 -07:00 committed by GitHub
parent fd397bd78e
commit e7cc57d911
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/all/src/main/java/io/opentelemetry/api/trace/TracerProvider.java
View File

@ -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.
*/