Get Tracer operation should use an empty string if the specified name is null
#1654
Conversation
carlosalberto
changed the title
name is null
| @@ -110,7 +110,7 @@ This API MUST accept the following parameters: | |||
| or application. | |||
| In case an invalid name (null or empty string) is specified, a working | |||
| Tracer implementation MUST be returned as a fallback rather than returning | |||
| null or throwing an exception, its `name` property SHOULD keep the original invalid value, | |||
| null or throwing an exception, its `name` property SHOULD be set to an **empty** string, | |||
There was a problem hiding this comment.
Should TracerProvider::GetTracer(null) and TracerProvider::GetTracer("") return the same Tracer with "" as name?
There was a problem hiding this comment.
Identity of the returned tracer is not relevant to the spec, as the only per-tracer state is the (immutable) Instrumentation Library name and version.
There was a problem hiding this comment.
Thanks. I am still a little bit unclear about "its name property SHOULD be set to an empty string." Does it mean the name property of the tracer should be set to empty string even if null is passed to GetTracer, but keep the name stored in Instrumentation Library as null which is the original value passed to GetTracer?
There was a problem hiding this comment.
Probably we need a further clarification, but the idea is that Get Tracer (null) essentially becomes a call to Get Tracer ("") (with name exactly being from this point "", which will be used also in the stored instrumentation).
There was a problem hiding this comment.
Get Tracer(null) becomes a call to Get Tracer("") is very clear to me. I think further clarification will be helpful to guide implementations.
Co-authored-by: John Watson <jkwatson@gmail.com>
Fixes #1619 - as discussed previously in a previous SIG call.
The
Get Traceroperation, upon receiving an invalid value, should set thenameto an empty string, instead of allowing null values to pass through.