Skip to content

Commit

Permalink
Replace "method" with "function" in api-tracing spec (open-telemetry#452
Browse files Browse the repository at this point in the history
)
  • Loading branch information
tsloughter authored and Sergey Kanzhelev committed Feb 18, 2020
1 parent 90f93ad commit 6344637
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions specification/api-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@ The OpenTelemetry library achieves in-process context propagation of `Span`s by
way of the `Tracer`.

The `Tracer` is responsible for tracking the currently active `Span`, and
exposes methods for creating and activating new `Span`s. The `Tracer` is
exposes functions for creating and activating new `Span`s. The `Tracer` is
configured with `Propagator`s which support transferring span context across
process boundaries.

### Obtaining a Tracer

New `Tracer` instances can be created via a `TracerFactory` and its `getTracer`
method. This method expects two string arguments:
function. This function expects two string arguments:

`TracerFactory`s are generally expected to be used as singletons. Implementations
SHOULD provide a single global default `TracerFactory`.
Expand Down Expand Up @@ -120,7 +120,7 @@ mechanism, for instance the `ServiceLoader` class in Java.

### Tracer operations

The `Tracer` MUST provide methods to:
The `Tracer` MUST provide functions to:

- Get the currently active `Span`
- Create a new `Span`
Expand All @@ -140,7 +140,7 @@ explicit parent is provided or the option to create a span without a parent is
selected, or the current active `Span` is invalid.

The `Tracer` MUST provide a way to update its active `Span`, and MAY provide
convenience methods to manage a `Span`'s lifetime and the scope in which a
convenience functions to manage a `Span`'s lifetime and the scope in which a
`Span` is active. When an active `Span` is made inactive, the previously-active
`Span` SHOULD be made active. A `Span` maybe finished (i.e. have a non-null end
time) but stil active. A `Span` may be active on one thread after it has been
Expand Down Expand Up @@ -331,7 +331,7 @@ Links SHOULD preserve the order in which they're set.

### Span operations

With the exception of the method to retrieve the `Span`'s `SpanContext` and
With the exception of the function to retrieve the `Span`'s `SpanContext` and
recording status, none of the below may be called after the `Span` is finished.

#### Get Context
Expand Down Expand Up @@ -446,10 +446,10 @@ It is highly discouraged to update the name of a `Span` after its creation.
spans. And often, filtering logic will be implemented before the `Span` creation
for performance reasons. Thus the name update may interfere with this logic.

The method name is called `UpdateName` to differentiate this method from the
regular property setter. It emphasizes that this operation signifies a
major change for a `Span` and may lead to re-calculation of sampling or
filtering decisions made previously depending on the implementation.
The function name is called `UpdateName` to differentiate this function from the
regular property setter. It emphasizes that this operation signifies a major
change for a `Span` and may lead to re-calculation of sampling or filtering
decisions made previously depending on the implementation.

Alternatives for the name update may be late `Span` creation, when Span is
started with the explicit timestamp from the past at the moment where the final
Expand Down

0 comments on commit 6344637

Please sign in to comment.