Skip to content

Commit

Permalink
OpenTracing Shim: Add Tracer.Close() operation. (open-telemetry#3048)
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosalberto authored Jan 13, 2023
1 parent 417ec1f commit f4bf378
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ release.

### Compatibility

- Add Tracer.Close() to the OpenTracing Shim layer.

### OpenTelemetry Protocol

- Add table for OTLP/HTTP response code and client retry recommendation
Expand Down
15 changes: 15 additions & 0 deletions specification/compatibility/opentracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* [Start a new Span](#start-a-new-span)
* [Inject](#inject)
* [Extract](#extract)
* [Close](#close)
* [Span Shim and SpanContext Shim relationship](#span-shim-and-spancontext-shim-relationship)
* [Span Shim](#span-shim)
* [Get Context](#get-context)
Expand Down Expand Up @@ -205,6 +206,20 @@ Errors MAY be raised if either the `Format` is not recognized
or no value could be extracted, depending on the specific OpenTracing Language API
(e.g. Go and Python do, but Java may not).

## Close

OPTIONAL operation. If this operation is implemented for a specific OpenTracing language,
it MUST close the underlying `TracerProvider` if it implements a "closeable" interface or method;
otherwise it MUST be defined as a no-op operation.

The Shim layer MUST protect against errors or exceptions raised while closing the
underlying `TracerProvider`.

Note: Users are advised against calling this operation more than once per `TracerProvider`
as it may have unexpected side effects, limitations or race conditions, e.g.
a single Shim `Tracer` being closed multiple times or multiple Shim `Tracer`
having their close operation being called.

## Span Shim and SpanContext Shim relationship

As per the OpenTracing Specification, the OpenTracing `SpanContext` Shim
Expand Down

0 comments on commit f4bf378

Please sign in to comment.