Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define the fallback tracer name for invalid values. #1534

Merged
6 changes: 4 additions & 2 deletions specification/trace/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,10 @@ This API MUST accept the following parameters:
In that scenario, the `name` denotes a module name or component name within that library
or application.
In case an invalid name (null or empty string) is specified, a working
default Tracer implementation as a fallback is returned rather than returning
null or throwing an exception.
default Tracer implementation MUST be returned as a fallback rather than returning
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
null or throwing an exception, and `name` SHOULD be the set to the
"`<INVALID INSTRUMENTATION NAME PROVIDED>`" literal, in order to signal that the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"`<INVALID INSTRUMENTATION NAME PROVIDED>`" literal, in order to signal that the
string `<INVALID INSTRUMENTATION NAME PROVIDED>`, in order to signal that the

specified value is invalid.
A library, implementing the OpenTelemetry API *may* also ignore this name and
return a default instance for all calls, if it does not support "named"
functionality (e.g. an implementation which is not even observability-related).
Expand Down