Skip to content

Commit

Permalink
rename factory to provider and clarify namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
dyladan committed Feb 12, 2020
1 parent 4470532 commit beba442
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 21 deletions.
23 changes: 12 additions & 11 deletions specification/api-metrics-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,20 @@ TODO: Add a table of contents.
## Overview

Metric instruments are the entry point for application and framework developers to instrument their code using counters, gauges, and measures.
Metrics are created by calling methods on a `Meter` which is in turn created by a global `MeterFactory`.
Metrics are created by calling methods on a `Meter` which is in turn created by a global `MeterProvider`.

### Obtaining a Meter

New `Meter` instances can be created via a `MeterFactory` and its `getMeter` method.
`MeterFactory`s are generally expected to be used as singletons.
Implementations SHOULD provide a single global default `MeterFactory`. The `getMeter` method expects two string arguments:
New `Meter` instances can be created via a `MeterProvider` and its `getMeter` method.
`MeterProvider`s are generally expected to be used as singletons.
Implementations SHOULD provide a single global default `MeterProvider`. The `getMeter` method expects two string arguments:

- `name` (required): This name must identify the instrumentation library (also referred to as integration, e.g. `io.opentelemetry.contrib.mongodb`)
and *not* the instrumented library.
In case an invalid name (null or empty string) is specified, a working default `Meter` implementation as a fallback is returned
In case an invalid name (null or empty string) is specified, a working default `Meter` implementation is returned as a fallback
rather than returning null or throwing an exception.
A `MeterFactory` could also return a no-op `Meter` here if application owners configure the SDK to suppress telemetry produced by this library.
A `MeterProvider` could also return a no-op `Meter` here if application owners configure the SDK to suppress telemetry produced by this library.
This name will be used as the `namespace` for any metrics created using the returned `Meter`.
- `version` (optional): Specifies the version of the instrumentation library (e.g. `semver:1.0.0`).

### Metric names
Expand All @@ -35,9 +36,9 @@ external systems. Metric names conform to the following syntax:
3. The first character must be non-numeric, non-space, non-punctuation
4. Subsequent characters must be belong to the alphanumeric characters, '_', '.', and '-'.

Metric names belong to a namespace. The `name` of the associated `Meter`
serves as its namespace, allowing the same metric name to be used in
multiple libraries of code, unambiguously, within the same application.
Metric names belong to a namespace, which is the `name` of the associated `Meter`,
allowing the same metric name to be used in multiple libraries of code,
unambiguously, within the same application.

Metric instruments are defined using a `Meter` instance, using a variety
of `New` methods specific to the kind of metric and type of input(integer
Expand Down Expand Up @@ -89,14 +90,14 @@ metric instruments statically and providing the `Meter` interface at
the time of use. In this example, typical of statsd clients, existing
code may not be structured with a convenient place to store new metric
instruments. Where this becomes a burden, it is recommended to use
the global meter factory to construct a static `Meter`, to
the global meter provider to construct a static `Meter`, to
construct metric instruments.

The situation is similar for users of Prometheus clients, where
instruments are allocated statically and there is an implicit global.
Such code may not have access to the appropriate `Meter` where
instruments are defined. Where this becomes a burden, it is
recommended to use the global meter factory to construct a static
recommended to use the global meter provider to construct a static
named `Meter`, to construct metric instruments.

Applications are expected to construct long-lived instruments.
Expand Down
20 changes: 10 additions & 10 deletions specification/api-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@ process boundaries.

### Obtaining a Tracer

New `Tracer` instances can be created via a `TracerFactory` and its `getTracer`
New `Tracer` instances can be created via a `TracerProvider` and its `getTracer`
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`.
`TracerProvider`s are generally expected to be used as singletons. Implementations
SHOULD provide a single global default `TracerProvider`.

Some applications may use multiple `TracerFactory` instances, e.g. to provide
Some applications may use multiple `TracerProvider` instances, e.g. to provide
different settings (e.g. `SpanProcessor`s) to each of those instances and -
in further consequence - to the `Tracer` instances created by them.

Expand All @@ -97,22 +97,22 @@ in further consequence - to the `Tracer` instances created by them.
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).
A TracerFactory could also return a no-op Tracer here if application owners configure
A TracerProvider could also return a no-op Tracer here if application owners configure
the SDK to suppress telemetry produced by this library.
- `version` (optional): Specifies the version of the instrumentation library
(e.g. `semver:1.0.0`).

Implementations might require the user to specify configuration properties at
`TracerFactory` creation time, or rely on external configuration, e.g. when using the
`TracerProvider` creation time, or rely on external configuration, e.g. when using the
provider pattern.

#### Runtimes with multiple deployments/applications

Runtimes that support multiple deployments or applications might need to
provide a different `TracerFactory` instance to each deployment. To support this,
the global `TracerFactory` registry may delegate calls to create new instances of
`TracerFactory` to a separate `Provider` component, and the runtime may include
its own `Provider` implementation which returns a different `TracerFactory` for
provide a different `TracerProvider` instance to each deployment. To support this,
the global `TracerProvider` registry may delegate calls to create new instances of
`TracerProvider` to a separate `Provider` component, and the runtime may include
its own `Provider` implementation which returns a different `TracerProvider` for
each deployment.

`Provider` instances are registered with the API via some language-specific
Expand Down

0 comments on commit beba442

Please sign in to comment.